RelaxNG Schema xcomponent.rng

Part of the XPipe system http://xpipe.sourceforge.net

Generated: Fri Feb 01 18:05:27 2002. By RNG2HTML.py

For information on the RelaxNG schema language see http://www.relaxng.org

Element Index

authorInfo
 Author Information. Must be well formed. Basic XHTML recommended.
doc
 Documentation for the XComponent. Must be well formed. XHTML recommended.
input
 Typically an XML instance. Href attribute can be used to refer to an external URI or, if prefixed with a "#" a named resource from the Resources section of the XComponent.
keyword
 A keyword.
keywords
 Keywords are used for cataloging and retrieval of XComponents. A controlled vocabular is under consideration.
parameter
 A named parameter. In an XPipe the named parameters can have values associated with them. At execution time, the parameter values are made available to the executing XComponent on its command line.
parameters
 An XComponent can take command line parameters. The parameters have names which are used for documentation purposes only. Only the values will be passed into the executing XComponent by the XPipe executive. Parameters are passed into the XComponent in the order specified in the XComponent.
resources
 Resources are "files" used by this XComponent. They can be input/output files for unit tests, schemas etc.
test
 A unit test. Used to exercise the XComponent and ensure it is doing what it is supposed to do. The XComponentUnitTester application can be used to execute the test.
title
 XComponent Title. A reasonably descriptive string for what the xcomponent does.
unitTests
 Unit Tests. Used to exercise the XComponent and ensure it is doing what it is supposed to do. The XComponentUnitTester application can be used to execute the tests.
version
 XComponent version information.
xcomponent
 XComponent RelaxNG Schema. Part of the XPipe system http://xpipe.sourceforge.net. The RelaxNG Schema itself can be found at http://xpipe.sourceforge.net/XComponent.rng. It makes use of some common RelaxNG patterns housed in http://xpipe.sourceforge.net/Common.rng.

Attribute Index

code [CLASSPATH]
 Additions to the CLASSPATH made by the XPipe executive prior to executing the XComponent.
code [encoding]
 Code encoding (PLAIN or BASE64).
code [extractFilename]
 Filename to extract the Code element into. Used with Encodinging=BASE64 and Type = JavaClass
code [type]
 Code Type. JavaClass indicated Java .class file (base64 encoded). "Exec" signifies that Code element contains a command suitable for command line execution to invoke the component.
encoding
extractFilename
id
input [encoding]
 Encoding - default is "PLAIN"
input [href]
 Refer to an external URI or, if prefixed with a "#" a named resource from the Resources section of the XComponent.
output [encoding]
 Code encoding (PLAIN or BASE64).
output [href]
 Href attribute can be used to refer to an external URI or, if prefixed with a "#" a named resource from the Resources section of the XComponent.
post [CLASSPATH]
 Additions to the CLASSPATH made by the XPipe executive prior to executing the code.
post [encoding]
 Code encoding (PLAIN or BASE64).
post [extractFilename]
 Filename to extract the Pre element into. Used primarily with Encodinging=BASE64 and Type = JavaClass
post [href]
 href attribute can be used to refer to an external URI or, if prefixed with a "#" a named resource from the Resources section of the XComponent.
post [type]
 Post condition type.
pre [CLASSPATH]
 Additions to the CLASSPATH made by the XPipe executive prior to executing the XComponent.
pre [encoding]
 Pre condition Encoding (PLAIN or BASE64).
pre [extractFilename]
 Filename to extract the Pre element into. Used primarily with Encodinging=BASE64 and Type = JavaClass
pre [href]
 Href attribute can be used to refer to an external URI or, if prefixed with a "#" a named resource from the Resources section of the XComponent.
pre [type]
 Pre condition type.
resource [encoding]
 Encoding - default is "PLAIN"
resource [extractFilename]
 Filename to extract the Resource into. If not supplied, resource not extracted when XComponent installed.
resource [id]
 Resource identifier - must be unique in the XComponent.
test [name]
 An optional Name for the Test. Used in XComponentUnitTest application for example, to display test progress to the user.

Element Models

authorInfo
 <element name="authorInfo"> <sd:comment> Author Information. Must be well formed. Basic XHTML recommended. </sd:comment> <ref name="ANY"/> </element>
doc
 <element name="doc"> <sd:comment> Documentation for the XComponent. Must be well formed. XHTML recommended. </sd:comment> <ref name="ANY"/> </element>
input
 <element name="input"> <sd:comment> Typically an XML instance. Href attribute can be used to refer to an external URI or, if prefixed with a "#" a named resource from the Resources section of the XComponent. </sd:comment> <optional> <attribute name="href"> <sd:comment> Refer to an external URI or, if prefixed with a "#" a named resource from the Resources section of the XComponent. </sd:comment> </attribute> </optional> <optional> <attribute name="encoding"> <sd:comment> Encoding - default is "PLAIN" </sd:comment> <choice> <value>PLAIN</value> <value>BASE64</value> </choice> </attribute> </optional> <text/> </element>
keyword
 <element name="keyword"> <sd:comment> A keyword. </sd:comment> <text/> </element>
keywords
 <element name="keywords"> <sd:comment> Keywords are used for cataloging and retrieval of XComponents. A controlled vocabular is under consideration. </sd:comment> <zeroOrMore> <ref name="keyword"/> </zeroOrMore> </element>
parameter
 <element name="parameter"> <sd:comment> A named parameter. In an XPipe the named parameters can have values associated with them. At execution time, the parameter values are made available to the executing XComponent on its command line. </sd:comment> <attribute name="name"> <text/> </attribute> <text/> </element>
parameters
 <element name="parameters"> <sd:comment> An XComponent can take command line parameters. The parameters have names which are used for documentation purposes only. Only the values will be passed into the executing XComponent by the XPipe executive. Parameters are passed into the XComponent in the order specified in the XComponent. </sd:comment> <zeroOrMore> <ref name="parameter"/> </zeroOrMore> </element>
resources
 <element name="resources"> <sd:comment> Resources are "files" used by this XComponent. They can be input/output files for unit tests, schemas etc. </sd:comment> <zeroOrMore> <ref name="resource"/> </zeroOrMore> </element>
test
 <element name="test"> <sd:comment> A unit test. Used to exercise the XComponent and ensure it is doing what it is supposed to do. The XComponentUnitTester application can be used to execute the test. </sd:comment> <ref name="parameters"/> <ref name="pre"/> <ref name="input"/> <ref name="output"/> <ref name="post"/> <optional> <attribute name="name"> <sd:comment> An optional Name for the Test. Used in XComponentUnitTest application for example, to display test progress to the user. </sd:comment> <text/> </attribute> </optional> </element>
title
 <element name="title"> <sd:comment> XComponent Title. A reasonably descriptive string for what the xcomponent does. </sd:comment> <text/> </element>
unitTests
 <element name="unitTests"> <sd:comment> Unit Tests. Used to exercise the XComponent and ensure it is doing what it is supposed to do. The XComponentUnitTester application can be used to execute the tests. </sd:comment> <zeroOrMore> <ref name="test"/> </zeroOrMore> </element>
version
 <element name="version"> <sd:comment> XComponent version information. </sd:comment> <text/> </element>
xcomponent
 <element name="xcomponent"> <sd:comment> XComponent RelaxNG Schema. Part of the XPipe system http://xpipe.sourceforge.net. The RelaxNG Schema itself can be found at http://xpipe.sourceforge.net/XComponent.rng. It makes use of some common RelaxNG patterns housed in http://xpipe.sourceforge.net/Common.rng. </sd:comment> <ref name="version"/> <ref name="title"/> <ref name="keywords"/> <ref name="authorInfo"/> <ref name="doc"/> <ref name="parameters"/> <ref name="unitTests"/> <ref name="pre"/> <ref name="code"/> <ref name="post"/> <ref name="resources"/> </element>

Attribute Models

code [CLASSPATH]
 <attribute name="CLASSPATH"> <sd:comment> Additions to the CLASSPATH made by the XPipe executive prior to executing the XComponent. </sd:comment> </attribute>
code [encoding]
 <attribute name="encoding"> <sd:comment> Code encoding (PLAIN or BASE64). </sd:comment> <choice> <value>PLAIN</value> <value>BASE64</value> </choice> </attribute>
code [extractFilename]
 <attribute name="extractFilename"> <sd:comment> Filename to extract the Code element into. Used with Encodinging=BASE64 and Type = JavaClass </sd:comment> </attribute>
code [type]
 <attribute name="type"> <sd:comment> Code Type. JavaClass indicated Java .class file (base64 encoded). "Exec" signifies that Code element contains a command suitable for command line execution to invoke the component. </sd:comment> <choice> <value>JavaClass</value> <value>Jython</value> <value>XSLT</value> <value>Exec</value> </choice> </attribute>
encoding
 <attribute name="encoding"> <sd:comment> Encoding - default is "PLAIN" </sd:comment> <choice> <value>PLAIN</value> <value>BASE64</value> </choice> </attribute>
extractFilename
 <attribute name="extractFilename"> <sd:comment> Filename to extract the Resource into. If not supplied, resource not extracted when XComponent installed. </sd:comment> </attribute>
id
 <attribute name="id"> <sd:comment> Resource identifier - must be unique in the XComponent. </sd:comment> </attribute>
input [encoding]
 <attribute name="encoding"> <sd:comment> Encoding - default is "PLAIN" </sd:comment> <choice> <value>PLAIN</value> <value>BASE64</value> </choice> </attribute>
input [href]
 <attribute name="href"> <sd:comment> Refer to an external URI or, if prefixed with a "#" a named resource from the Resources section of the XComponent. </sd:comment> </attribute>
output [encoding]
 <attribute name="encoding"> <sd:comment> Code encoding (PLAIN or BASE64). </sd:comment> <choice> <value>PLAIN</value> <value>BASE64</value> </choice> </attribute>
output [href]
 <attribute name="href"> <sd:comment> Href attribute can be used to refer to an external URI or, if prefixed with a "#" a named resource from the Resources section of the XComponent. </sd:comment> </attribute>
post [CLASSPATH]
 <attribute name="CLASSPATH"> <sd:comment> Additions to the CLASSPATH made by the XPipe executive prior to executing the code. </sd:comment> </attribute>
post [encoding]
 <attribute name="encoding"> <sd:comment> Code encoding (PLAIN or BASE64). </sd:comment> <choice> <value>PLAIN</value> <value>BASE64</value> </choice> </attribute>
post [extractFilename]
 <attribute name="extractFilename"> <sd:comment> Filename to extract the Pre element into. Used primarily with Encodinging=BASE64 and Type = JavaClass </sd:comment> </attribute>
post [href]
 <attribute name="href"> <sd:comment> href attribute can be used to refer to an external URI or, if prefixed with a "#" a named resource from the Resources section of the XComponent. </sd:comment> </attribute>
post [type]
 <attribute name="type"> <sd:comment> Post condition type. </sd:comment> <choice> <value>JavaClass</value> <value>Jython</value> <value>DTD</value> <value>RNG</value> <value>XSD</value> </choice> </attribute>
pre [CLASSPATH]
 <attribute name="CLASSPATH"> <sd:comment> Additions to the CLASSPATH made by the XPipe executive prior to executing the XComponent. </sd:comment> </attribute>
pre [encoding]
 <attribute name="encoding"> <sd:comment> Pre condition Encoding (PLAIN or BASE64). </sd:comment> <choice> <value>PLAIN</value> <value>BASE64</value> </choice> </attribute>
pre [extractFilename]
 <attribute name="extractFilename"> <sd:comment> Filename to extract the Pre element into. Used primarily with Encodinging=BASE64 and Type = JavaClass </sd:comment> </attribute>
pre [href]
 <attribute name="href"> <sd:comment> Href attribute can be used to refer to an external URI or, if prefixed with a "#" a named resource from the Resources section of the XComponent. </sd:comment> </attribute>
pre [type]
 <attribute name="type"> <sd:comment> Pre condition type. </sd:comment> <choice> <value>JavaClass</value> <value>Jython</value> <value>XSD</value> <value>RNG</value> <value>DTD</value> </choice> </attribute>
resource [encoding]
 <attribute name="encoding"> <sd:comment> Encoding - default is "PLAIN" </sd:comment> <choice> <value>PLAIN</value> <value>BASE64</value> </choice> </attribute>
resource [extractFilename]
 <attribute name="extractFilename"> <sd:comment> Filename to extract the Resource into. If not supplied, resource not extracted when XComponent installed. </sd:comment> </attribute>
resource [id]
 <attribute name="id"> <sd:comment> Resource identifier - must be unique in the XComponent. </sd:comment> </attribute>
test [name]
 <attribute name="name"> <sd:comment> An optional Name for the Test. Used in XComponentUnitTest application for example, to display test progress to the user. </sd:comment> <text/> </attribute>

Full Schema

<grammar xmlns="http://relaxng.org/ns/structure/1.0" xmlns:sd="http://xpipe.sourceforge.net/ns/SchemaDocumentation/1.0"> <sd:version>$Id$</sd:version> <start> <element name="xcomponent"> <sd:comment> XComponent RelaxNG Schema. Part of the XPipe system http://xpipe.sourceforge.net. The RelaxNG Schema itself can be found at http://xpipe.sourceforge.net/XComponent.rng. It makes use of some common RelaxNG patterns housed in http://xpipe.sourceforge.net/Common.rng. </sd:comment> <ref name="version"/> <ref name="title"/> <ref name="keywords"/> <ref name="authorInfo"/> <ref name="doc"/> <ref name="parameters"/> <ref name="unitTests"/> <ref name="pre"/> <ref name="code"/> <ref name="post"/> <ref name="resources"/> </element> </start> <include href="common.rng"/> <define name="version"> <element name="version"> <sd:comment> XComponent version information. </sd:comment> <text/> </element> </define> <define name="title"> <element name="title"> <sd:comment> XComponent Title. A reasonably descriptive string for what the xcomponent does. </sd:comment> <text/> </element> </define> <define name="keywords"> <element name="keywords"> <sd:comment> Keywords are used for cataloging and retrieval of XComponents. A controlled vocabular is under consideration. </sd:comment> <zeroOrMore> <ref name="keyword"/> </zeroOrMore> </element> </define> <define name="keyword"> <element name="keyword"> <sd:comment> A keyword. </sd:comment> <text/> </element> </define> <define name="authorInfo"> <element name="authorInfo"> <sd:comment> Author Information. Must be well formed. Basic XHTML recommended. </sd:comment> <ref name="ANY"/> </element> </define> <define name="doc"> <element name="doc"> <sd:comment> Documentation for the XComponent. Must be well formed. XHTML recommended. </sd:comment> <ref name="ANY"/> </element> </define> <define name="parameters"> <element name="parameters"> <sd:comment> An XComponent can take command line parameters. The parameters have names which are used for documentation purposes only. Only the values will be passed into the executing XComponent by the XPipe executive. Parameters are passed into the XComponent in the order specified in the XComponent. </sd:comment> <zeroOrMore> <ref name="parameter"/> </zeroOrMore> </element> </define> <define name="parameter"> <element name="parameter"> <sd:comment> A named parameter. In an XPipe the named parameters can have values associated with them. At execution time, the parameter values are made available to the executing XComponent on its command line. </sd:comment> <attribute name="name"> <text/> </attribute> <text/> </element> </define> <define name="unitTests"> <element name="unitTests"> <sd:comment> Unit Tests. Used to exercise the XComponent and ensure it is doing what it is supposed to do. The XComponentUnitTester application can be used to execute the tests. </sd:comment> <zeroOrMore> <ref name="test"/> </zeroOrMore> </element> </define> <define name="test"> <element name="test"> <sd:comment> A unit test. Used to exercise the XComponent and ensure it is doing what it is supposed to do. The XComponentUnitTester application can be used to execute the test. </sd:comment> <ref name="parameters"/> <ref name="pre"/> <ref name="input"/> <ref name="output"/> <ref name="post"/> <optional> <attribute name="name"> <sd:comment> An optional Name for the Test. Used in XComponentUnitTest application for example, to display test progress to the user. </sd:comment> <text/> </attribute> </optional> </element> </define> <define name="pre"> <element name="pre"> <optional> <attribute name="href"> <sd:comment> Href attribute can be used to refer to an external URI or, if prefixed with a "#" a named resource from the Resources section of the XComponent. </sd:comment> </attribute> </optional> <optional> <attribute name="type"> <sd:comment> Pre condition type. </sd:comment> <choice> <value>JavaClass</value> <value>Jython</value> <value>XSD</value> <value>RNG</value> <value>DTD</value> </choice> </attribute> </optional> <optional> <attribute name="encoding"> <sd:comment> Pre condition Encoding (PLAIN or BASE64). </sd:comment> <choice> <value>PLAIN</value> <value>BASE64</value> </choice> </attribute> </optional> <optional> <attribute name="extractFilename"> <sd:comment> Filename to extract the Pre element into. Used primarily with Encodinging=BASE64 and Type = JavaClass </sd:comment> </attribute> </optional> <optional> <attribute name="CLASSPATH"> <sd:comment> Additions to the CLASSPATH made by the XPipe executive prior to executing the XComponent. </sd:comment> </attribute> </optional> <text/> </element> </define> <define name="code"> <element name="code"> <attribute name="type"> <sd:comment> Code Type. JavaClass indicated Java .class file (base64 encoded). "Exec" signifies that Code element contains a command suitable for command line execution to invoke the component. </sd:comment> <choice> <value>JavaClass</value> <value>Jython</value> <value>XSLT</value> <value>Exec</value> </choice> </attribute> <optional> <attribute name="encoding"> <sd:comment> Code encoding (PLAIN or BASE64). </sd:comment> <choice> <value>PLAIN</value> <value>BASE64</value> </choice> </attribute> </optional> <optional> <attribute name="extractFilename"> <sd:comment> Filename to extract the Code element into. Used with Encodinging=BASE64 and Type = JavaClass </sd:comment> </attribute> </optional> <optional> <attribute name="CLASSPATH"> <sd:comment> Additions to the CLASSPATH made by the XPipe executive prior to executing the XComponent. </sd:comment> </attribute> </optional> <text/> </element> </define> <define name="post"> <element name="post"> <optional> <attribute name="href"> <sd:comment> href attribute can be used to refer to an external URI or, if prefixed with a "#" a named resource from the Resources section of the XComponent. </sd:comment> </attribute> </optional> <optional> <attribute name="type"> <sd:comment> Post condition type. </sd:comment> <choice> <value>JavaClass</value> <value>Jython</value> <value>DTD</value> <value>RNG</value> <value>XSD</value> </choice> </attribute> </optional> <optional> <attribute name="encoding"> <sd:comment> Code encoding (PLAIN or BASE64). </sd:comment> <choice> <value>PLAIN</value> <value>BASE64</value> </choice> </attribute> </optional> <optional> <attribute name="extractFilename"> <sd:comment> Filename to extract the Pre element into. Used primarily with Encodinging=BASE64 and Type = JavaClass </sd:comment> </attribute> </optional> <optional> <attribute name="CLASSPATH"> <sd:comment> Additions to the CLASSPATH made by the XPipe executive prior to executing the code. </sd:comment> </attribute> </optional> <text/> </element> </define> <define name="input"> <element name="input"> <sd:comment> Typically an XML instance. Href attribute can be used to refer to an external URI or, if prefixed with a "#" a named resource from the Resources section of the XComponent. </sd:comment> <optional> <attribute name="href"> <sd:comment> Refer to an external URI or, if prefixed with a "#" a named resource from the Resources section of the XComponent. </sd:comment> </attribute> </optional> <optional> <attribute name="encoding"> <sd:comment> Encoding - default is "PLAIN" </sd:comment> <choice> <value>PLAIN</value> <value>BASE64</value> </choice> </attribute> </optional> <text/> </element> </define> <define name="output"> <element name="output"> <optional> <attribute name="href"> <sd:comment> Href attribute can be used to refer to an external URI or, if prefixed with a "#" a named resource from the Resources section of the XComponent. </sd:comment> </attribute> </optional> <optional> <attribute name="encoding"> <sd:comment> Code encoding (PLAIN or BASE64). </sd:comment> <choice> <value>PLAIN</value> <value>BASE64</value> </choice> </attribute> </optional> <text/> </element> </define> <define name="resources"> <element name="resources"> <sd:comment> Resources are "files" used by this XComponent. They can be input/output files for unit tests, schemas etc. </sd:comment> <zeroOrMore> <ref name="resource"/> </zeroOrMore> </element> </define> <define name="resource"> <element name="resource"> <attribute name="id"> <sd:comment> Resource identifier - must be unique in the XComponent. </sd:comment> </attribute> <optional> <attribute name="encoding"> <sd:comment> Encoding - default is "PLAIN" </sd:comment> <choice> <value>PLAIN</value> <value>BASE64</value> </choice> </attribute> </optional> <optional> <attribute name="extractFilename"> <sd:comment> Filename to extract the Resource into. If not supplied, resource not extracted when XComponent installed. </sd:comment> </attribute> </optional> <text/> </element> </define> </grammar>