/xservices/trunk/doc/types/SelectorType.xml |
---|
0,0 → 1,20 |
<?xml version="1.0" encoding="UTF-8"?> |
<section id="selectortype"> |
<title>SelectorType type</title> |
<para>The SelectorType exposes various selectors for the selection of resources (files).</para> |
<para>The defining Java class is |
<ulink url="javadoc/net/brutex/xservices/types/SelectorType.html"> |
<classname>net.brutex.xservices.types.SelectorType</classname></ulink>.</para> |
&schemadefinition; |
<programlisting language="xml"><![CDATA[ |
<xs:complexType abstract="true" name="selectorType"> |
<xs:sequence> |
<xs:element maxOccurs="unbounded" minOccurs="0" name="contains" nillable="true" type="tns:containsSelectorType"/> |
</xs:sequence> |
</xs:complexType>]]> |
</programlisting> |
&examplexml; |
<programlisting language="xml"><![CDATA[ |
tbd.]]> |
</programlisting> |
</section> |
/xservices/trunk/doc/types/AntProperty.xml |
---|
4,8 → 4,7 |
<para>The defining Java class is |
<ulink url="javadoc/net/brutex/xservices/types/AntProperty.html"> |
<classname>net.brutex.xservices.types.AntProperty</classname></ulink>.</para> |
<section> |
<title>Schema description</title> |
&schemadefinition; |
<programlisting language="xml"><![CDATA[ |
<xs:complexType name="antProperty"> |
<xs:sequence> |
14,9 → 13,7 |
</xs:sequence> |
</xs:complexType>]]> |
</programlisting> |
</section> |
<section> |
<title>Example XML </title> |
&examplexml; |
<programlisting language="xml"><![CDATA[ |
<AntProperty> |
<name>key2</name> |
23,5 → 20,5 |
<value>value2</value> |
</AntProperty>]]> |
</programlisting> |
</section> |
</section> |
/xservices/trunk/doc/types/PatternElement.xml |
---|
1,21 → 1,31 |
<?xml version='1.0' encoding='UTF-8'?><section id="patternelement"> |
<title>PatternElement type</title> |
<para>The PatternElement type defines single string pattern.</para> |
<para>The defining Java class is |
<ulink url="javadoc/net/brutex/xservices/types/PatternElement.html"> |
<classname>net.brutex.xservices.types.PatternElement</classname></ulink>.</para> |
<section> |
<title>Schema description</title> |
<programlisting language="xml"><![CDATA[ |
<xs:simpleType name="patternElement"> |
<title>PatternElement type</title> |
<para>The PatternElement type defines single string pattern for file/ directory matching.</para> |
<para>The defining Java class is |
<ulink url="javadoc/net/brutex/xservices/types/PatternElement.html"> |
<classname>net.brutex.xservices.types.PatternElement</classname> |
</ulink>. |
</para> |
<para>These patterns look exactly like those used in Apache Ant |
<ulink url="http://ant.apache.org/manual/dirtasks.html#patterns">Patterns</ulink>. |
The '*' matches zero or more characters and the '?' will match a single character. |
Both symbols can be combined in one pattern. The '**' |
symbol can be used to match any directory deepth. |
</para> |
<para>Some example patterns:</para> |
<para><parameter>**/mydir/**</parameter></para> |
<para>Match all file that are located in any directory that has "mydir" string in its pathname. Also applies to files with "mydir" in their name.</para> |
<para><parameter>/mydir/</parameter></para> |
<para>The parser will automatically append an '**' symbol, thus the resulting pattern is <parameter>/mydir/**</parameter>. All files below the "/mydir/" directory (including its sub-directories will be chosen.</para> |
<note> |
<para>The pattern is OS independent. You should always use "/" as path separator, even on windows based systems.</para> |
</note> |
&schemadefinition; |
<programlisting language="xml"><![CDATA[<xs:simpleType name="patternElement"> |
<xs:restriction base="xs:string"/> |
</xs:simpleType>]]> |
</programlisting> |
</section> |
<section> |
<title>Example XML</title> |
<programlisting language="xml"><![CDATA[ |
<PatternElement>**/*</PatternElement>]]> |
</programlisting> |
</section> |
</xs:simpleType>]]></programlisting> |
&examplexml; |
<programlisting language="xml"><![CDATA[<PatternElement>**/*</PatternElement>]]></programlisting> |
</section> |
/xservices/trunk/doc/types/ReturnCode.xml |
---|
2,23 → 2,21 |
<title>ReturnCode type</title> |
<para>The ReturnCode type is used as the generic answer type for most of the &brs; operations.</para> |
<para>The defining Java class is |
<ulink url="javadoc/net/brutex/xservices/types/ReturnCode.html"> |
<ulink url="&javadoc-base;javadoc/net/brutex/xservices/types/ReturnCode.html"> |
<classname>net.brutex.xservices.types.ReturnCode</classname></ulink>.</para> |
<section> |
<title>Schema description</title> |
&schemadefinition; |
<programlisting language="xml"><![CDATA[ |
<xs:complexType name="ReturnCodeType"> |
<xs:sequence> |
<xs:element name="returnCode" type="xs:int"/> |
<xs:element minOccurs="0" name="stdOut" type="xs:string"/> |
<xs:element minOccurs="0" name="stdErr" type="xs:string"/> |
<xs:element maxOccurs="unbounded" minOccurs="0" name="propertyList" nillable="true" type="]]><link linkend="antproperty">tns:antProperty</link><![CDATA["/> |
<xs:element name="returnCode" type="xs:int"/> |
<xs:element minOccurs="0" name="stdOut" type="xs:string"/> |
<xs:element minOccurs="0" name="stdErr" type="xs:string"/> |
<xs:element maxOccurs="unbounded" minOccurs="0" name="propertyList" nillable="true" type="]]><link linkend="antproperty">tns:antProperty</link><![CDATA["/> |
</xs:sequence> |
</xs:complexType>]]> |
</xs:complexType>]]> |
</programlisting> |
</section> |
<section> |
<title>Example XML </title> |
&examplexml; |
<programlisting language="xml"><ReturnCode xmlns:ns2="http://ws.xservices.brutex.net"> |
<returnCode>0</returnCode> |
<stdOut/> |
32,5 → 30,5 |
<value>value2</value> |
</propertyList> |
</ReturnCode></programlisting> |
</section> |
</section> |
/xservices/trunk/doc/types/PatternSetType.xml |
---|
0,0 → 1,23 |
<?xml version="1.0" encoding="UTF-8"?> |
<section id="patternsettype"> |
<title>PatternSetType type</title> |
<para>The PatternSetType exposes various filters/ selectors for the selection of resources (files).</para> |
<para>The defining Java class is |
<ulink url="javadoc/net/brutex/xservices/types/PatternSetType.html"> |
<classname>net.brutex.xservices.types.PatternSetType</classname></ulink>.</para> |
&schemadefinition; |
<programlisting language="xml"><![CDATA[ |
<xs:complexType name="patternSetType"> |
<xs:sequence> |
<xs:element default="**/*" maxOccurs="unbounded" minOccurs="0" name="include" type="]]><link linkend="patternelement">tns:patternElement</link><![CDATA["/> |
<xs:element maxOccurs="unbounded" minOccurs="0" name="exclude" type="]]><link linkend="patternelement">tns:patternElement</link><![CDATA["/> |
<xs:element minOccurs="0" name="selector" nillable="true" type="]]><link linkend="selectortype">tns:selectorType</link><![CDATA["/> |
</xs:sequence> |
</xs:complexType>]]> |
</programlisting> |
&examplexml; |
<programlisting language="xml"><![CDATA[ |
tbd.]]> |
</programlisting> |
</section> |