<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!--NewPage--> <HTML> <HEAD> <!-- Generated by javadoc (build 1.6.0_18) on Sat Dec 04 05:26:39 UTC 2010 --> <TITLE> XsEDocumentation </TITLE> <META NAME="date" CONTENT="2010-12-04"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="XsEDocumentation"; } } </SCRIPT> <NOSCRIPT> </NOSCRIPT> </HEAD> <BODY BGCOLOR="white" onload="windowTitle();"> <HR> <!-- ========= START OF TOP NAVBAR ======= --> <A NAME="navbar_top"><!-- --></A> <A HREF="#skip-navbar_top" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <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/ws/jaxme/xs/xml/XsEComplexContent.html" title="interface in org.apache.ws.jaxme.xs.xml"><B>PREV CLASS</B></A> <A HREF="../../../../../../org/apache/ws/jaxme/xs/xml/XsEEnumeration.html" title="interface in org.apache.ws.jaxme.xs.xml"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../../index.html?org/apache/ws/jaxme/xs/xml/XsEDocumentation.html" target="_top"><B>FRAMES</B></A> <A HREF="XsEDocumentation.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> <FONT SIZE="-1"> org.apache.ws.jaxme.xs.xml</FONT> <BR> Interface XsEDocumentation</H2> <DL> <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../../../org/apache/ws/jaxme/xs/xml/XsObject.html" title="interface in org.apache.ws.jaxme.xs.xml">XsObject</A></DD> </DL> <DL> <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../../org/apache/ws/jaxme/xs/xml/impl/XsEDocumentationImpl.html" title="class in org.apache.ws.jaxme.xs.xml.impl">XsEDocumentationImpl</A></DD> </DL> <HR> <DL> <DT><PRE>public interface <B>XsEDocumentation</B><DT>extends <A HREF="../../../../../../org/apache/ws/jaxme/xs/xml/XsObject.html" title="interface in org.apache.ws.jaxme.xs.xml">XsObject</A></DL> </PRE> <P> <p>Interface of <code>xs:documentation</code>, as specified by the following: <pre> <xs:element name="documentation" id="documentation"> <xs:annotation> <xs:documentation source="http://www.w3.org/TR/xmlschema-1/#element-documentation"/> </xs:annotation> <xs:complexType mixed="true"> <xs:sequence minOccurs="0" maxOccurs="unbounded"> <xs:any processContents="lax"/> </xs:sequence> <xs:attribute name="source" type="xs:anyURI"/> <xs:attribute ref="xml:lang"/> </xs:complexType> </xs:element> </pre></p> <P> <P> <DL> <DT><B>Author:</B></DT> <DD><a href="mailto:joe@ispsoft.de">Jochen Wiedmann</a></DD> </DL> <HR> <P> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Method Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.Object[]</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/ws/jaxme/xs/xml/XsEDocumentation.html#getChilds()">getChilds</A></B>()</CODE> <BR> Returns the array of all child objects.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../../org/apache/ws/jaxme/xs/xml/XmlLang.html" title="class in org.apache.ws.jaxme.xs.xml">XmlLang</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/ws/jaxme/xs/xml/XsEDocumentation.html#getLang()">getLang</A></B>()</CODE> <BR> Returns the documentation elements language.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../../org/apache/ws/jaxme/xs/xml/XsAnyURI.html" title="class in org.apache.ws.jaxme.xs.xml">XsAnyURI</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/ws/jaxme/xs/xml/XsEDocumentation.html#getSource()">getSource</A></B>()</CODE> <BR> Returns the URI to read for the documentations contents.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/ws/jaxme/xs/xml/XsEDocumentation.html#getText()">getText</A></B>()</CODE> <BR> Returns the embedded text.</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/ws/jaxme/xs/xml/XsEDocumentation.html#isTextOnly()">isTextOnly</A></B>()</CODE> <BR> Returns whether the documentation is simple.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/ws/jaxme/xs/xml/XsEDocumentation.html#setLang(org.apache.ws.jaxme.xs.xml.XmlLang)">setLang</A></B>(<A HREF="../../../../../../org/apache/ws/jaxme/xs/xml/XmlLang.html" title="class in org.apache.ws.jaxme.xs.xml">XmlLang</A> pLang)</CODE> <BR> Sets the documentation elements language.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../../org/apache/ws/jaxme/xs/xml/XsEDocumentation.html#setSource(org.apache.ws.jaxme.xs.xml.XsAnyURI)">setSource</A></B>(<A HREF="../../../../../../org/apache/ws/jaxme/xs/xml/XsAnyURI.html" title="class in org.apache.ws.jaxme.xs.xml">XsAnyURI</A> pSource)</CODE> <BR> Sets the URI to read for the documentations contents.</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_org.apache.ws.jaxme.xs.xml.XsObject"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from interface org.apache.ws.jaxme.xs.xml.<A HREF="../../../../../../org/apache/ws/jaxme/xs/xml/XsObject.html" title="interface in org.apache.ws.jaxme.xs.xml">XsObject</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../../../org/apache/ws/jaxme/xs/xml/XsObject.html#getLocator()">getLocator</A>, <A HREF="../../../../../../org/apache/ws/jaxme/xs/xml/XsObject.html#getObjectFactory()">getObjectFactory</A>, <A HREF="../../../../../../org/apache/ws/jaxme/xs/xml/XsObject.html#getParentObject()">getParentObject</A>, <A HREF="../../../../../../org/apache/ws/jaxme/xs/xml/XsObject.html#getXsESchema()">getXsESchema</A>, <A HREF="../../../../../../org/apache/ws/jaxme/xs/xml/XsObject.html#isTopLevelObject()">isTopLevelObject</A>, <A HREF="../../../../../../org/apache/ws/jaxme/xs/xml/XsObject.html#validate()">validate</A></CODE></TD> </TR> </TABLE> <P> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Method Detail</B></FONT></TH> </TR> </TABLE> <A NAME="setLang(org.apache.ws.jaxme.xs.xml.XmlLang)"><!-- --></A><H3> setLang</H3> <PRE> void <B>setLang</B>(<A HREF="../../../../../../org/apache/ws/jaxme/xs/xml/XmlLang.html" title="class in org.apache.ws.jaxme.xs.xml">XmlLang</A> pLang)</PRE> <DL> <DD><p>Sets the documentation elements language. Defaults to null.</p> <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>pLang</CODE> - The language abbreviation, for example "en".</DL> </DD> </DL> <HR> <A NAME="getLang()"><!-- --></A><H3> getLang</H3> <PRE> <A HREF="../../../../../../org/apache/ws/jaxme/xs/xml/XmlLang.html" title="class in org.apache.ws.jaxme.xs.xml">XmlLang</A> <B>getLang</B>()</PRE> <DL> <DD><p>Returns the documentation elements language. Defaults to null.</p> <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>The language abbreviation, for example "en".</DL> </DD> </DL> <HR> <A NAME="setSource(org.apache.ws.jaxme.xs.xml.XsAnyURI)"><!-- --></A><H3> setSource</H3> <PRE> void <B>setSource</B>(<A HREF="../../../../../../org/apache/ws/jaxme/xs/xml/XsAnyURI.html" title="class in org.apache.ws.jaxme.xs.xml">XsAnyURI</A> pSource)</PRE> <DL> <DD><p>Sets the URI to read for the documentations contents. Defaults to null.</p> <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>pSource</CODE> - Source URI</DL> </DD> </DL> <HR> <A NAME="getSource()"><!-- --></A><H3> getSource</H3> <PRE> <A HREF="../../../../../../org/apache/ws/jaxme/xs/xml/XsAnyURI.html" title="class in org.apache.ws.jaxme.xs.xml">XsAnyURI</A> <B>getSource</B>()</PRE> <DL> <DD><p>Returns the URI to read for the documentations contents. Defaults to null.</p> <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>Source URI</DL> </DD> </DL> <HR> <A NAME="getText()"><!-- --></A><H3> getText</H3> <PRE> java.lang.String <B>getText</B>()</PRE> <DL> <DD><p>Returns the embedded text. The embedded text is specified as the concatenation of all text nodes. Child elements, if any, are ignored.</p> <P> <DD><DL> </DL> </DD> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="isTextOnly()"><!-- --></A><H3> isTextOnly</H3> <PRE> boolean <B>isTextOnly</B>()</PRE> <DL> <DD><p>Returns whether the documentation is simple. In other words, whether it consists of text only. If not, you should use <A HREF="../../../../../../org/apache/ws/jaxme/xs/xml/XsEDocumentation.html#getChilds()"><CODE>getChilds()</CODE></A> rather than <A HREF="../../../../../../org/apache/ws/jaxme/xs/xml/XsEDocumentation.html#getText()"><CODE>getText()</CODE></A>.</p> <P> <DD><DL> </DL> </DD> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getChilds()"><!-- --></A><H3> getChilds</H3> <PRE> java.lang.Object[] <B>getChilds</B>()</PRE> <DL> <DD><p>Returns the array of all child objects. Child objects may either be Strings or DOM nodes.</p> <P> <DD><DL> </DL> </DD> <DD><DL> </DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ======= START OF BOTTOM NAVBAR ====== --> <A NAME="navbar_bottom"><!-- --></A> <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <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/ws/jaxme/xs/xml/XsEComplexContent.html" title="interface in org.apache.ws.jaxme.xs.xml"><B>PREV CLASS</B></A> <A HREF="../../../../../../org/apache/ws/jaxme/xs/xml/XsEEnumeration.html" title="interface in org.apache.ws.jaxme.xs.xml"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../../index.html?org/apache/ws/jaxme/xs/xml/XsEDocumentation.html" target="_top"><B>FRAMES</B></A> <A HREF="XsEDocumentation.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> </BODY> </HTML>