RelaxNG Schema xpipe.rng

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

Generated: Fri Feb 01 18:05:21 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 xpipe. 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 xpipe.
keyword
 A keyword.
keywords
 keywords are used for cataloging and retrieval of XPipes. A controlled vocabulary is being researched.
parameter
 A named parameter. 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 corresponding to the names declared in the XComponent definition. The values will be passed into the executing XComponent by the XPipe executive. Parameters are passed into the XComponent in the order specified here.
post
 Postcondtion - code that must evaluate to true for the XPipe test to be valid.
pre
 Precondtion - code that must evaluate to true for the XPipe test to be valid.
resources
 Resources are "files" used by this XPipe. They can be input/output files for unit tests, schemas etc.
test
 A unit test. Used to exercise the XPipe and ensure it is doing what it is supposed to do. The XPipeUnitTester application can be used to execute the test.
title
 xpipe title. A reasonably descriptive string for what the xpipe does.
unitTests
 Unit Tests. Used to exercise the XPipe and ensure it is doing what it is supposed to do. The XPipeUnitTester application can be used to execute the tests.
version
 xpipe version information.
xcomponentRef
 xcomponent reference
xcomponents
 xcomponents
xpipe
 xpipe RelaxNG Schema. Part of the XPipe system http://xpipe.sourceforge.net. The RelaxNG Schema itself can be found at http://xpipe.sourceforge.net/Schemas/xpipe.rng. It makes use of some common RelaxNG patterns housed in http://xpipe.sourceforge.net/Schemas/common.rng.

Attribute Index

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 xpipe.
post [CLASSPATH]
 Additions to the CLASSPATH made by the XPipe executive prior to executing the code.
post [encoding]
 Pre condition encoding (PLAIN or BASE64).
post [extractFilename]
 Filename to extract the post condition code into. Used primarily with encoding=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 XPipe.
post [type]
 Pre condition type.
pre [CLASSPATH]
 Additions to the CLASSPATH made by the XPipe executive prior to executing the code.
pre [encoding]
 Pre condition encoding (PLAIN or BASE64).
pre [extractFilename]
 Filename to extract the Pre condition code into. Used primarily with encoding=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 XPipe.
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 XPipe installed.
resource [id]
 resource identifier - must be unique in the XPipe.
test [name]
 An optional Name for the Test. Used in xpipeUnitTest application for example, to display test progress to the user.
xcomponentRef [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 XPipe.

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 xpipe. 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 xpipe. </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 XPipes. A controlled vocabulary is being researched. </sd:comment> <zeroOrMore> <ref name="keyword"/> </zeroOrMore> </element>
parameter
 <element name="parameter"> <sd:comment> A named parameter. 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 corresponding to the names declared in the XComponent definition. The values will be passed into the executing XComponent by the XPipe executive. Parameters are passed into the XComponent in the order specified here. </sd:comment> <zeroOrMore> <ref name="parameter"/> </zeroOrMore> </element>
post
 <element name="post"> <sd:comment> Postcondtion - code that must evaluate to true for the XPipe test to be valid. </sd:comment> <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="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 XPipe. </sd:comment> </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 post condition code into. Used primarily with encoding=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>
pre
 <element name="pre"> <sd:comment> Precondtion - code that must evaluate to true for the XPipe test to be valid. </sd:comment> <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="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 XPipe. </sd:comment> </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 condition code into. Used primarily with encoding=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>
resources
 <element name="resources"> <sd:comment> Resources are "files" used by this XPipe. 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 XPipe and ensure it is doing what it is supposed to do. The XPipeUnitTester application can be used to execute the test. </sd:comment> <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 xpipeUnitTest application for example, to display test progress to the user. </sd:comment> <text/> </attribute> </optional> </element>
title
 <element name="title"> <sd:comment> xpipe title. A reasonably descriptive string for what the xpipe does. </sd:comment> <text/> </element>
unitTests
 <element name="unitTests"> <sd:comment> Unit Tests. Used to exercise the XPipe and ensure it is doing what it is supposed to do. The XPipeUnitTester application can be used to execute the tests. </sd:comment> <zeroOrMore> <ref name="test"/> </zeroOrMore> </element>
version
 <element name="version"> <sd:comment> xpipe version information. </sd:comment> <text/> </element>
xcomponentRef
 <element name="xcomponentRef"> <sd:comment>xcomponent reference</sd:comment> <ref name="doc"/> <ref name="parameters"/> <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 XPipe. </sd:comment> </attribute> </element>
xcomponents
 <element name="xcomponents"> <sd:comment>xcomponents</sd:comment> <zeroOrMore> <ref name="xcomponentRef"/> </zeroOrMore> </element>
xpipe
 <element name="xpipe"> <sd:comment> xpipe RelaxNG Schema. Part of the XPipe system http://xpipe.sourceforge.net. The RelaxNG Schema itself can be found at http://xpipe.sourceforge.net/Schemas/xpipe.rng. It makes use of some common RelaxNG patterns housed in http://xpipe.sourceforge.net/Schemas/common.rng. </sd:comment> <ref name="version"/> <ref name="title"/> <ref name="keywords"/> <ref name="authorInfo"/> <ref name="doc"/> <ref name="unitTests"/> <ref name="pre"/> <ref name="xcomponents"/> <ref name="post"/> <ref name="resources"/> </element>

Attribute Models

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 XPipe installed. </sd:comment> </attribute>
id
 <attribute name="id"> <sd:comment> resource identifier - must be unique in the XPipe. </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 xpipe. </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> Pre condition 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 post condition code into. Used primarily with encoding=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 XPipe. </sd:comment> </attribute>
post [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>
pre [CLASSPATH]
 <attribute name="CLASSPATH"> <sd:comment> Additions to the CLASSPATH made by the XPipe executive prior to executing the code. </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 condition code into. Used primarily with encoding=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 XPipe. </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 XPipe installed. </sd:comment> </attribute>
resource [id]
 <attribute name="id"> <sd:comment> resource identifier - must be unique in the XPipe. </sd:comment> </attribute>
test [name]
 <attribute name="name"> <sd:comment> An optional Name for the Test. Used in xpipeUnitTest application for example, to display test progress to the user. </sd:comment> <text/> </attribute>
xcomponentRef [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 XPipe. </sd:comment> </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="xpipe"> <sd:comment> xpipe RelaxNG Schema. Part of the XPipe system http://xpipe.sourceforge.net. The RelaxNG Schema itself can be found at http://xpipe.sourceforge.net/Schemas/xpipe.rng. It makes use of some common RelaxNG patterns housed in http://xpipe.sourceforge.net/Schemas/common.rng. </sd:comment> <ref name="version"/> <ref name="title"/> <ref name="keywords"/> <ref name="authorInfo"/> <ref name="doc"/> <ref name="unitTests"/> <ref name="pre"/> <ref name="xcomponents"/> <ref name="post"/> <ref name="resources"/> </element> </start> <include href="Common.rng"/> <define name="version"> <element name="version"> <sd:comment> xpipe version information. </sd:comment> <text/> </element> </define> <define name="title"> <element name="title"> <sd:comment> xpipe title. A reasonably descriptive string for what the xpipe does. </sd:comment> <text/> </element> </define> <define name="keywords"> <element name="keywords"> <sd:comment> keywords are used for cataloging and retrieval of XPipes. A controlled vocabulary is being researched. </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 xpipe. Must be well formed. XHTML recommended. </sd:comment> <ref name="ANY"/> </element> </define> <define name="unitTests"> <element name="unitTests"> <sd:comment> Unit Tests. Used to exercise the XPipe and ensure it is doing what it is supposed to do. The XPipeUnitTester 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 XPipe and ensure it is doing what it is supposed to do. The XPipeUnitTester application can be used to execute the test. </sd:comment> <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 xpipeUnitTest application for example, to display test progress to the user. </sd:comment> <text/> </attribute> </optional> </element> </define> <define name="pre"> <element name="pre"> <sd:comment> Precondtion - code that must evaluate to true for the XPipe test to be valid. </sd:comment> <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="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 XPipe. </sd:comment> </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 condition code into. Used primarily with encoding=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="post"> <element name="post"> <sd:comment> Postcondtion - code that must evaluate to true for the XPipe test to be valid. </sd:comment> <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="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 XPipe. </sd:comment> </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 post condition code into. Used primarily with encoding=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="parameters"> <element name="parameters"> <sd:comment> An xcomponent can take command line parameters. The parameters have names corresponding to the names declared in the XComponent definition. The values will be passed into the executing XComponent by the XPipe executive. Parameters are passed into the XComponent in the order specified here. </sd:comment> <zeroOrMore> <ref name="parameter"/> </zeroOrMore> </element> </define> <define name="parameter"> <element name="parameter"> <sd:comment> A named parameter. 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="xcomponents"> <element name="xcomponents"> <sd:comment>xcomponents</sd:comment> <zeroOrMore> <ref name="xcomponentRef"/> </zeroOrMore> </element> </define> <define name="xcomponentRef"> <element name="xcomponentRef"> <sd:comment>xcomponent reference</sd:comment> <ref name="doc"/> <ref name="parameters"/> <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 XPipe. </sd:comment> </attribute> </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 xpipe. </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 xpipe. </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 XPipe. 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 XPipe. </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 XPipe installed. </sd:comment> </attribute> </optional> <text/> </element> </define> </grammar>