Author: indika Date: Fri Jun 26 03:16:53 2009 New Revision: 40066 URL: http://wso2.org/svn/browse/wso2?view=rev&revision=40066
Log: xquery mediator doc update Modified: trunk/esb/java/docs/xdoc/mediators/xquery.xml Modified: trunk/esb/java/docs/xdoc/mediators/xquery.xml URL: http://wso2.org/svn/browse/wso2/trunk/esb/java/docs/xdoc/mediators/xquery.xml?rev=40066&r1=40065&r2=40066&view=diff ============================================================================== --- trunk/esb/java/docs/xdoc/mediators/xquery.xml (original) +++ trunk/esb/java/docs/xdoc/mediators/xquery.xml Fri Jun 26 03:16:53 2009 @@ -13,29 +13,26 @@ <body> <h2>XQuery Mediator</h2> -<p></p> - <p>The XQuery mediator can be used to perform an XQuery transformation. The -'key' attribute specifies the XQuery transformation, and the optional 'target' -attribute specifies the node of the message that should be transformed. This -defaults to the first child of the SOAP body of the payload. The 'variable' -elements define a variable that could be bound to the dynamic context of the -XQuery engine in order to access those variables through the XQuery script . -</p> - -<p>It is possible to specify just a literal 'value', or an XPath expression -over the payload, or even specify a registry key or a registry key combined -with an XPath expression that selects the variable. The name of the variable -corresponds to the name of variable declaration in the XQuery script. The -'type' of the variable must be a valid type defined by the JSR-000225 (XQJ -API). </p> - -<h3>Syntax</h3> -<pre xml:space="preserve"><xquery key="string" [target="xpath"]> - <variable name="string" type="string" [key="string"] [expression="xpath"] [value="string"]/>? -</xquery> </pre> +'<strong>key</strong>' attribute specifies the registry key for looking up +XQuery script that going to be used for define transformation. The optional +'<strong>target</strong>' attribute specifies the node of the SOAP message that +should be transformed. This defaults to the first child of the SOAP body of the +payload. The '<strong>variable</strong>' elements define a variable that could +be bound to the dynamic context of the XQuery engine in order to access those +variables during the XQuery script invocation . </p> + +<p>In the variable definition , it is possible to specify just a +<strong>literal value</strong>, or an <strong>XPath expression</strong> over +the payload, or even specify a <strong>registry key</strong> or a registry key +combined with an XPath expression that selects the value of the variable.Using +<strong>key</strong> attribute of the variable, it is possible to bind an XML +document located in the registry so that in the transformation that too can be +used.The name of the variable corresponds to the name of variable declaration +in the XQuery script. The <strong>type</strong> of the variable must be a valid +type defined by the JSR-000225 (XQJ API). </p> -<p>The supported types are: </p> +<p><strong>Supported Types</strong> </p> <ul> <li>XQItemType.XQBASETYPE_INT -> INT </li> <li>XQItemType.XQBASETYPE_INTEGER -> INTEGER </li> @@ -51,8 +48,15 @@ <li>XQItemType.XQITEMKIND_ELEMENT -> ELEMENT </li> </ul> +<h2>Syntax</h2> +<pre xml:space="preserve"><xquery key="string" [target="xpath"]> + <variable name="string" type="string" [key="string"] [expression="xpath"] [value="string"]/>? +</xquery> </pre> + <h3>UI Configuration</h3> -<img src="../xquery-mediator/docs/images/xquery_mediator_screenshot.jpg" /> + +<p><img src="../xquery-mediator/docs/images/xquery_mediator_screenshot.jpg" +alt="" /> </p> <p><strong>Figure1: XQuery Mediator</strong> </p> <ul> @@ -67,29 +71,16 @@ bound to the dynamic context of the XQuery engine in order to access those variables through the XQuery script. </p> -<p><img src="../xquery-mediator/docs/images/xquery_mediator_variables.jpg" /> -</p> +<p><img src="../xquery-mediator/docs/images/xquery_mediator_variables.jpg" +alt="" /> </p> -<p><strong>Figure1: XQuery Mediator - Adding Variables</strong> </p> +<p><strong>Figure2: XQuery Mediator - Adding Variables</strong> </p> You have the following option in a variable. <ul> <li>Variable Type: The 'type' of the variable must be a valid type defined by the JSR-000225 (XQJ API). - <p>The supported types are: </p> - <ol> - <li>XQItemType.XQBASETYPE_INT->INT</li> - <li>XQItemType.XQBASETYPE_INTEGER->INTEGER</li> - <li>XQItemType.XQBASETYPE_BOOLEAN->BOOLEAN</li> - <li>XQItemType.XQBASETYPE_BYTE->BYTE</li> - <li>XQItemType.XQBASETYPE_DOUBLE->DOUBLE</li> - <li>XQItemType.XQBASETYPE_SHORT->SHORT</li> - <li>XQItemType.XQBASETYPE_LONG->LONG</li> - <li>XQItemType.XQBASETYPE_FLOAT->FLOAT</li> - <li>XQItemType.XQBASETYPE_STRING->STRING</li> - <li>XQItemType.XQITEMKIND_DOCUMENT->DOCUMENT</li> - <li>XQItemType.XQITEMKIND_DOCUMENT_ELEMENT->DOCUMENT_ELEMENT</li> - <li>XQItemType.XQITEMKIND_ELEMENT->ELEMENT</li> - </ol> + <p>The supported types are defined in the <strong>Supported Types</strong> + section </p> </li> <li>Variable Name: The name of the variable should correspond to the name of variable declaration in the XQuery script. </li> _______________________________________________ Esb-java-dev mailing list [email protected] https://wso2.org/cgi-bin/mailman/listinfo/esb-java-dev
