org.apache.ws.jaxme.xs.xml.impl
Class XsEDocumentationImpl

java.lang.Object
  org.apache.ws.jaxme.xs.xml.impl.XsObjectImpl
      org.apache.ws.jaxme.xs.xml.impl.XsEDocumentationImpl

All Implemented Interfaces:

XsEDocumentation, XsObject

public class XsEDocumentationImpl
extends XsObjectImpl
implements XsEDocumentation

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

Author:

Jochen Wiedmann

Constructor Summary

protected

XsEDocumentationImpl(XsObject pParent)

Method Summary

protected void	addChild(java.lang.Object pObject)
void	addText(java.lang.String pText)
org.xml.sax.ContentHandler	getChildHandler(java.lang.String pQName, java.lang.String pNamespaceURI, java.lang.String pLocalName)
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.
boolean	setAttribute(java.lang.String pQName, java.lang.String pNamespaceURI, java.lang.String pLocalName, java.lang.String pValue)
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 class org.apache.ws.jaxme.xs.xml.impl.XsObjectImpl

asXsQName, asXsQName, getContext, getLocator, getNamespaceSupport, getObjectFactory, getParentObject, getXsESchema, isTopLevelObject, isValidated, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getLocator, getObjectFactory, getParentObject, getXsESchema, isTopLevelObject, validate

Constructor Detail

XsEDocumentationImpl

protected XsEDocumentationImpl(XsObject pParent)

Method Detail

addChild

protected void addChild(java.lang.Object pObject)

setLang

public void setLang(XmlLang pLang)

Description copied from interface: XsEDocumentation

Sets the documentation elements language. Defaults to null.

Specified by:

setLang in interface XsEDocumentation

Parameters:

pLang - The language abbreviation, for example "en".

getLang

public XmlLang getLang()

Description copied from interface: XsEDocumentation

Returns the documentation elements language. Defaults to null.

Specified by:

getLang in interface XsEDocumentation

Returns:

The language abbreviation, for example "en".

setSource

public void setSource(XsAnyURI pSource)

Description copied from interface: XsEDocumentation

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

Specified by:

setSource in interface XsEDocumentation

Parameters:

pSource - Source URI

getSource

public XsAnyURI getSource()

Description copied from interface: XsEDocumentation

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

Specified by:

getSource in interface XsEDocumentation

Returns:

Source URI

addText

public void addText(java.lang.String pText)

getText

public java.lang.String getText()

Description copied from interface: XsEDocumentation

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

Specified by:

getText in interface XsEDocumentation

isTextOnly

public boolean isTextOnly()

Description copied from interface: XsEDocumentation

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

Specified by:

isTextOnly in interface XsEDocumentation

getChilds

public java.lang.Object[] getChilds()

Description copied from interface: XsEDocumentation

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

Specified by:

getChilds in interface XsEDocumentation

setAttribute

public boolean setAttribute(java.lang.String pQName,
                            java.lang.String pNamespaceURI,
                            java.lang.String pLocalName,
                            java.lang.String pValue)

getChildHandler

public org.xml.sax.ContentHandler getChildHandler(java.lang.String pQName,
                                                  java.lang.String pNamespaceURI,
                                                  java.lang.String pLocalName)
                                           throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException