XsEDocumentation

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> apache >> ws >> jaxme >> xs >> [ xml overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.apache.ws.jaxme.xs.xml.XsEDocumentation

SOURCE |

Download org.apache.ws.jaxme.xs.xml.XsEDocumentation

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.ws.jaxme.xs.xml
Interface XsEDocumentation

All Superinterfaces:: XsObject

public interface XsEDocumentation
extends XsObject

Interface of xs:documentation, as specified by the following:

  <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>

Method Summary

java.lang.Object[] getChilds()
          Returns the array of all child objects.

XmlLang getLang()
          Returns the documentation elements language.

XsAnyURI getSource()
          Returns the URI to read for the documentations contents.

java.lang.String getText()
          Returns the embedded text.

boolean isTextOnly()
          Returns whether the documentation is simple.

void setLang(XmlLang pLang)
          Sets the documentation elements language.

void setSource(XsAnyURI pSource)
          Sets the URI to read for the documentations contents.

Methods inherited from interface org.apache.ws.jaxme.xs.xml.XsObject

getLocator, getObjectFactory, getParentObject, getXsESchema, isTopLevelObject, validate

Method Detail

setLang

public void setLang(XmlLang pLang)

Sets the documentation elements language. Defaults to null.

getLang

public XmlLang getLang()

Returns the documentation elements language. Defaults to null.

setSource

public void setSource(XsAnyURI pSource)

Sets the URI to read for the documentations contents. Defaults to null.

getSource

public XsAnyURI getSource()

Returns the URI to read for the documentations contents. Defaults to null.

getText

public java.lang.String getText()

Returns the embedded text. The embedded text is specified as the concatenation of all text nodes. Child elements, if any, are ignored.

isTextOnly

public boolean isTextOnly()

Returns whether the documentation is simple. In other words, whether it consists of text only. If not, you should use getChilds() 55 rather than getText() 55 .

getChilds

public java.lang.Object[] getChilds()

Returns the array of all child objects. Child objects may either be Strings or DOM nodes.