| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc on Thu Sep 25 16:46:56 PDT 2003 --> |
| <TITLE> |
| SchemaParticle (XMLBeans Documentation) |
| </TITLE> |
| <META NAME="keywords" CONTENT="org.apache.xmlbeans.SchemaParticle,SchemaParticle interface"> |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> |
| </HEAD> |
| <SCRIPT> |
| function asd() |
| { |
| parent.document.title="SchemaParticle (XMLBeans Documentation)"; |
| } |
| </SCRIPT> |
| <BODY BGCOLOR="white" onload="asd();"> |
| |
| <!-- ========== START OF NAVBAR ========== --> |
| <A NAME="navbar_top"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> |
| <TR> |
| <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../org/apache/xmlbeans/SchemaModelGroup.html"><B>PREV CLASS</B></A> |
| <A HREF="../../../org/apache/xmlbeans/SchemaProperty.html"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| <A HREF="SchemaParticle.html" TARGET="_top"><B>NO FRAMES</B></A> |
| |
| <SCRIPT> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A> |
| </NOSCRIPT> |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.xmlbeans</FONT> |
| <BR> |
| Interface SchemaParticle</H2> |
| <HR> |
| <DL> |
| <DT>public interface <B>SchemaParticle</B></DL> |
| |
| <P> |
| Represents a Schema particle definition. |
| <p> |
| The content model of a complex type is a tree of particles. Each |
| particle is either an <A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#ALL"><CODE>ALL</CODE></A>, <A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#CHOICE"><CODE>CHOICE</CODE></A>, <A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#SEQUENCE"><CODE>SEQUENCE</CODE></A>, |
| <A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#ELEMENT"><CODE>ELEMENT</CODE></A>, or <A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#WILDCARD"><CODE>WILDCARD</CODE></A>. |
| All, choice and sequence particles are groups that can have child |
| particles; elements and wildcards are always leaves of the particle tree. |
| <p> |
| The tree of particles available on a schema type is minimized, that |
| is, it already has removed "pointless" particles such as empty |
| sequences, nonrepeating sequences with only one item, and so on. |
| (<a target="_blank" href="http://www.w3.org/TR/xmlschema-1/#cos-particle-restrict">Pointless particles</a> |
| are defined precisely in the XML Schema specification.) |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../org/apache/xmlbeans/SchemaType.html#getContentModel()"><CODE>SchemaType.getContentModel()</CODE></A></DL> |
| <HR> |
| |
| <P> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| |
| |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#ALL">ALL</A></B></CODE> |
| |
| <BR> |
| An <a target="_blank" href="http://www.w3.org/TR/xmlschema-1/#declare-contentModel">xs:all</a> group.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#CHOICE">CHOICE</A></B></CODE> |
| |
| <BR> |
| A <a target="_blank" href="http://www.w3.org/TR/xmlschema-1/#declare-contentModel">xs:choice</a> group.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#ELEMENT">ELEMENT</A></B></CODE> |
| |
| <BR> |
| An <a target="_blank" href="http://www.w3.org/TR/xmlschema-1/#declare-element">xs:element</a> particle.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#LAX">LAX</A></B></CODE> |
| |
| <BR> |
| <a target="_blank" href="http://www.w3.org/TR/xmlschema-1/#Wildcard_details">Lax wildcard</a> processing.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#SEQUENCE">SEQUENCE</A></B></CODE> |
| |
| <BR> |
| A <a target="_blank" href="http://www.w3.org/TR/xmlschema-1/#declare-contentModel">xs:sequence</a> group.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#SKIP">SKIP</A></B></CODE> |
| |
| <BR> |
| <a target="_blank" href="http://www.w3.org/TR/xmlschema-1/#Wildcard_details">Skip wildcard</a> processing.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#STRICT">STRICT</A></B></CODE> |
| |
| <BR> |
| <a target="_blank" href="http://www.w3.org/TR/xmlschema-1/#Wildcard_details">Strict wildcard</a> processing.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#WILDCARD">WILDCARD</A></B></CODE> |
| |
| <BR> |
| An <a target="_blank" href="http://www.w3.org/TR/xmlschema-1/#declare-openness">xs:any</a> particle, |
| also known as an element wildcard.</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../org/apache/xmlbeans/QNameSet.html">QNameSet</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#acceptedStartNames()">acceptedStartNames</A></B>()</CODE> |
| |
| <BR> |
| Returns the QNameSet of element names that can be |
| accepted at the beginning of this particle.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#canStartWithElement(javax.xml.namespace.QName)">canStartWithElement</A></B>(<A HREF="http://java.sun.com/j2ee/1.4/docs/api/javax/xml/namespace/QName.html">QName</A> name)</CODE> |
| |
| <BR> |
| True if this particle can start with the given element |
| (taking into account the structure of all child particles |
| of course).</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#countOfParticleChild()">countOfParticleChild</A></B>()</CODE> |
| |
| <BR> |
| The number of children.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#getDefaultText()">getDefaultText</A></B>()</CODE> |
| |
| <BR> |
| For elements only: returns the default (or fixed) text value</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../org/apache/xmlbeans/XmlAnySimpleType.html">XmlAnySimpleType</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#getDefaultValue()">getDefaultValue</A></B>()</CODE> |
| |
| <BR> |
| For elements only: returns the default (or fixed) strongly-typed value</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#getIntMaxOccurs()">getIntMaxOccurs</A></B>()</CODE> |
| |
| <BR> |
| Returns the maxOccurs value, pegged to a 32-bit int for |
| convenience of a validating state machine that doesn't count |
| higher than MAX_INT anyway.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#getIntMinOccurs()">getIntMinOccurs</A></B>()</CODE> |
| |
| <BR> |
| Returns the minOccurs value, pegged to a 32-bit int for |
| convenience of a validating state machine that doesn't count |
| higher than MAX_INT anyway.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/math/BigInteger.html">BigInteger</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#getMaxOccurs()">getMaxOccurs</A></B>()</CODE> |
| |
| <BR> |
| Returns the maxOccurs value for this particle, or null if it |
| is unbounded.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/math/BigInteger.html">BigInteger</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#getMinOccurs()">getMinOccurs</A></B>()</CODE> |
| |
| <BR> |
| Returns the minOccurs value for this particle.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2ee/1.4/docs/api/javax/xml/namespace/QName.html">QName</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#getName()">getName</A></B>()</CODE> |
| |
| <BR> |
| For elements only: the QName for the element use.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../org/apache/xmlbeans/SchemaParticle.html">SchemaParticle</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#getParticleChild(int)">getParticleChild</A></B>(int i)</CODE> |
| |
| <BR> |
| Another way to access the particle children.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../org/apache/xmlbeans/SchemaParticle.html">SchemaParticle</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#getParticleChildren()">getParticleChildren</A></B>()</CODE> |
| |
| <BR> |
| Applies to sequence, choice, and all particles only: returns an array |
| of all the particle children in order.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#getParticleType()">getParticleType</A></B>()</CODE> |
| |
| <BR> |
| Returns the particle type (<A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#ALL"><CODE>ALL</CODE></A>, <A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#CHOICE"><CODE>CHOICE</CODE></A>, |
| <A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#SEQUENCE"><CODE>SEQUENCE</CODE></A>, <A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#ELEMENT"><CODE>ELEMENT</CODE></A>, or <A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#WILDCARD"><CODE>WILDCARD</CODE></A>).</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../org/apache/xmlbeans/SchemaType.html">SchemaType</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#getType()">getType</A></B>()</CODE> |
| |
| <BR> |
| For elements only: returns the type of the element.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#getWildcardProcess()">getWildcardProcess</A></B>()</CODE> |
| |
| <BR> |
| For wildcards, returns the processing code (<A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#STRICT"><CODE>STRICT</CODE></A>, <A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#LAX"><CODE>LAX</CODE></A>, <A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#SKIP"><CODE>SKIP</CODE></A>).</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../org/apache/xmlbeans/QNameSet.html">QNameSet</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#getWildcardSet()">getWildcardSet</A></B>()</CODE> |
| |
| <BR> |
| For wildcards, returns a QNameSet representing the wildcard.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#isDefault()">isDefault</A></B>()</CODE> |
| |
| <BR> |
| For elements only: True if has default.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#isFixed()">isFixed</A></B>()</CODE> |
| |
| <BR> |
| For elements only: true if is fixed value.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#isNillable()">isNillable</A></B>()</CODE> |
| |
| <BR> |
| For elements only: true if nillable.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#isSingleton()">isSingleton</A></B>()</CODE> |
| |
| <BR> |
| One if minOccurs == maxOccurs == 1.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#isSkippable()">isSkippable</A></B>()</CODE> |
| |
| <BR> |
| True if this particle can be skipped (taking into account |
| both the minOcurs as well as the structure of all the |
| child particles)</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Field Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="ALL"><!-- --></A><H3> |
| ALL</H3> |
| <PRE> |
| public static final int <B>ALL</B></PRE> |
| <DL> |
| <DD>An <a target="_blank" href="http://www.w3.org/TR/xmlschema-1/#declare-contentModel">xs:all</a> group. |
| See <A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#getParticleType()"><CODE>getParticleType()</CODE></A>. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.xmlbeans.SchemaParticle.ALL">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="CHOICE"><!-- --></A><H3> |
| CHOICE</H3> |
| <PRE> |
| public static final int <B>CHOICE</B></PRE> |
| <DL> |
| <DD>A <a target="_blank" href="http://www.w3.org/TR/xmlschema-1/#declare-contentModel">xs:choice</a> group. |
| See <A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#getParticleType()"><CODE>getParticleType()</CODE></A>. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.xmlbeans.SchemaParticle.CHOICE">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="SEQUENCE"><!-- --></A><H3> |
| SEQUENCE</H3> |
| <PRE> |
| public static final int <B>SEQUENCE</B></PRE> |
| <DL> |
| <DD>A <a target="_blank" href="http://www.w3.org/TR/xmlschema-1/#declare-contentModel">xs:sequence</a> group. |
| See <A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#getParticleType()"><CODE>getParticleType()</CODE></A>. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.xmlbeans.SchemaParticle.SEQUENCE">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="ELEMENT"><!-- --></A><H3> |
| ELEMENT</H3> |
| <PRE> |
| public static final int <B>ELEMENT</B></PRE> |
| <DL> |
| <DD>An <a target="_blank" href="http://www.w3.org/TR/xmlschema-1/#declare-element">xs:element</a> particle. |
| This code means the particle can be coerced to <A HREF="../../../org/apache/xmlbeans/SchemaLocalElement.html"><CODE>SchemaLocalElement</CODE></A>. |
| See <A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#getParticleType()"><CODE>getParticleType()</CODE></A>. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.xmlbeans.SchemaParticle.ELEMENT">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="WILDCARD"><!-- --></A><H3> |
| WILDCARD</H3> |
| <PRE> |
| public static final int <B>WILDCARD</B></PRE> |
| <DL> |
| <DD>An <a target="_blank" href="http://www.w3.org/TR/xmlschema-1/#declare-openness">xs:any</a> particle, |
| also known as an element wildcard. |
| See <A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#getParticleType()"><CODE>getParticleType()</CODE></A>. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.xmlbeans.SchemaParticle.WILDCARD">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="STRICT"><!-- --></A><H3> |
| STRICT</H3> |
| <PRE> |
| public static final int <B>STRICT</B></PRE> |
| <DL> |
| <DD><a target="_blank" href="http://www.w3.org/TR/xmlschema-1/#Wildcard_details">Strict wildcard</a> processing. See <A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#getWildcardProcess()"><CODE>getWildcardProcess()</CODE></A> |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.xmlbeans.SchemaParticle.STRICT">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="LAX"><!-- --></A><H3> |
| LAX</H3> |
| <PRE> |
| public static final int <B>LAX</B></PRE> |
| <DL> |
| <DD><a target="_blank" href="http://www.w3.org/TR/xmlschema-1/#Wildcard_details">Lax wildcard</a> processing. See <A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#getWildcardProcess()"><CODE>getWildcardProcess()</CODE></A> |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.xmlbeans.SchemaParticle.LAX">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="SKIP"><!-- --></A><H3> |
| SKIP</H3> |
| <PRE> |
| public static final int <B>SKIP</B></PRE> |
| <DL> |
| <DD><a target="_blank" href="http://www.w3.org/TR/xmlschema-1/#Wildcard_details">Skip wildcard</a> processing. See <A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#getWildcardProcess()"><CODE>getWildcardProcess()</CODE></A> |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.xmlbeans.SchemaParticle.SKIP">Constant Field Values</A></DL> |
| </DL> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="getParticleType()"><!-- --></A><H3> |
| getParticleType</H3> |
| <PRE> |
| public int <B>getParticleType</B>()</PRE> |
| <DL> |
| <DD>Returns the particle type (<A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#ALL"><CODE>ALL</CODE></A>, <A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#CHOICE"><CODE>CHOICE</CODE></A>, |
| <A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#SEQUENCE"><CODE>SEQUENCE</CODE></A>, <A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#ELEMENT"><CODE>ELEMENT</CODE></A>, or <A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#WILDCARD"><CODE>WILDCARD</CODE></A>). |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMinOccurs()"><!-- --></A><H3> |
| getMinOccurs</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/math/BigInteger.html">BigInteger</A> <B>getMinOccurs</B>()</PRE> |
| <DL> |
| <DD>Returns the minOccurs value for this particle. |
| If it's not specified explicitly, this returns BigInteger.ONE. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMaxOccurs()"><!-- --></A><H3> |
| getMaxOccurs</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/math/BigInteger.html">BigInteger</A> <B>getMaxOccurs</B>()</PRE> |
| <DL> |
| <DD>Returns the maxOccurs value for this particle, or null if it |
| is unbounded. |
| If it's not specified explicitly, this returns BigInteger.ONE. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getIntMinOccurs()"><!-- --></A><H3> |
| getIntMinOccurs</H3> |
| <PRE> |
| public int <B>getIntMinOccurs</B>()</PRE> |
| <DL> |
| <DD>Returns the minOccurs value, pegged to a 32-bit int for |
| convenience of a validating state machine that doesn't count |
| higher than MAX_INT anyway. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getIntMaxOccurs()"><!-- --></A><H3> |
| getIntMaxOccurs</H3> |
| <PRE> |
| public int <B>getIntMaxOccurs</B>()</PRE> |
| <DL> |
| <DD>Returns the maxOccurs value, pegged to a 32-bit int for |
| convenience of a validating state machine that doesn't count |
| higher than MAX_INT anyway. Unbounded is given as MAX_INT. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isSingleton()"><!-- --></A><H3> |
| isSingleton</H3> |
| <PRE> |
| public boolean <B>isSingleton</B>()</PRE> |
| <DL> |
| <DD>One if minOccurs == maxOccurs == 1. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getParticleChildren()"><!-- --></A><H3> |
| getParticleChildren</H3> |
| <PRE> |
| public <A HREF="../../../org/apache/xmlbeans/SchemaParticle.html">SchemaParticle</A>[] <B>getParticleChildren</B>()</PRE> |
| <DL> |
| <DD>Applies to sequence, choice, and all particles only: returns an array |
| of all the particle children in order. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getParticleChild(int)"><!-- --></A><H3> |
| getParticleChild</H3> |
| <PRE> |
| public <A HREF="../../../org/apache/xmlbeans/SchemaParticle.html">SchemaParticle</A> <B>getParticleChild</B>(int i)</PRE> |
| <DL> |
| <DD>Another way to access the particle children. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="countOfParticleChild()"><!-- --></A><H3> |
| countOfParticleChild</H3> |
| <PRE> |
| public int <B>countOfParticleChild</B>()</PRE> |
| <DL> |
| <DD>The number of children. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="canStartWithElement(javax.xml.namespace.QName)"><!-- --></A><H3> |
| canStartWithElement</H3> |
| <PRE> |
| public boolean <B>canStartWithElement</B>(<A HREF="http://java.sun.com/j2ee/1.4/docs/api/javax/xml/namespace/QName.html">QName</A> name)</PRE> |
| <DL> |
| <DD>True if this particle can start with the given element |
| (taking into account the structure of all child particles |
| of course). |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="acceptedStartNames()"><!-- --></A><H3> |
| acceptedStartNames</H3> |
| <PRE> |
| public <A HREF="../../../org/apache/xmlbeans/QNameSet.html">QNameSet</A> <B>acceptedStartNames</B>()</PRE> |
| <DL> |
| <DD>Returns the QNameSet of element names that can be |
| accepted at the beginning of this particle. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isSkippable()"><!-- --></A><H3> |
| isSkippable</H3> |
| <PRE> |
| public boolean <B>isSkippable</B>()</PRE> |
| <DL> |
| <DD>True if this particle can be skipped (taking into account |
| both the minOcurs as well as the structure of all the |
| child particles) |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getWildcardSet()"><!-- --></A><H3> |
| getWildcardSet</H3> |
| <PRE> |
| public <A HREF="../../../org/apache/xmlbeans/QNameSet.html">QNameSet</A> <B>getWildcardSet</B>()</PRE> |
| <DL> |
| <DD>For wildcards, returns a QNameSet representing the wildcard. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getWildcardProcess()"><!-- --></A><H3> |
| getWildcardProcess</H3> |
| <PRE> |
| public int <B>getWildcardProcess</B>()</PRE> |
| <DL> |
| <DD>For wildcards, returns the processing code (<A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#STRICT"><CODE>STRICT</CODE></A>, <A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#LAX"><CODE>LAX</CODE></A>, <A HREF="../../../org/apache/xmlbeans/SchemaParticle.html#SKIP"><CODE>SKIP</CODE></A>). |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getName()"><!-- --></A><H3> |
| getName</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2ee/1.4/docs/api/javax/xml/namespace/QName.html">QName</A> <B>getName</B>()</PRE> |
| <DL> |
| <DD>For elements only: the QName for the element use. |
| May be unqualified version of referenced element's name. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getType()"><!-- --></A><H3> |
| getType</H3> |
| <PRE> |
| public <A HREF="../../../org/apache/xmlbeans/SchemaType.html">SchemaType</A> <B>getType</B>()</PRE> |
| <DL> |
| <DD>For elements only: returns the type of the element. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isNillable()"><!-- --></A><H3> |
| isNillable</H3> |
| <PRE> |
| public boolean <B>isNillable</B>()</PRE> |
| <DL> |
| <DD>For elements only: true if nillable. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDefaultText()"><!-- --></A><H3> |
| getDefaultText</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</A> <B>getDefaultText</B>()</PRE> |
| <DL> |
| <DD>For elements only: returns the default (or fixed) text value |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDefaultValue()"><!-- --></A><H3> |
| getDefaultValue</H3> |
| <PRE> |
| public <A HREF="../../../org/apache/xmlbeans/XmlAnySimpleType.html">XmlAnySimpleType</A> <B>getDefaultValue</B>()</PRE> |
| <DL> |
| <DD>For elements only: returns the default (or fixed) strongly-typed value |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isDefault()"><!-- --></A><H3> |
| isDefault</H3> |
| <PRE> |
| public boolean <B>isDefault</B>()</PRE> |
| <DL> |
| <DD>For elements only: True if has default. If isFixed, then isDefault is always true. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isFixed()"><!-- --></A><H3> |
| isFixed</H3> |
| <PRE> |
| public boolean <B>isFixed</B>()</PRE> |
| <DL> |
| <DD>For elements only: true if is fixed value. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| <!-- ========== START OF NAVBAR ========== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> |
| <TR> |
| <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../org/apache/xmlbeans/SchemaModelGroup.html"><B>PREV CLASS</B></A> |
| <A HREF="../../../org/apache/xmlbeans/SchemaProperty.html"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| <A HREF="SchemaParticle.html" TARGET="_top"><B>NO FRAMES</B></A> |
| |
| <SCRIPT> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A> |
| </NOSCRIPT> |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |
