org.exolab.castor.xml.schema.reader
Class DocumentationUnmarshaller

java.lang.Object
  org.exolab.castor.xml.schema.reader.ComponentReader
      org.exolab.castor.xml.schema.reader.DocumentationUnmarshaller

public class DocumentationUnmarshaller
extends ComponentReader

A class for Unmarshalling XML Schema elements

Version:

$Revision: 7410 $ $Date: 2004-10-01 07:25:46 -0600 (Fri, 01 Oct 2004) $

Author:

Keith Visco

Constructor Summary

DocumentationUnmarshaller(SchemaContext schemaContext, AttributeSet atts)
Creates a new DocumentationUnmarshaller.

Method Summary

void	characters(char[] ch, int start, int length) Signals to recieve charactes
String	elementName() Returns the name of the element that this ComponentReader handles
void	endElement(String name, String namespace) Signals to end of the element with the given name.
void	finish() Called to signal an end of unmarshalling.
Documentation	getDocumentation()
Object	getObject() Returns the Object created by this ComponentReader
void	startElement(String name, String namespace, AttributeSet atts, Namespaces nsDecls) Signals the start of an element with the given name.

Methods inherited from class org.exolab.castor.xml.schema.reader.ComponentReader

error, error, getDocumentLocator, getResolver, getSchemaContext, getURIResolver, illegalAttribute, illegalElement, isWhiteSpace, outOfOrder, redefinedElement, redefinedElement, setDocumentLocator, setResolver, setSchemaContext, setURIResolver, toInt

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentationUnmarshaller

public DocumentationUnmarshaller(SchemaContext schemaContext,
                                 AttributeSet atts)

Creates a new DocumentationUnmarshaller.

Parameters:

schemaContext - the schema context to get some configuration settings from

atts - the AttributeList

Method Detail

elementName

public String elementName()

Returns the name of the element that this ComponentReader handles

Specified by:

elementName in class ComponentReader

Returns:

the name of the element that this ComponentReader handles

finish

public void finish()

Called to signal an end of unmarshalling. This method should be overridden to perform any necessary clean up by an unmarshaller

Overrides:

finish in class ComponentReader

getDocumentation

public Documentation getDocumentation()

getObject

public Object getObject()

Returns the Object created by this ComponentReader

Specified by:

getObject in class ComponentReader

Returns:

the Object created by this ComponentReader

startElement

public void startElement(String name,
                         String namespace,
                         AttributeSet atts,
                         Namespaces nsDecls)
                  throws XMLException

Signals the start of an element with the given name.

Overrides:

startElement in class ComponentReader

Parameters:

name - the NCName of the element. It is an error if the name is a QName (ie. contains a prefix).

namespace - the namespace of the element. This may be null. Note: A null namespace is not the same as the default namespace unless the default namespace is also null.

atts - the AttributeSet containing the attributes associated with the element.

nsDecls - the namespace declarations being declared for this element. This may be null.

Throws:

XMLException

endElement

public void endElement(String name,
                       String namespace)
                throws XMLException

Signals to end of the element with the given name.

Overrides:

endElement in class ComponentReader

Parameters:

name - the NCName of the element. It is an error if the name is a QName (ie. contains a prefix).

namespace - the namespace of the element.

Throws:

XMLException

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws XMLException

Description copied from class: ComponentReader

Signals to recieve charactes

Overrides:

characters in class ComponentReader

Parameters:

ch - the character array containing the characters

start - the starting index into the character array

length - the number of characters to recieve

Throws:

XMLException