xmlbeans-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ce...@apache.org
Subject svn commit: r209780 [1/4] - in /xmlbeans/site/build/site: docs/2.0.0/guide/ documentation/ samples/
Date Fri, 08 Jul 2005 14:10:32 GMT
Author: cezar
Date: Fri Jul  8 07:10:29 2005
New Revision: 209780

URL: http://svn.apache.org/viewcvs?rev=209780&view=rev
Log:
Updating the web site with new samples and sample docs. Contributed by Steve Traut.

Added:
    xmlbeans/site/build/site/docs/2.0.0/guide/conHandlingAny.html
    xmlbeans/site/build/site/docs/2.0.0/guide/conValidationWithXmlBeans.html
    xmlbeans/site/build/site/samples/Any.html
    xmlbeans/site/build/site/samples/Any.pdf
    xmlbeans/site/build/site/samples/Any.tgz   (with props)
    xmlbeans/site/build/site/samples/Any.zip   (with props)
    xmlbeans/site/build/site/samples/Validation.html
    xmlbeans/site/build/site/samples/Validation.pdf
    xmlbeans/site/build/site/samples/Validation.tgz   (with props)
    xmlbeans/site/build/site/samples/Validation.zip   (with props)
    xmlbeans/site/build/site/samples/XQueryXPath.html
    xmlbeans/site/build/site/samples/XQueryXPath.pdf
    xmlbeans/site/build/site/samples/XQueryXPath.tgz   (with props)
    xmlbeans/site/build/site/samples/XQueryXPath.zip   (with props)
    xmlbeans/site/build/site/samples/XmlTree.html
    xmlbeans/site/build/site/samples/XmlTree.pdf
    xmlbeans/site/build/site/samples/XmlTree.tgz   (with props)
    xmlbeans/site/build/site/samples/XmlTree.zip   (with props)
Modified:
    xmlbeans/site/build/site/docs/2.0.0/guide/conSelectingXMLwithXQueryPathXPath.html
    xmlbeans/site/build/site/docs/2.0.0/guide/tools.html
    xmlbeans/site/build/site/documentation/index.html
    xmlbeans/site/build/site/documentation/index.pdf
    xmlbeans/site/build/site/samples/AbstractTypes.html
    xmlbeans/site/build/site/samples/DateTime.html
    xmlbeans/site/build/site/samples/MixedContent.html
    xmlbeans/site/build/site/samples/OrderMatters.html
    xmlbeans/site/build/site/samples/SampleTemplate.html
    xmlbeans/site/build/site/samples/SchemaEnum.html
    xmlbeans/site/build/site/samples/SubstitutionGroup.html
    xmlbeans/site/build/site/samples/index.html
    xmlbeans/site/build/site/samples/index.pdf
    xmlbeans/site/build/site/samples/samples.tgz
    xmlbeans/site/build/site/samples/samples.zip
    xmlbeans/site/build/site/samples/vxsdb.html

Added: xmlbeans/site/build/site/docs/2.0.0/guide/conHandlingAny.html
URL: http://svn.apache.org/viewcvs/xmlbeans/site/build/site/docs/2.0.0/guide/conHandlingAny.html?rev=209780&view=auto
==============================================================================
--- xmlbeans/site/build/site/docs/2.0.0/guide/conHandlingAny.html (added)
+++ xmlbeans/site/build/site/docs/2.0.0/guide/conHandlingAny.html Fri Jul  8 07:10:29 2005
@@ -0,0 +1 @@
+<!doctype HTML public "-//W3C//DTD HTML 4.0 Frameset//EN">

<!-- Copyright 2004 The Apache Software Foundation

     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.
     You may obtain a copy of the License at

         http://www.apache.org/licenses/LICENSE-2.0

     Unless required by applicable law or agreed to in writing, software
     distributed under the License is distributed on an "AS IS" BASIS,
     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     See the License for the specific language governing permissions and
     limitations under the License. -->
<html>
<head>
<!-- InstanceBeginEditable name="doctitle" -->
<title>Handling xs:any with the XMLBeans API </title>
<!-- InstanceEndEditable -->
<!--(Meta)==========================================================-->

<meta http-equiv=Content-Type content="text/html; charset=$CHARSET;">


<!-- InstanceBe
 ginEditable name="metatags" -->

<meta content="your name" name="author">
<meta content="A description of the topic contents." name="description">
<meta content="keywords to help in searches" name="keywords">
<meta content="10/25/02" name="date last modified">
<!-- InstanceEndEditable -->

<!--(Links)=========================================================-->
<!-- InstanceBeginEditable name="head" -->
<link href="../xmlbeans.css" rel="stylesheet" type="text/css">
<!-- InstanceEndEditable -->
<link href="../xmlbeans.css" rel="stylesheet" type="text/css">
<a href="../../../core/index.html" id="index"></a>
<script language="JavaScript" src="../../../core/topicInfo.js"></script>
<script language="JavaScript" src="../../../core/CookieClass.js"></script>
<script language="JavaScript" src="../../../core/displayContent.js"></script>
</head>

<!--(Body)==========================================================-->
<body>
<script language="JavaScript">

</script>
<!-- InstanceBeginEdi
 table name="body" -->
<h1> Handling xs:any  with the XMLBeans API </h1>
<p>Compiling schema for use with XMLBeans generates a kind of custom API specific to your schema. This API includes types with accessors designed to get and set parts of the XML defined by the schema. But if you've compiled schema that includes <code>xs:any</code> particles, you may  have noticed that XMLBeans doesn't generate accessors for these these particles. </p>
<p>For example, imagine the accessors generated by compiling the following schema snippet: </p>
<div id="topictext"><pre>&lt;xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
    xmlns="http://xmlbeans.apache.org/samples/any"
    targetNamespace="http://xmlbeans.apache.org/samples/any" elementFormDefault="qualified">
    &lt;xs:element name="root">
        &lt;xs:complexType>
            &lt;xs:sequence>
                &lt;xs:element ref="stringelement"/>
                &lt;xs:any processContents="lax"/>
                &lt;xs:element
  name="arrayofany">
                    &lt;xs:complexType>
                        &lt;xs:sequence>
                            &lt;xs:any namespace="##any" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
                        &lt;/xs:sequence>
                    &lt;/xs:complexType>
                &lt;/xs:element>
            &lt;/xs:sequence>
        &lt;/xs:complexType>
    &lt;/xs:element>
    &lt;xs:element name="stringelement" type="xs:string"/>    
    &lt;xs:complexType name="ListOfStrings">
        &lt;xs:sequence>
            &lt;xs:element ref="stringelement" minOccurs="0" maxOccurs="unbounded"/>
        &lt;/xs:sequence>
        &lt;xs:attribute name="id" type="xs:string"/>
    &lt;/xs:complexType>
&lt;/xs:schema></pre>
    <p>After compilation, you'd have the follow methods for <code>Root</code>, the type that gives you access to the <code>&lt;root&gt;</code> element:</p>
    <p><code>addNewArrayofany()</code></p>
    <p><code>getArrayofany()</c
 ode></p>
    <p><code>getStringelement()</code></p>
    <p><code>setArrayofany(Arrayofany)</code></p>
    <p><code>setStringelement(String)</code></p>
    <p><code>xgetStringelement()</code></p>
    <p><code>xsetStringelement(XmlString)</code></p>
    <p>What's missing? There's no <code>getAny</code> or <code>setAny</code>. How do you get or set the <code>&lt;root&gt;</code> element's second child? As it turns out, you do this by leaving behind (at least for a moment) JavaBeans-style accessors, and picking up any of a number of tools the API provides. These tools include:</p>
    <ul>
        <li><a href="#using_cursors">Using <code>XmlCursor</code> instances</a> to &quot;walk&quot; the XML, handling elements cursor-style.</li>
        <li><a href="#using_xpath">Using the <code>selectPath</code> method</a> to retrieve the XML you want via XPath.</li>
        <li><a href="#using_selectchildren">Using the <code>selectChildren</code> method</a> to retrieve child elements by nam
 e.</li>
        <li> <a href="#using_dom">Using the DOM API</a> to &quot;walk&quot; the node tree, handling elements by name.</li>
    </ul>
    <h2><a name="using_cursors"></a>Using Cursors to Add XML </h2>
    <p>As described in <a href="conNavigatingXMLwithCursors.html">Navigating XML with Cursors</a>, with an <code>XmlCursor</code> instance you can traverse your XML instance's full infoset. A cursor views XML as tokens, and you move a cursor from one token to another as if they were cars in a train.</p>
    <p>The following example illustrates how you might, in the course of building out the <code>&lt;root&gt;</code> document, create a  second child element <code>&lt;anyfoo&gt;</code> where schema specifies <code>xs:any</code>. You add the element by creating it with a cursor, then (in lieu of a setter) using the <code>XmlCursor.copyXml</code> or <code>XmlCursor.moveXml</code> method to put the element where it needs to go.</p>
    <pre>// Start by creating a &lt;root> e
 lement that will contain
// the children built by this code.
RootDocument rootDoc = RootDocument.Factory.newInstance();
RootDocument.Root root = rootDoc.addNewRoot();

// Add the first element, &lt;stringelement>.
root.setStringelement("some text");

// Create an XmlObject in which to build the second
// element in the sequence, &lt;anyfoo>. Here, the 
// XmlObject instance is simply a kind of incubator
// for the XML. Later the XML will be moved into the
// document this code is building.
XmlObject anyFoo = XmlObject.Factory.newInstance();

// Add a cursor to do the work of building the XML.
XmlCursor anyFooCursor = anyFoo.newCursor();
anyFooCursor.toNextToken();

// Add the element in the schema's namespace, then add
// element content.
anyFooCursor.beginElement(new QName(m_namespaceUri, "anyfoo"));
anyFooCursor.insertChars("some text");

// Move the cursor back to the new element's top, where 
// it can grab all of the element's XML.
anyFooCursor.toStartDoc();
anyFooCurso
 r.toNextToken();

// Finally, move the XML into the &lt;root> document by moving it
// from a position at one cursor to a position at
// another.
XmlCursor rootCursor = root.newCursor();
rootCursor.toEndToken();
anyFooCursor.moveXml(rootCursor);</pre>
    <p>You might find that this build-and-move-cursor-to-cursor pattern is common when you're creating or moving XML when accessors aren't available. For example, you could do the same sort of thing when your schema defines a type that you want to place into an <code>xs:any</code> space in an instance. The following code adds a <code>&lt;stringelement&gt; </code>element as a child of the <code>&lt;arrayofany&gt;</code> element, which schema defines as containing a sequence of <code>xs:any</code> particles. The <code>&lt;stringlement&gt;</code> element is simple, but it could just as easily be a complex schema type.</p>
    <pre>// Create a simple &lt;stringelement>.
StringelementDocument stringElementDoc = 
    StringelementDoc
 ument.Factory.newInstance();        
stringElementDoc.setStringelement("some text");
XmlCursor stringElementCursor = stringElementDoc.newCursor();
stringElementCursor.toFirstContentToken();

// Add a cursor to mark the position to which the new child 
// XML will be moved.
XmlCursor arrayCursor = arrayOfAny.newCursor();
arrayCursor.toNextToken();

// Move the new &lt;stringelement> into place.
stringElementCursor.moveXml(arrayCursor);
stringElementCursor.dispose();</pre>
    <h2><a name="using_xpath"></a>Using XPath and the selectPath Method to Find XML </h2>
    <p>XPath is a convenient, direct way to get at specific chunks of XML. In the XMLBeans API, you execute XPath expressions with the <code>XmlObject.selectPath</code> or <code>XmlCursor.selectPath</code> methods. The example in Java below assumes the following instance conforming to the schema introduced at the beginning of this topic:</p>
    <pre>&lt;root xmlns="http://xmlbeans.apache.org/samples/any">
    &lt;strin
 gelement>some text&lt;/stringelement>
    &lt;anyfoo>some text&lt;/anyfoo>
    &lt;arrayofany>
        &lt;stringelement>some text&lt;/stringelement>
        &lt;someelement>
            &lt;stringlist id="001">
                &lt;stringelement>string1&lt;/stringelement>
                &lt;stringelement>string2&lt;/stringelement>
            &lt;/stringlist>
        &lt;/someelement>
    &lt;/arrayofany>
&lt;/root></pre>
    <p>The following code uses XPath to reach the <code>&lt;stringelement&gt;</code> element because there is no accessor available. It then shifts the XML around a little, moving <code>&lt;stringelement&gt;</code> up in the hierarchy to replace its parent, <code>&lt;someelement&gt;</code>. </p>
    <pre>public boolean editExistingDocWithSelectPath(RootDocument rootDoc)
{
    String namespaceUri = "http://xmlbeans.apache.org/samples/any";

    // Put a cursor at the top of the &lt;arrayofany> element.
    XmlCursor selectionCursor = rootDoc.getRoot().getAr
 rayofany().newCursor();

    // Use XPath and cursor movement to position the cursor at
    // the &lt;stringlist> element.
    String namespaceDecl = "declare namespace any='" + namespaceUri + "'; ";
    selectionCursor.selectPath(namespaceDecl + 
        "$this//any:someelement/any:stringlist");
    selectionCursor.toNextSelection();

    // Create a new cursor at the same location and move it to 
    // &lt;stringelement&gt;'s &lt;someelement> parent.
    XmlCursor editCursor = selectionCursor.newCursor();
    editCursor.toParent();

    // Move the &lt;stringelement> element to this position, displacing 
    // the &lt;someelement> downward. Remove the &lt;someelement> XML, 
    // effectively replacing &lt;someelement> with &lt;stringlist>.
    selectionCursor.moveXml(editCursor);
    editCursor.removeXml();
    editCursor.dispose();

    return rootDoc.validate();
}</pre>
    <h2><a name="using_selectchildren"></a>Using the selectChildren Method to Find XML </h2>
    <
 p>The <code>XmlObject.selectChildren</code> method you can retrieve an array of the child elements of a specified name. The method is overloaded to take <code>java.xml.namespace.QName</code> instances or strings as parameters. The following code (based on the instance used in the preceding example) simply finds the <code>&lt;anyfoo&gt;</code> element, an <code>xs:any</code>, and replaces it with an <code>&lt;anybar&gt;</code> element. </p>
    <pre>public boolean editExistingDocWithSelectChildren(RootDocument rootDoc)
{
    String namespaceUri = "http://xmlbeans.apache.org/samples/any";
    RootDocument.Root root = rootDoc.getRoot();
        
    // Select the &lt;anyfoo> children of &lt;root>.
    XmlObject[] stringElements =
        root.selectChildren(new QName(m_namespaceUri, "anyfoo"));

    // If the element is there, replace it with another element.
    if (stringElements.length > 0)
    {
        XmlCursor editCursor = stringElements[0].newCursor();
        editCurso
 r.removeXml();
        editCursor.beginElement(new QName(namespaceUri, "anybar"));
        editCursor.insertChars("some other text");                
        editCursor.dispose();
    }
    return rootDoc.validate();
}</pre>
    <h2><a name="using_dom"></a>Using the DOM API to Find XML </h2>
    <p>Through the <code>getDomNode</code> method (exposed by <code>XmlObject</code> and types generated from schema), you can get a live DOM node representing your XML. For example, calling <code>myElement.getDomNode()</code> will return a <code>org.w3c.dom.Node</code> instance representing the XML bound to <code>myElement</code>. If you're already familiar with DOM-style access to XML, this can be a familiar alternative for handling <code>xs:any</code> instances.</p>
    <p> Using the instance introduced earlier in this topic, the following example adds a new <code>&lt;bar&gt;</code> element between the first and second children of the <code>&lt;arrayofany&gt;</code> element. The code 
 also ensures that the first and second children are <code>&lt;stringelement&gt;</code> and <code>&lt;someelement&gt;</code>, respectively.</p>
    <pre>public boolean editExistingDocWithDOM(RootDocument rootDoc)
{
    RootDocument.Root root = rootDoc.getRoot();
        
    // Get the DOM nodes for the &lt;arrayofany> element's children.
    Node arrayOfAnyNode = root.getArrayofany().getDomNode();

    // You don't have get* accessors for any of the &lt;arrayofany> 
    // element's children, so use DOM to identify the first
    // and second elements while looping through the child list.
    NodeList childList = arrayOfAnyNode.getChildNodes();
    Element firstElementChild = null;
    Element secondElementChild = null;

    // Find the first child element and make sure it's
    // &lt;stringelement>.
    for (int i = 0; i < childList.getLength(); i++)
    {
        Node node = childList.item(i);
        if (node.getNodeType() == Node.ELEMENT_NODE)
        {
            if (
 node.getLocalName().equals("stringelement"))
            {
                firstElementChild = (Element)node;                
                break;
            }
        }
    }
    if (firstElementChild == null) {return false;}

    // Find the second child element and make sure it's
    // &lt;someelement>.
    Node node = firstElementChild.getNextSibling();
    do 
	{
        if (node.getNodeType() == Node.ELEMENT_NODE)
        {
            if (node.getLocalName().equals("someelement"))
            {
                secondElementChild = (Element)node;
                break;
            }
        }
        node = node.getNextSibling();
    } while (node != null);
    if (secondElementChild == null) {return false;}
    
    // Create and insert a new &lt;bar> element.
    Element fooElement = 
        secondElementChild.getOwnerDocument().createElementNS("http://openuri.org","bar");
    Node valueNode = 
        fooElement.getOwnerDocument().createTextNode("some text");
 
    fooElement.appendChild(valueNode);
    arrayOfAnyNode.insertBefore(fooElement, secondElementChild);
    
    return rootDoc.validate();
}</pre>
</div>
<div>
<h2>Related Topics</h2>
</div>
<p><a href="conGettingStartedwithXMLBeans.html">Getting Started with XMLBeans</a></p>
<!-- InstanceEndEditable -->
<script language="JavaScript">

</script>
</body>
</html>
\ No newline at end of file

Modified: xmlbeans/site/build/site/docs/2.0.0/guide/conSelectingXMLwithXQueryPathXPath.html
URL: http://svn.apache.org/viewcvs/xmlbeans/site/build/site/docs/2.0.0/guide/conSelectingXMLwithXQueryPathXPath.html?rev=209780&r1=209779&r2=209780&view=diff
==============================================================================
--- xmlbeans/site/build/site/docs/2.0.0/guide/conSelectingXMLwithXQueryPathXPath.html (original)
+++ xmlbeans/site/build/site/docs/2.0.0/guide/conSelectingXMLwithXQueryPathXPath.html Fri Jul  8 07:10:29 2005
@@ -1 +1,338 @@
-<!doctype HTML public "-//W3C//DTD HTML 4.0 Frameset//EN">

<!-- Copyright 2004 The Apache Software Foundation

     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.
     You may obtain a copy of the License at

         http://www.apache.org/licenses/LICENSE-2.0

     Unless required by applicable law or agreed to in writing, software
     distributed under the License is distributed on an "AS IS" BASIS,
     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     See the License for the specific language governing permissions and
     limitations under the License. -->
<html>
<head>
<!-- InstanceBeginEditable name="doctitle" -->
<title>Selecting XML with XQuery and XPath</title>
<!-- InstanceEndEditable -->
<!--(Meta)==========================================================-->

<meta http-equiv=Content-Type content="text/html; charset=$CHARSET;">


<!-- InstanceBegin
 Editable name="metatags" -->

<meta content="your name" name="author">
<meta content="A description of the topic contents." name="description">
<meta content="keywords to help in searches" name="keywords">
<meta content="10/25/02" name="date last modified">
<!-- InstanceEndEditable -->

<!--(Links)=========================================================-->
<!-- InstanceBeginEditable name="head" -->
<link href="../xmlbeans.css" rel="stylesheet" type="text/css">
<!-- InstanceEndEditable -->
<link href="../xmlbeans.css" rel="stylesheet" type="text/css">
<a href="../../../core/index.html" id="index"></a>
<script language="JavaScript" src="../../../core/topicInfo.js"></script>
<script language="JavaScript" src="../../../core/CookieClass.js"></script>
<script language="JavaScript" src="../../../core/displayContent.js"></script>
</head>

<!--(Body)==========================================================-->
<body>
<script language="JavaScript">

</script>
<!-- InstanceBeginEditab
 le name="body" -->
<h1> Selecting XML with XQuery and XPath</h1>
<div id="topictext">
    <p>You can use XQuery and XPath to retrieve specific pieces of XML as you might
        retrieve data from a database. XQuery and XPath provide a syntax for specifying
        which elements and attributes you're interested in. The XMLBeans API provides
        two methods for executing XQuery and XPath expressions, and two differing
        ways to use them. The methods are <span class="langinline">selectPath</span>
        and <span class="langinline">execQuery</span>, and you can call them from
        <a href="../reference/org/apache/xmlbeans/XmlObject.html"><span class="langinline">XmlObject</span></a>
        (or an object inheriting from it) or <a href="../reference/org/apache/xmlbeans/XmlCursor.html"><span class="langinline">XmlCursor</span></a>.
        The results for the methods differ somewhat. </p>
    <p class="notepara"><strong>Note:</strong> Be sure to see the XMLBeans <
 a href="../../../documentation/conInstallGuide.html">installation instructions</a> for getting full support for XPath and XQuery. </p>
    <h2>Using the selectPath Method</h2>
</div>
<div>
  <p>The <span class="langinline">selectPath</span> method is the most efficient
    way to execute XPath expressions. The <span class="langinline">selectPath</span>
    method is optimized for XPath. When you use XPath with the <span class="langinline">selectPath</span>
    method, the value returned is an array of values from the <em>current document</em>.
    In contrast, when you use <span class="langinline">execQuery</span>, the value
    returned is a <em>new document</em>.</p>
    <p> Note that XPath itself does not provide syntax for declaring prefix to URI bindings. For user convenience, we allow XQuery syntax to be used for such purposes. You can consult the latest XQuery draft when using syntax for declaring namespaces.</p>

  <h3>Calling from XmlObject</h3>
  <p>When called fro
 m <span class="langinline">XmlObject</span> (or a type that
    inherits from it), this method returns an array of objects. If the expression
    is executed against types generated from schema, then the type for the returned
    array is one of the Java types corresponding to the schema. </p>
  <p>For example, imagine you have the following XML containing employee information.
    You've compiled the schema describing this XML and the types generated from
    schema are available to your code.</p>
<pre>
&lt;xq:employees xmlns:xq=&quot;http://openuri.org/selectPath&quot;&gt;
    &lt;xq:employee&gt;
        &lt;xq:name&gt;Fred Jones&lt;/xq:name&gt;
        &lt;xq:address location=&quot;home&quot;&gt;
            &lt;xq:street&gt;900 Aurora Ave.&lt;/xq:street&gt;
            &lt;xq:city&gt;Seattle&lt;/xq:city&gt;
            &lt;xq:state&gt;WA&lt;/xq:state&gt;
            &lt;xq:zip&gt;98115&lt;/xq:zip&gt;
        &lt;/xq:address&gt;
        &lt;xq:address location=&quot;work&
 quot;&gt;
            &lt;xq:street&gt;2011 152nd Avenue NE&lt;/xq:street&gt;
            &lt;xq:city&gt;Redmond&lt;/xq:city&gt;
            &lt;xq:state&gt;WA&lt;/xq:state&gt;
            &lt;xq:zip&gt;98052&lt;/xq:zip&gt;
        &lt;/xq:address&gt;
        &lt;xq:phone location=&quot;work&quot;&gt;(425)555-5665&lt;/xq:phone&gt;
        &lt;xq:phone location=&quot;home&quot;&gt;(206)555-5555&lt;/xq:phone&gt;
        &lt;xq:phone location=&quot;mobile&quot;&gt;(206)555-4321&lt;/xq:phone&gt;
    &lt;/xq:employee&gt;
&lt;/xq:employees&gt;
</pre>
  If you wanted to find the phone numbers whose area code was 206, you could capture
  the XPath expression in this way:
  <pre>
String queryExpression =
    &quot;declare namespace xq='http://openuri.org/selectPath';&quot; +
    &quot;$this/xq:employees/xq:employee/xq:phone[contains(., '(206)')]&quot;
</pre>
  <p>Notice in the query expression that the variable <span class="langinline">$this</span>
    represents the current context 
 node (the <span class="langinline">XmlObject</span>
    that you are querying from). In this example you are querying from the document
    level <span class="langinline">XmlObject</span>.</p>
  <p>You could then print the results with code such as the following:</p>
  <pre>
/*
 * Retrieve the matching phone elements and assign the results to the corresponding
 * generated type.
 */
PhoneType[] phones = (PhoneType[])empDoc.selectPath(queryExpression);
/*
 * Loop through the results, printing the value of the phone element.
 */
for (int i = 0; i < phones.length; i++)
{
    System.out.println(phones[i].stringValue());
}  </pre>

  <h3>Calling from XmlCursor</h3>
  <p>When called from an <span class="langinline">XmlCursor</span> instance, the
    <span class="langinline">selectPath</span> method retrieves a list of selections,
    or locations in the XML. The selections are remembered by the cursor instance.
    You can use methods such as <span class="langinline">toNextSelecti
 on</span>
    to navigate among them.</p>
  <div>
    <p>The <span class="langinline">selectPath</span> method takes an XPath expression.
      If the expression returns any results, each of those results is added as
      a selection to the cursor's list of selections. You can move through these
      selections in the way you might use <span class="langinline">java.util.Iterator</span>
      methods to move through a collection.</p>
    <p> For example, for a path such as <span class="langinline">$this/employees/employee</span>,
      the results would include a selection for each employee element found by
      the expression. Note that the variable <span class="langinline">$this</span>
      is always bound to the current context node, which in this example is the
      document. After calling the <span class="langinline">selectPath</span> method,
      you would use various &quot;selection&quot;-related methods to work with
      the results. These methods include:</p>
   </div>
  <ul>
    <li>
      <div><span class="langinline">getSelectionCount() </span>to retrieve the
        number of selections resulting from the query.</div>
    </li>
    <li>
      <div> <span class="langinline">toNextSelection()</span> to move the cursor
        to the next selection in the list (such as to the one pointing at the
        next employee element found).</div>
    </li>
    <li>
      <div> <span class="langinline">toSelection(int)</span> to move the cursor
        to the selection at the specified index (such as to the third employee
        element in the selection).</div>
    </li>
    <li>
      <div> <span class="langinline">hasNextSelection()</span> to find out if
        there are more selections after the cursor's current position.</div>
    </li>
    <li>
      <div><span class="langinline"> clearSelections()</span> clears the selections
        from the current cursor. This doesn't modify the document (in other words,
        it doesn't dele
 te the selected XML); it merely clears the selection list
        so that the cursor is no longer keeping track of those positions.</div>
    </li>
  </ul>
  <div>
    <p>The following example shows how you might use <span class="langinline">selectPath</span>,
      in combination with the <span class="langinline">push</span> and <span class="langinline">pop</span>
      methods, to maneuver through XML, retrieving specific values. </p>
    <pre>
public void printZipsAndWorkPhones(XmlObject xml)
{
    // Declare the namespace that will be used.
    String xqNamespace =
        &quot;declare namespace xq='http://openuri.org/selectPath';&quot;;

    // Insert a cursor and move it to the first element.
    XmlCursor cursor = xml.newCursor();
    cursor.toFirstChild();
    /*
     * Save the cursor's current location by pushing it
     * onto a stack of saved locations.
     */
    cursor.push();
    // Query for zip elements.
    cursor.selectPath(xqNamespace + &quot;$this//xq:
 zip&quot;);
    /*
     * Loop through the list of selections, getting the value of
     * each element.
     */
    while (cursor.toNextSelection())
    {
        System.out.println(cursor.getTextValue());
    }
    // Pop the saved location off the stack.
    cursor.pop();
    // Query again from the top, this time for work phone numbers.
    cursor.selectPath(xqNamespace + &quot;$this//xq:phone[@location='work']&quot;);
    /*
     * Move the cursor to the first selection, them print that element's
     * value.
     */
    cursor.toNextSelection();
    System.out.println(cursor.getTextValue());
    // Dispose of the cursor.
    cursor.dispose();
}
</pre>
    <p>Using selections is somewhat like tracking the locations of multiple cursors
      with a single cursor. This becomes especially clear when you remove the
      XML associated with a selection. When you do so the selection itself remains
      at the location where the removed XML was, but now the selection's loca
 tion
      is immediately before the XML that was after the XML you removed. In other
      words, removing XML created a kind of vacuum that was filled by the XML
      after it, which shifted up into the space &#8212; up into position immediately
      after the selection location. This is exactly the same as if the selection
      had been another cursor.</p>
    <p>Finally, when using selections keep in mind that the list of selections
      is in a sense &quot;live&quot;. The cursor you're working with is keeping
      track of the selections in the list. In other words, be sure to call the
      <span class="langinline">clearSelections</span> method when you're finished
      with the selections, just as you should call the <span class="langinline">XmlCursor.dispose()</span>
      method when you're finished using the cursor.</p>
  </div>
  <h2>Using the execQuery Method</h2>
  <p>Use the <span class="langinline">execQuery</span> method to execute XQuery
    expression
 s that are more sophisticated than paths. These expressions include
    more sophisticated loops and FLWR (For, Let, Where, and Results) expressions.
  </p>
  <p class="notepara"><strong>Note:</strong> Be sure to see the simpleExpressions
    sample in the SamplesApp application for a sampling of XQuery expressions
    in use.</p>
  <h3>Calling from XmlObject</h3>
  <p>Unlike <span class="langinline">selectPath</span>, calling <span class="langinline">execQuery</span>
    from an <span class="langinline">XmlObject</span> instance will return an
    <span class="langinline">XmlObject</span> array. If the <span class="langinline">XmlObject</span>
    instances resulting from the XQuery match a recognized XMLBeans type (the
    namespace and top level element name match up with an XMLBeans type) then
    the <span class="langinline">XmlObject</span> will be typed; otherwise the
    <span class="langinline">XmlObject</span> will be untyped.</p>
  <h3>Calling from XmlCursor</h3>
 </div>

<div>
  <p>Calling <span class="langinline">execQuery</span> from an <span class="langinline">XmlCursor</span>
    instance returns a new <span class="langinline">XmlCursor</span> instance.
    The cursor returned is positioned at the beginning of a new xml document representing
    the query results, and you can use it to move through the results, cursor-style
    (for more information, see <a href="conNavigatingXMLwithCursors.html">Navigating
    XML with Cursors</a>). If the document resulting from the query execution
    represents a recognized XMLBeans type (the namespace and top level element
    name match up with an XMLBeans type) then the document resulting from the
    xquery will have that Java type; otherwise the resulting document will be
    untyped.</p>
  <h2>Related Topics</h2>
</div>
<p><a href="conGettingStartedwithXMLBeans.html">Getting Started with XMLBeans</a></p>
<!-- InstanceEndEditable -->
<script language="JavaScript">

</script>
</body>
</ht
 ml>
\ No newline at end of file
+<!doctype HTML public "-//W3C//DTD HTML 4.0 Frameset//EN">
+
+<!-- Copyright 2004 The Apache Software Foundation
+
+     Licensed under the Apache License, Version 2.0 (the "License");
+     you may not use this file except in compliance with the License.
+     You may obtain a copy of the License at
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+     Unless required by applicable law or agreed to in writing, software
+     distributed under the License is distributed on an "AS IS" BASIS,
+     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+     See the License for the specific language governing permissions and
+     limitations under the License. -->
+<html>
+<head>
+<!-- InstanceBeginEditable name="doctitle" -->
+<title>Selecting XML with XQuery and XPath</title>
+<!-- InstanceEndEditable -->
+<!--(Meta)==========================================================-->
+
+<meta http-equiv=Content-Type content="text/html; charset=$CHARSET;">
+
+
+<!-- InstanceBeginEditable name="metatags" -->
+
+<meta content="your name" name="author">
+<meta content="A description of the topic contents." name="description">
+<meta content="keywords to help in searches" name="keywords">
+<meta content="10/25/02" name="date last modified">
+<!-- InstanceEndEditable -->
+
+<!--(Links)=========================================================-->
+<!-- InstanceBeginEditable name="head" -->
+<link href="../xmlbeans.css" rel="stylesheet" type="text/css">
+<!-- InstanceEndEditable -->
+<link href="../xmlbeans.css" rel="stylesheet" type="text/css">
+<a href="../../../core/index.html" id="index"></a>
+<script language="JavaScript" src="../../../core/topicInfo.js"></script>
+<script language="JavaScript" src="../../../core/CookieClass.js"></script>
+<script language="JavaScript" src="../../../core/displayContent.js"></script>
+</head>
+
+<!--(Body)==========================================================-->
+<body>
+<script language="JavaScript">
+
+</script>
+<!-- InstanceBeginEditable name="body" -->
+<h1> Selecting XML with XQuery and XPath</h1>
+<div id="topictext">
+    <p>You can use XPath and XQuery to retrieve specific pieces of XML as you might
+        retrieve data from a database. XQuery and XPath provide a syntax for specifying
+        which elements and attributes you're interested in. The XMLBeans API provides
+        two methods for executing XQuery and XPath expressions, and two ways to use them. The methods are <span class="langinline">selectPath</span>
+        for XPath and <span class="langinline">execQuery</span> for XQuery. </p>
+    <p>You can call them from and <a href="../reference/org/apache/xmlbeans/XmlObject.html"><span class="langinline"> XmlObject</span></a> instance (or a generated type inheriting from it) or an <a href="../reference/org/apache/xmlbeans/XmlCursor.html"><span class="langinline">XmlCursor</span></a> instance.
+            As noted below, each of the four methods works slightly differently; be sure to keep these differences in mind when choosing your approach.</p>
+    <p class="notepara"><strong>Note:</strong> Both XQuery and complex XPath expressions require additional classes on the class path, as noted in the sections that follow. Also, be sure to see the XMLBeans <a href="../../../documentation/conInstallGuide.html">installation instructions</a>. </p>
+    <h2><a name="xpath_selectpath"></a>Using XPath with the selectPath Method</h2>
+</div>
+<div>
+  <p>You can execute XPath expressions use the <span class="langinline">selectPath</span> method. When you use XPath with the <span class="langinline">selectPath</span>
+    method, the value returned is view of values from the <em>current document</em> &#8212; not a copy of those values. In other words, changes your code makes to XML returned by the selectPath method change the XML in the document queried against. In contrast, with XQuery executed using the <span class="langinline">execQuery</span> method, the value returned is a <em>copy of values in the XML queried against</em>.</p>
+    <p> Note that XPath itself does not provide syntax for declaring prefix to URI bindings. For user convenience, we allow XQuery syntax to be used for such purposes. You can consult the latest XQuery draft when using syntax for declaring namespaces.</p>
+    <blockquote>
+        <p><strong>Note:</strong> By default, XMLBeans supports only very simple XPath expressions. To execute complex expressions &#8212; such as those with predicates, function calls, and the like &#8212; you will need xbean_xpath.jar on your class path. This JAR is among those created when you build XMLBeans from source.</p>
+    </blockquote>
+    <h3>Calling XmlObject.selectPath</h3>
+  <p>When called from <span class="langinline">XmlObject</span> (or a type that
+    inherits from it), the <code>selectPath</code> method returns an array of objects. If the expression
+    is executed against types generated from schema, then the type for the returned
+    array is one of the Java types corresponding to the schema, and you can cast it accordingly. </p>
+  <p>For example, imagine you have the following XML containing employee information.
+    You've compiled the schema describing this XML and the types generated from
+    schema are available to your code.</p>
+<pre>
+&lt;xq:employees xmlns:xq=&quot;http://xmlbeans.apache.org/samples/xquery/employees&quot;&gt;
+    &lt;xq:employee&gt;
+        &lt;xq:name&gt;Fred Jones&lt;/xq:name&gt;
+        &lt;xq:address location=&quot;home&quot;&gt;
+            &lt;xq:street&gt;900 Aurora Ave.&lt;/xq:street&gt;
+            &lt;xq:city&gt;Seattle&lt;/xq:city&gt;
+            &lt;xq:state&gt;WA&lt;/xq:state&gt;
+            &lt;xq:zip&gt;98115&lt;/xq:zip&gt;
+        &lt;/xq:address&gt;
+        &lt;xq:address location=&quot;work&quot;&gt;
+            &lt;xq:street&gt;2011 152nd Avenue NE&lt;/xq:street&gt;
+            &lt;xq:city&gt;Redmond&lt;/xq:city&gt;
+            &lt;xq:state&gt;WA&lt;/xq:state&gt;
+            &lt;xq:zip&gt;98052&lt;/xq:zip&gt;
+        &lt;/xq:address&gt;
+        &lt;xq:phone location=&quot;work&quot;&gt;(425)555-5665&lt;/xq:phone&gt;
+        &lt;xq:phone location=&quot;home&quot;&gt;(206)555-5555&lt;/xq:phone&gt;
+        &lt;xq:phone location=&quot;mobile&quot;&gt;(206)555-4321&lt;/xq:phone&gt;
+    &lt;/xq:employee&gt;
+&lt;/xq:employees&gt;
+</pre>
+  If you wanted to find the phone numbers whose area code was 206, you could capture
+  the XPath expression in this way:
+  <pre>
+String queryExpression =
+    &quot;declare namespace xq='http://xmlbeans.apache.org/samples/xquery/employees';&quot; +
+    &quot;$this/xq:employees/xq:employee/xq:phone[contains(., '(206)')]&quot;;
+</pre>
+  <p>Notice in the query expression that the variable <span class="langinline">$this</span>
+    represents the current context node (the <span class="langinline">XmlObject</span>
+    that you are querying from). In this example you are querying from the document
+    level <span class="langinline">XmlObject</span>.</p>
+  <p>You could then print the results with code such as the following:</p>
+  <pre>// Retrieve the matching phone elements and assign the results to the corresponding
+// generated type.
+PhoneType[] phones = (PhoneType[])empDoc.selectPath(queryExpression);
+
+// Loop through the results, printing the value of the phone element.
+for (int i = 0; i < phones.length; i++)
+{
+    System.out.println(phones[i].stringValue());
+}</pre>
+
+  <h3>Calling XmlCursor.selectPath</h3>
+  <p>When called from an <span class="langinline">XmlCursor</span> instance, the
+    <span class="langinline">selectPath</span> method retrieves a list of <em>selections</em>,
+    or locations in the XML. The selections are remembered by the cursor instance.
+    You can use methods such as <span class="langinline">toNextSelection</span>
+    to navigate among them.</p>
+  <div>
+    <p>The <span class="langinline">selectPath</span> method takes an XPath expression.
+      If the expression returns any results, each of those results is added as
+      a selection to the cursor's list of selections. You can move through these
+      selections in the way you might use <span class="langinline">java.util.Iterator</span>
+      methods to move through a collection.</p>
+    <p> For example, for a path such as <span class="langinline">$this/employees/employee</span>,
+      the cursor instance from which you called <code>selectPath</code> would include a selection for each employee element found by
+      the expression. Note that the variable <span class="langinline">$this</span>
+      is always bound to the current context node, which in this example is the
+      document. After calling the <span class="langinline">selectPath</span> method,
+      you would use various &quot;selection&quot;-related methods to work with
+      the results. These methods include:</p>
+  </div>
+  <ul>
+    <li>
+      <div><span class="langinline">getSelectionCount() </span>to retrieve the
+        number of selections resulting from the query.</div>
+    </li>
+    <li>
+      <div> <span class="langinline">toNextSelection()</span> to move the cursor
+        to the next selection in the list (such as to the one pointing at the
+        next employee element found).</div>
+    </li>
+    <li>
+      <div> <span class="langinline">toSelection(int)</span> to move the cursor
+        to the selection at the specified index (such as to the third employee
+        element in the selection).</div>
+    </li>
+    <li>
+      <div> <span class="langinline">hasNextSelection()</span> to find out if
+        there are more selections after the cursor's current position.</div>
+    </li>
+    <li>
+      <div><span class="langinline"> clearSelections()</span> clears the selections
+        from the current cursor. This doesn't modify the document (in other words,
+        it doesn't delete the selected XML); it merely clears the selection list
+        so that the cursor is no longer keeping track of those positions.</div>
+    </li>
+  </ul>
+  <div>
+    <p>The following example shows how you might use <span class="langinline">selectPath</span>,
+      in combination with the <span class="langinline">push</span> and <span class="langinline">pop</span>
+      methods, to maneuver through XML, retrieving specific values. </p>
+    <pre>
+public void printZipsAndWorkPhones(XmlObject xml)
+{
+    // Declare the namespace that will be used.
+    String xqNamespace =
+        &quot;declare namespace xq='http://xmlbeans.apache.org/samples/xquery/employees';&quot;;
+
+    // Insert a cursor and move it to the first element.
+    XmlCursor cursor = xml.newCursor();
+    cursor.toFirstChild();
+
+    // Save the cursor's current location by pushing it
+    // onto a stack of saved locations.
+    cursor.push();
+    // Query for zip elements.
+    cursor.selectPath(xqNamespace + &quot;$this//xq:zip&quot;);
+
+    // Loop through the list of selections, getting the value of
+    // each element.
+    while (cursor.toNextSelection())
+    {
+        System.out.println(cursor.getTextValue());
+    }
+    // Pop the saved location off the stack.
+    cursor.pop();
+    // Query again from the top, this time for work phone numbers.
+    cursor.selectPath(xqNamespace + &quot;$this//xq:phone[@location='work']&quot;);
+
+    // Move the cursor to the first selection, then print that element's
+    // value.
+    cursor.toNextSelection();
+    System.out.println(cursor.getTextValue());
+    // Dispose of the cursor.
+    cursor.dispose();
+}
+</pre>
+    <p>Using selections is somewhat like tracking the locations of multiple cursors
+      with a single cursor. This becomes especially clear when you remove the
+      XML associated with a selection. When you do so the selection itself remains
+      at the location where the removed XML was, but now the selection's location
+      is immediately before the XML that was after the XML you removed. In other
+      words, removing XML created a kind of vacuum that was filled by the XML
+      after it, which shifted up into the space &#8212; up into position immediately
+      after the selection location. This is exactly the same as if the selection
+      had been another cursor.</p>
+    <p>Finally, when using selections keep in mind that the list of selections
+      is in a sense &quot;live&quot;. The cursor you're working with is keeping
+      track of the selections in the list. In other words, be sure to call the
+      <span class="langinline">clearSelections</span> method when you're finished
+      with the selections, just as you should call the <span class="langinline">XmlCursor.dispose()</span>
+      method when you're finished using the cursor.</p>
+  </div>
+  <h2><a name="xquery_execquery"></a>Using XQuery with the execQuery Method</h2>
+  <p>You use the <span class="langinline">execQuery</span> method to execute XQuery
+    expressions. With XQuery expressions, XML returned is a copy of XML in the document queried against. In other words, changes your code makes to the values returned by <code>execQuery</code> are not reflected in the document queried against.</p>
+  <blockquote>
+      <p><strong>Note:</strong> To execute XQuery expressions, you must have the Saxon 8.1.1 JAR on your class path. Look for the download at the <a href="http://sourceforge.net/project/showfiles.php?group_id=29872&package_id=21888">Saxon web site</a>. This JAR is also included in the lib directory when you build XMLBeans from source.</p>
+  </blockquote>
+  <h3>Calling XmlObject.execQuery</h3>
+  <p>As with <span class="langinline">selectPath</span>, calling <span class="langinline">execQuery</span>
+    from an <span class="langinline">XmlObject</span> instance will return an
+    <span class="langinline">XmlObject</span> array.</p>
+  <p> The following example retrieves work <code>&lt;zip&gt;</code> elements from the incoming XML, adding the elements as children to a new <code>&lt;zip-list&gt;</code> element.</p>
+   <pre>public boolean collectZips(XmlObject empDoc)
+{
+    String namespaceDeclaration = 
+        "declare namespace xq='http://xmlbeans.apache.org/samples/xquery/employees';";
+    // The query is designed to return results, so return
+    // true if it does.
+    boolean hasResults = false;
+
+    // The expression: Get the &lt;zip> elements and return them as children 
+    // of a new &lt;zip-list> element.
+    String queryExpression =
+        "let $e := $this/xq:employees " +
+        "return " +
+        "&lt;zip-list> " +
+            "{for $z in $e/xq:employee/xq:address/xq:zip " +
+            "return $z} " +
+        "&lt;/zip-list>";
+
+    // Execute the query. Results will be copies of the XML queried against,
+    // stored as members of an XmlObject array.
+    XmlObject[] results = 
+        empDoc.execQuery(namespaceDeclaration + queryExpression);
+
+    // Print the results.
+    if (results.length > 0)
+    {
+        hasResults = true;
+        System.out.println("The query results: \n");
+        System.out.println(results[0].toString() + "\n");
+    }
+    return hasResults;
+}</pre>
+  <h3>Calling  XmlCursor.execQuery</h3>
+</div>
+
+<div>
+  <p>Unlike the <code>selectPath</code> method called from a cursor, the <span class="langinline">execQuery</span> method doesn't return <code>void</code>. Instead it returns an <span class="langinline">XmlCursor</span> instance positioned at the beginning of a new XML document representing
+    the query results. Rather than accessing results as selections, you use the cursor to move through the results in typical cursor fashion (for more information, see <a href="conNavigatingXMLwithCursors.html">Navigating
+    XML with Cursors</a>). The models are very different.</p>
+  <p>As always, you can cast the results to a type generated from schema if you know that the results conform to that type.</p>
+  <p>The following example retrieves work <code>&lt;phone&gt;</code> elements from the incoming XML, then changes the number in the results.</p>
+   <pre>public boolean updateWorkPhone(XmlObject empDoc)
+{
+    boolean hasResults = false;
+      
+    // A cursor instance to query with.
+    XmlCursor empCursor = empDoc.newCursor();
+    empCursor.toNextToken();
+
+    // The expression: Get the <employee> elements with <state> elements whose
+    // value is "WA".
+    String queryExpression =
+        "for $e in $this/xq:employees/xq:employee " +
+        "let $s := $e/xq:address/xq:state " +
+        "where $s = 'WA' " +
+        "return $e//xq:phone[@location='work']";
+
+    // Execute the query. Results, if any, will be available at 
+    // the position of the resultCursor in a new XML document.
+    XmlCursor resultCursor = 
+        empCursor.execQuery(namespaceDeclaration + queryExpression);
+    
+    System.out.println("The query results, element copies made " +
+		"from the received document: \n");
+    System.out.println(resultCursor.getObject().toString() + "\n");
+        
+    // If there are results, the results will be children of the fragment root
+    // where the new cursor is positioned. This statement tests for children
+    // and moves the cursor if to the first if it exists.
+    if (resultCursor.toFirstChild())
+    {
+        hasResults = true;
+        // Use the cursor to loop through the results, printing each sibling
+        // <employee>element returned by the query.
+        int i = 0;
+	    do 
+	    {
+	        // Change the phone numbers.
+            XmlCursor editCursor = resultCursor.newCursor();
+	        editCursor.toLastAttribute();
+	        editCursor.toNextToken();
+	        editCursor.removeXml();
+	        editCursor.insertChars("(206)555-1234");
+	    } while (resultCursor.toNextSibling());
+
+	    resultCursor.toStartDoc();
+	    System.out.println("The query results after changes: \n");
+	    System.out.println(resultCursor.getObject().toString() + "\n");
+
+    	System.out.println("The received document -- note that it is unchanged. " +
+            "Changes were made to the copy created by the execQuery method. \n");
+    	System.out.println(empDoc + "\n");
+    }
+    return hasResults;
+}</pre>
+   <h2>Related Topics</h2>
+</div>
+<p><a href="conGettingStartedwithXMLBeans.html">Getting Started with XMLBeans</a></p>
+<!-- InstanceEndEditable -->
+<script language="JavaScript">
+
+</script>
+</body>
+</html>

Added: xmlbeans/site/build/site/docs/2.0.0/guide/conValidationWithXmlBeans.html
URL: http://svn.apache.org/viewcvs/xmlbeans/site/build/site/docs/2.0.0/guide/conValidationWithXmlBeans.html?rev=209780&view=auto
==============================================================================
--- xmlbeans/site/build/site/docs/2.0.0/guide/conValidationWithXmlBeans.html (added)
+++ xmlbeans/site/build/site/docs/2.0.0/guide/conValidationWithXmlBeans.html Fri Jul  8 07:10:29 2005
@@ -0,0 +1 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- Copyright 2004 The Apache Software Foundation

     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.
     You may obtain a copy of the License at

         http://www.apache.org/licenses/LICENSE-2.0

     Unless required by applicable law or agreed to in writing, software
     distributed under the License is distributed on an "AS IS" BASIS,
     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     See the License for the specific language governing permissions and
     limitations under the License. -->
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- InstanceBeginEditable name="doctitle" -->
<title>XMLBeans Tools</title>
<!-- InstanceEndEditable -->
<!--(Meta)==========================================================-->
<meta http-eq
 uiv=Content-Type content="text/html; charset=iso-8859-1">
<!-- InstanceBeginEditable name="metatags" -->
<meta name="author" content="your name" />
<meta name="Description" content="A description of the topic contents." />
<meta name="Keywords" content="keywords to help in searches" />
<meta name="date last modified" content="10/25/02" />
<!-- InstanceEndEditable -->
<!--(Links)=========================================================-->
<!-- InstanceBeginEditable name="head" -->
<link href="../xmlbeans.css" rel="stylesheet" type="text/css" />
<!-- InstanceEndEditable -->
<link href="../xmlbeans.css" rel="stylesheet" type="text/css">
<script language="JavaScript" src="../../../core/topicInfo.js"></script>
<script language="JavaScript" src="../../../core/CookieClass.js"></script>
<script language="JavaScript" src="../../../core/displayContent.js"></script>
</head>
<!--(Body)==========================================================-->
<body>
<script language="JavaScript">

</
 script>
<!-- InstanceBeginEditable name="body" -->
<h1> Validation with XMLBeans </h1>
<p>An essential part of schema-related work is validating instances based on the schema. XMLBeans provides a number of ways for you to ensure your instances are valid, both at the command line and programmatically at run time. </p>
<h2>Validation, XMLBeans-Style</h2>
<p>XMLBeans' schema-oriented approach to handling XML makes validation an important part of its work. However, XMLBeans has a specific approach to validation that's helpful to keep in mind when you're working.</p>
<p>Validation features include the following: </p>
<ul>
    <li>Generally, XMLBeans validates when you ask it to. It <a href="#no_parsing_validation">doesn't validate while parsing</a> -- nor, by default, while your code is updating the bound instance along the way through, say, set* methods (although you can change this behavior).</li>
    <li>You can <a href="#validation_apis">validate programmatically</a> or by us
 ing one of the <a href="#command_line_validation">command-line tools</a> provided by XMLBeans. </li>
    <li>The <code>validate</code> methods return <code>true</code> or <code>false</code> to indicate whether the instance is valid. You can also <a href="#retrieving_error_messages">capture error information</a> if you want to when validating programmatically. To do this, you specify an error listener.</li>
    <li>You can tell XMLBeans at parse time that it <a href="#validation_as_you_go">should validate during calls to set* methods</a>. Note that this means validation <em>after</em> parsing, not during, and that it can slow performance. Also note validation would not occur as changes are made by a cursor.</li>
    <li>XMLBeans does validate <em>schema</em> when compiling the schema through scomp or the xmlbean Ant task. (When you're compiling schema programmatically, you can disable validation with the <code>XmlOptions.setCompileNoValidation</code> method.)</li>
</ul>
<h2>X
 MLBeans Validates Only When You Ask It To &#8212; Generally</h2>
<p>Given XMLBeans' focus on schema-oriented work, it's natural to assume that it might check up on you as your code is making changes to an instance &#8212; that it might prevent your code from doing something that would render the instance invalid along the way. But, by default, it doesn't. The design of XMLBeans assumes that an XML instance might go through multiple invalid states before changes are complete. As a result, generally speaking, XMLBeans keeps quiet while changes are occurring.</p>
<blockquote>
    <p><span class="notepara"><strong>Note:</strong> The exception to this rule is that XMLBeans validates your schema when you're compiling it using scomp or the xmlbean Ant task.</span></p>
</blockquote>
<h3><a name="no_parsing_validation" id="no_parsing_validation"></a>XMLBeans Does Not Validate an Instance While Parsing It</h3>
<p>But it's not hard to get the impression that it does. For example, imagi
 ne that you're parsing an XML instance using a statement such as the following:</p>
<blockquote>
    <pre>MyXmlSchemaType myXmlBean = MyXmlSchemaType.Factory.parse(myXml);</pre>
</blockquote>
<p>If the namespace declared in the myXml instance doesn't match the target namespace of the schema from which MyXmlSchemaType was generated, parsing will fail with an error message. Likewise, you'll get messages for other mismatches between the shape of myXml and the XML shape described by the schema.</p>
<p>But these failures and messages don't result from validation. Instead, all XMLBeans is doing is a not-very-deep check to see if the instance <em>shouldn't be bound</em> to the XMLBeans type generated from schema. In other words, the checking done at the parsing stage is simply a &quot;low bar&quot; effort to avoid trouble down the road.</p>
<p>Validation, on the other hand, is designed to verify that the instance conforms completely to the schema.</p>
<p>So you can validate in any 
 of three ways:</p>
<ul>
    <li>On request, using a validate method.</li>
    <li>On the fly, using the &quot;validate on set&quot; option.</li>
    <li>Using one of the command-line tools. </li>
</ul>
<h2>Tools for Validating</h2>
<p>XMLBeans tools for validation include command-line tools and APIs. </p>
<h3><a name="command_line_validation" id="command_line_validation"></a>Command-line Tools for Validation </h3>
<p>Among the many <a href="tools.html">command-line tools</a> XMLBeans provides, you'll find two that are specifically for validation. </p>
<ul>
    <li><a href="tools.html#validate">validate</a> tool &#8212; A validation command-line tool
in which you specify the instance to validate and the schema to validate it against.
        <p>You'll find the <code>validate</code> tool in the bin directory of your XMLBeans installation. </p>
    </li>
    <li><a href="tools.html#svalidate">svalidate</a> tool &#8212; Identical to the validate tool, except that svalidate uses 
 a streaming model that supports validation against much larger schemas.
        <p>You'll find the <code>svalidate</code> tool in the bin directory of your XMLBeans installation. </p>
    </li>
</ul>
<h3><a name="validation_apis" id="validation_apis"></a>APIs for Validation </h3>
<p>XMLBeans APIs provide ways for you to <a href="#validation_when_you_ask">validate on request</a> &#8212; say, after your code has finished editing an instance and before it passes the instance elsewhere. You can also specify that your calls to set* methods should <a href="#validation_as_you_go">validate on-the-fly</a> the instance that is being edited; you do this as an option when your code creates the XMLBeans schema type instance.</p>
<h4><a name="validation_when_you_ask" id="validation_when_you_ask"></a>Validation When You Ask for It</h4>
<p>Both the <code>validate</code> methods described here are available from any XMLBeans type generated from schema during schema compilation (because all s
 uch types inherit from <code>XmlObject</code>). Both methods are designed to validate the instance that is bound to the type from which the method is called. For example, if your schema defines a <code>&lt;purchase-order&gt;</code> element with <code>&lt;item&gt;</code> children, calling the <code>myItem.validate()</code> method will validate the <code>&lt;item&gt;</code> instance bound to <code>Item</code>. This includes the <code>&lt;item&gt;</code> element's children, but not the <code>&lt;purchase-order&gt;</code> element or the <code>&lt;item&gt;</code> element's siblings.</p>
<p>Both methods return a <code>boolean</code> to indicate validity, and one of the methods lets you specify options for validation, such as capturing messages about why an invalid instance is invalid.</p>
<ul>
    <li><code>XmlObject.validate()</code> &#8212; Returns <code>true</code> if the instance is valid.</li>
    <li><code>XmlObject.validate(XmlOptions)</code> &#8212; Returns <code>true</cod
 e> if the instance is valid, using the specified <code>XmlOptions</code> instance to customize validation.
        <p>In particular, you can use the <code>XmlOptions.setErrorListener</code> method to specify a <code>Collection</code> instance with which to capture messages pertaining to invalid instances. For an example, see the Javadoc for this method. </p>
        <p>Through the <code>XmlOptions</code> class, you can specify options to use during validation. The options include the following: </p>
    </li>
    <li>XmlOptions.setErrorListener -- Specifies a Collection instance that XMLBeans should use to store errors that occur during validation (or, in other contexts, during parsing and compilation). </li>
    <li>XmlOptions.setValidateTreatLaxAsSkip -- Tells XMLBeans that it should skip elements matching an particle with contentModel=&quot;lax&quot; during validation. </li>
</ul>
<p>Also, see the <a href="#validation_as_you_go">section on validating as you go</a> for inf
 ormation about using the <code>XmlOptions.setValidateOnSet</code> method.</p>
<h3><a name="retrieving_error_messages" id="retrieving_error_messages"></a>Retrieving Error Messages About Invalid XML</h3>
<p>When you'll be validating with one of the <code>validate</code> methods, you can specify a <code>java.util.Collection</code> implementation as an error listener. As validation occurs, errors are added to the listener. After validation (and if the instance is found to be invalid) you can examine the errors. Here's an example:</p>
<pre>// Set up the validation error listener.
ArrayList validationErrors = new ArrayList();
XmlOptions validationOptions = new XmlOptions();
validationOptions.setErrorListener(validationErrors);

MyDocument myDoc = MyDocument.Factory.parse(pathToXml);

// Do some editing to myDoc.

// During validation, errors are added to the ArrayList for
// retrieval and printing by the printErrors method.
boolean isValid = myDoc.validate(validationOptions);

// 
 Print the errors if the XML is invalid.
if (!isValid)
{
    Iterator iter = validationErrors.iterator();
    while (iter.hasNext())
    {
        System.out.println(">> " + iter.next() + "\n");
    }
}</pre>
<h3><a name="validation_as_you_go" id="validation_as_you_go"></a>Validation As You Go</h3>
<p>By default, an XML instance will not be validated at run time as your code makes changes. However, you can change this behavior for limited on-the-fly validation. To do this, you specify the &quot;validate on set&quot; option when you create the XMLBeans type instance &#8212; you do this with the <code>XmlOptions.setValidateOnSet</code> method. </p>
<p>When you specify this option, XMLBeans with throw an exception when your code invalidates the XML through a set* method. Note that you can't specify an error listener for use in conjunction with this means of validating. Also, with &quot;validate on set,&quot; only simple schema types will be validated. Schema types not validated 
 by this approach include, for example, those defining elements with attributes or elements with children.</p>
<p>Because its functionality is limited to simple schema types and it validates for set* method calls, you should regard this validation approach as a debugging tool, rather than an alternative to using a <code>validate</code> method. For example, you might use it to determine which errant bit of code is creating an invalid chunk of XML.</p>
<p class="notepara"><strong>Note:</strong> This sort of validation is not supported during changes you make using an <code>XmlCursor</code> instance.</p>
<p>Among the methods you can use to create an XMLBeans instance &#8212; the <code>parse</code> methods and the <code>newInstance</code> method &#8212; you'll find versions that take an <code>XmlOptions</code> instance as a parameter. Specifying this option would look something like the following: </p>
<pre>XmlOptions validateOptions = new XmlOptions();

// Tell XMLBeans you want
  to validate on the fly.
validateOptions.setValidateOnSet();
// Create the new instance, specifying the option.
PurchaseOrder newPo = PurchaseOrder.Factory.newInstance(validateOptions);

// ... Code to edit the instance via get and set methods ... </pre>
<div>
    <p class="relatedtopics"> Related Topics </p>
    <p> <a href="conGettingStartedwithXMLBeans.html">Getting Started with XMLBeans</a> </p>
</div>
<!-- InstanceEndEditable -->
<script language="JavaScript">

</script>
</body>
</html>
\ No newline at end of file

Modified: xmlbeans/site/build/site/docs/2.0.0/guide/tools.html
URL: http://svn.apache.org/viewcvs/xmlbeans/site/build/site/docs/2.0.0/guide/tools.html?rev=209780&r1=209779&r2=209780&view=diff
==============================================================================
--- xmlbeans/site/build/site/docs/2.0.0/guide/tools.html (original)
+++ xmlbeans/site/build/site/docs/2.0.0/guide/tools.html Fri Jul  8 07:10:29 2005
@@ -376,7 +376,7 @@
 <h2> <a name="svalidate"></a>svalidate (Streaming Instance Validator) </h2>
 <p> Validates the specified instance against the specified schema. Unlike the 
   <a href="#validate">validate</a> tool, svalidate uses a streaming model through 
-  which you can validate very large documentation with less memory (if the schema 
+  which you can validate much larger instances with less memory (if the schema 
   permits it).</p>
 <h3> Syntax </h3>
 <pre><strong>svalidate</strong> [<em>options</em>] <em>schema.xsd</em> <em>instance.xml</em></pre>

Modified: xmlbeans/site/build/site/documentation/index.html
URL: http://svn.apache.org/viewcvs/xmlbeans/site/build/site/documentation/index.html?rev=209780&r1=209779&r2=209780&view=diff
==============================================================================
--- xmlbeans/site/build/site/documentation/index.html (original)
+++ xmlbeans/site/build/site/documentation/index.html Fri Jul  8 07:10:29 2005
@@ -292,6 +292,12 @@
                 
 <li>
                   
+<a href="../docs/2.0.0/guide/conValidationWithXmlBeans.html">Validation with XMLBeans</a>
+                
+</li>
+                
+<li>
+                  
 <a href="../docs/2.0.0/guide/conNavigatingXMLwithCursors.html">Navigating XML with XMLCursor</a>
                 
 </li>
@@ -324,14 +330,26 @@
                 
 <li>
                   
-<a href="../docs/2.0.0/guide/antXmlbean.html">XMLBean Ant Task</a>
+<a href="../docs/2.0.0/guide/conHandlingAny.html">Handling xs:any with the XMLBeans API</a>
+                
+</li>
+                
+<li>
+                  
+<a href="../docs/2.0.0/guide/tools.html">XMLBeans Tools</a>
+                
+</li>
+                
+<li>
+                  
+<a href="../docs/2.0.0/guide/antXmlbean.html">xmlbean Ant Task</a>
                 
 </li>
             
 </ul>
 </div>
         
-<a name="N10086"></a><a name="XMLBeans+JavaDoc"></a>
+<a name="N1009B"></a><a name="XMLBeans+JavaDoc"></a>
 <h3>XMLBeans JavaDoc</h3>
 <div style="margin-left: 0 ; border: 2px">
 <ul>
@@ -351,7 +369,7 @@
 </ul>
 </div>
         
-<a name="N1009E"></a><a name="Wiki+Pages"></a>
+<a name="N100B3"></a><a name="Wiki+Pages"></a>
 <h3>Wiki Pages</h3>
 <div style="margin-left: 0 ; border: 2px">
 <p>Have an idea for a sample you'd like to see? Looking for ideas for a sample you'd

Modified: xmlbeans/site/build/site/documentation/index.pdf
URL: http://svn.apache.org/viewcvs/xmlbeans/site/build/site/documentation/index.pdf?rev=209780&r1=209779&r2=209780&view=diff
==============================================================================
Binary files - no diff available.



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xmlbeans.apache.org
For additional commands, e-mail: commits-help@xmlbeans.apache.org


Mime
View raw message