Inheritance diagram for org.exolab.castor.xml.schema.reader.ComponentReader:

Public Member Functions
	ComponentReader ()
abstract String	elementName ()
abstract Object	getObject ()
void	finish () throws XMLException
Locator	getDocumentLocator ()
Resolver	getResolver ()
URIResolver	getURIResolver ()
void	setResolver (Resolver resolver)
void	setURIResolver (URIResolver uriResolver)
void	error (String err) throws XMLException
void	error (Exception ex) throws XMLException
void	illegalAttribute (String attName) throws XMLException
void	illegalElement (String name) throws XMLException
void	redefinedElement (String name) throws XMLException
void	redefinedElement (String name, String xtraInfo) throws XMLException
void	outOfOrder (String name) throws XMLException
void	setDocumentLocator (Locator locator)
void	characters (char[] chars, int start, int length) throws XMLException
void	endElement (String name, String namespace) throws XMLException
void	startElement (String name, String namespace, AttributeSet atts, Namespaces nsDecls) throws XMLException
Static Public Member Functions
static boolean	isWhiteSpace (char[] chars, int start, int length)
static int	toInt (String str) throws IllegalArgumentException
Protected Attributes
Locator	_locator = null

Detailed Description

The base class for separate component unmarshallers for reading an XML Schema component.

Author:: Keith Visco

Version:

Revision:: 1.2

Date:: 2004/06/28 21:03:03

Constructor & Destructor Documentation

org.exolab.castor.xml.schema.reader.ComponentReader.ComponentReader ( )

Member Function Documentation

void org.exolab.castor.xml.schema.reader.ComponentReader.characters	(	char[]	chars,
		int	start,
		int	length
	)			throws XMLException

Signals to recieve charactes

Parameters:

	chars	the character array containing the characters
	start	the starting index into the character array
	length	the number of characters to recieve

abstract String org.exolab.castor.xml.schema.reader.ComponentReader.elementName ( ) [pure virtual]

Returns the name of the element that this ComponentReader handles

Returns:: the name of the element that this ComponentReader handles

void org.exolab.castor.xml.schema.reader.ComponentReader.endElement	(	String	name,
		String	namespace
	)			throws XMLException

Signals to end of the element with the given name.

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.

void org.exolab.castor.xml.schema.reader.ComponentReader.error ( String err ) throws XMLException

This method is called for a general error.

Parameters:

err

the error message to report

Exceptions:

org.xml.sax.SAXException

always thrown.

References org.exolab.castor.xml.schema.reader.ComponentReader._locator.

void org.exolab.castor.xml.schema.reader.ComponentReader.error ( Exception ex ) throws XMLException

This method is called for a general error.

Parameters:

ex

the Exception that caused the error.

Exceptions:

org.xml.sax.SAXException

always thrown.

References org.exolab.castor.xml.schema.reader.ComponentReader._locator.

void org.exolab.castor.xml.schema.reader.ComponentReader.finish ( ) throws XMLException

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

Locator org.exolab.castor.xml.schema.reader.ComponentReader.getDocumentLocator ( )

References org.exolab.castor.xml.schema.reader.ComponentReader._locator.

abstract Object org.exolab.castor.xml.schema.reader.ComponentReader.getObject ( ) [pure virtual]

Returns the Object created by this Unmarshaller

Returns:: the Object created by this Unmarshaller

Resolver org.exolab.castor.xml.schema.reader.ComponentReader.getResolver ( )

Returns the resolver used for resolving id references.

Returns:: the resolver used for resolving id references.

URIResolver org.exolab.castor.xml.schema.reader.ComponentReader.getURIResolver ( )

Returns the URIresolver used for resolving hrefs.

Returns:: the URIresolver used for resolving hrefs.

Referenced by org.exolab.castor.xml.schema.reader.ImportUnmarshaller.ImportUnmarshaller(), org.exolab.castor.xml.schema.reader.IncludeUnmarshaller.IncludeUnmarshaller(), org.exolab.castor.xml.schema.reader.SchemaReader.read(), org.exolab.castor.xml.schema.reader.RedefineUnmarshaller.RedefineUnmarshaller(), and org.exolab.castor.xml.schema.reader.SchemaUnmarshaller.startElement().

void org.exolab.castor.xml.schema.reader.ComponentReader.illegalAttribute ( String attName ) throws XMLException

This method is called when an illegal Attribute is encountered.

Parameters:

attName

the name of the illegal attribute.

Exceptions:

org.xml.sax.SAXException

always thrown.

References org.exolab.castor.xml.schema.reader.ComponentReader._locator, and org.exolab.castor.xml.schema.reader.ComponentReader.elementName().

Referenced by org.exolab.castor.xml.schema.reader.AnnotationUnmarshaller.AnnotationUnmarshaller().

void org.exolab.castor.xml.schema.reader.ComponentReader.illegalElement ( String name ) throws XMLException

This method is called when an illegal Element is encountered.

Parameters:

name

the name of the illegal element

Exceptions:

org.xml.sax.SAXException

always thrown.

References org.exolab.castor.xml.schema.reader.ComponentReader._locator, and org.exolab.castor.xml.schema.reader.ComponentReader.elementName().

static boolean org.exolab.castor.xml.schema.reader.ComponentReader.isWhiteSpace	(	char[]	chars,
		int	start,
		int	length
	)			`[static]`

Determines if the given sequence of characters consists of whitespace characters

Parameters:

	chars	an array of characters to check for whitespace
	start	the start index into the character array
	length	the number of characters to check

Returns:: true if the characters specficied consist only of whitespace characters

void org.exolab.castor.xml.schema.reader.ComponentReader.outOfOrder ( String name ) throws XMLException

This method is called when an out of order element is encountered

Exceptions:

org.xml.sax.SAXException

always thrown.

References org.exolab.castor.xml.schema.reader.ComponentReader.elementName().

Referenced by org.exolab.castor.xml.schema.reader.AttributeGroupUnmarshaller.startElement().

void org.exolab.castor.xml.schema.reader.ComponentReader.redefinedElement	(	String	name,
		String	xtraInfo
	)			throws XMLException

This method is called when an element which may only be defined once, is redefined.

Parameters:

name

the name of the element

Exceptions:

org.xml.sax.SAXException

always thrown.

References org.exolab.castor.xml.schema.reader.ComponentReader._locator, and org.exolab.castor.xml.schema.reader.ComponentReader.elementName().

void org.exolab.castor.xml.schema.reader.ComponentReader.redefinedElement ( String name ) throws XMLException

This method is called when an element which may only be defined once, is redefined.

Parameters:

name

the name of the element

Exceptions:

org.xml.sax.SAXException

always thrown.

void org.exolab.castor.xml.schema.reader.ComponentReader.setDocumentLocator ( Locator locator )

References org.exolab.castor.xml.schema.reader.ComponentReader._locator.

void org.exolab.castor.xml.schema.reader.ComponentReader.setResolver ( Resolver resolver )

Sets the Resolver to be used for resolving id references

Parameters:

resolver

the Resolver to be used for resolving id references

Reimplemented in org.exolab.castor.xml.schema.reader.SchemaUnmarshaller.

void org.exolab.castor.xml.schema.reader.ComponentReader.setURIResolver ( URIResolver uriResolver )

Sets the URIResolver to be used for resolving hrefs.

Parameters:

uriResolver

the URIResolver to be used for resolving hrefs.

Referenced by com.cosylab.cdb.jdal.XSDElementTypeResolver.doesExtend(), org.exolab.castor.xml.schema.reader.ImportUnmarshaller.ImportUnmarshaller(), org.exolab.castor.xml.schema.reader.IncludeUnmarshaller.IncludeUnmarshaller(), com.cosylab.cdb.jdal.XSDElementTypeResolver.internalGetElementTypes(), org.exolab.castor.xml.schema.reader.SchemaReader.read(), org.exolab.castor.xml.schema.reader.RedefineUnmarshaller.RedefineUnmarshaller(), and org.exolab.castor.xml.schema.reader.SchemaUnmarshaller.SchemaUnmarshaller().

void org.exolab.castor.xml.schema.reader.ComponentReader.startElement	(	String	name,
		String	namespace,
		AttributeSet	atts,
		Namespaces	nsDecls
	)			throws XMLException

Signals the start of an element with the given name.

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.