bixmldataset.xml

来自「ajax 框价．是个好工具．javascript 矿家．可以用在任何平台．」· XML 代码 · 共 154 行

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiXmlDataSet" extends="BiDataSet">
	<description>This class maps an xml file outputted from an ADO.NET DataSet to a<link class="BiDataSet">BiDataSet</link>.</description>
	<arguments>
		<argument name="oSource">
			<description>The source of the XML file/element. This can take
 								quite a few different formats. If the argument is
                              a String or a <link class="BiUri">BiUri</link>
                              the XML document will be loaded asynchronously
                              using an internal
                              <link class="BiXmlLoader">BiXmlLoader</link>. If
                              the argument is a
                              <link class="BiXmlDocument">BiXmlDocument</link>
                              or an XML element that will be used as the source.</description>
			<type>Object</type>
		</argument>
	</arguments>
	<staticMethods>
		<method name="encodeName">
			<description>Encodes a string to the desired format used for the XML element tag names.</description>
			<arguments>
				<argument name="s">
					<description>The string to encode.</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="decodeName">
			<description>Decodes a string from the format used by the XML element tag names.</description>
			<arguments>
				<argument name="s">
					<description>The string to decode.</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="fromXmlNode">
			<description>Creates the tables, rows and columns from an XML node. This node
 can be a<link class="BiXmlDocument">BiXmlDocument</link> or an XML element.</description>
			<arguments>
				<argument name="oNode">
					<description>The XML node to populate the data set from</description>
					<type>Node</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="getTableNamesPath">
			<description>Returns the XPath expression needed to get the names of the
 tables in the data set.</description>
			<arguments>
				<argument name="sDataSetXmlName">
					<description>The (encoded) name of the data set</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="getColumnNamesPath">
			<description>Returns the XPath expression needed to get the names of the
 columns of the data table.</description>
			<arguments>
				<argument name="sTableXmlName">
					<description>The (encoded) name of the table</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="getColumnTypesPath">
			<description>Returns the XPath expression needed to get the types of the
 columns. This should return the XML Schema type.</description>
			<arguments>
				<argument name="sTableXmlName">
					<description>The (encoded) name of the table</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="getRowsPath">
			<description>Returns the XPath expression needed to get the rows of the table</description>
			<arguments>
				<argument name="sTableXmlName">
					<description>The (encoded) name of the table to get the rows for</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="uri" get="true" set="true">
			<description>This property can be used to load an external XML document and use that as
 the source for the XML data set</description>
			<type>
				<link class="BiUri">BiUri</link>
			</type>
		</property>
		<property name="rootNode" get="true" set="true">
			<description>The root XML node used to define the data set. This is either a<link class="BiXmlDocument">BiXmlDocument</link>
 or an XML element.</description>
			<type>Node</type>
		</property>
		<property name="encodedName" get="true">
			<description>The encoded name of the data set</description>
			<type>String</type>
		</property>
		<property name="dataSetNamePath" get="true">
			<description>Returns the XPath expression needed to get the name of the data
 set.</description>
			<type>String</type>
		</property>
	</properties>
	<events>
		<event name="dataready">
			<description>This is dispatched when the data set uses external
 								data and the data has been loaded.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
	</events>
	<remarks>XML data sets are read only.<br>
		</br>
		<br>
		</br>
          The methods getDataSetNamePath, getTableNamesPath, getColumnNamesPath,
          getColumnTypesPath and getRowsPath allows you to define how to find the
          different elements and attributes used to define the data of the data set.
          Override these to suit your need.</remarks>
</class>