org.exolab.castor.xml.schema.reader

Class ComponentReader

Known Direct Subclasses:
AnnotationUnmarshaller, AppInfoUnmarshaller, AttributeGroupUnmarshaller, AttributeUnmarshaller, CharacterUnmarshaller, ComplexContentRestrictionUnmarshaller, ComplexContentUnmarshaller, ComplexTypeUnmarshaller, DocumentationUnmarshaller, ElementUnmarshaller, ExtensionUnmarshaller, FacetUnmarshaller, FieldOrSelectorUnmarshaller, GroupUnmarshaller, IdentityConstraintUnmarshaller, ImportUnmarshaller, IncludeUnmarshaller, ModelGroupUnmarshaller, SchemaUnmarshaller, SimpleContentRestrictionUnmarshaller, SimpleContentUnmarshaller, SimpleTypeListUnmarshaller, SimpleTypeRestrictionUnmarshaller, SimpleTypeUnmarshaller, UnionUnmarshaller, UnknownUnmarshaller, WildcardUnmarshaller

public abstract class ComponentReader
extends java.lang.Object

The base class for separate component unmarshallers for reading an XML Schema component.
Version:
$Revision: 1.1.1.1 $ $Date: 2003/03/03 07:09:38 $
Author:
Keith Visco

Field Summary

protected Locator
_locator
The document locator

Constructor Summary

ComponentReader()

Method Summary

void
characters(char[] chars, int start, int length)
Signals to recieve charactes
abstract 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
error(String err)
This method is called for a general error.
void
finish()
Called to signal an end of unmarshalling.
Locator
getDocumentLocator()
abstract Object
getObject()
Returns the Object created by this Unmarshaller
Resolver
getResolver()
Returns the resolver used for resolving id references.
URIResolver
getURIResolver()
Returns the URIresolver used for resolving hrefs.
void
illegalAttribute(String attName)
This method is called when an illegal Attribute is encountered.
void
illegalElement(String name)
This method is called when an illegal Element is encountered.
static boolean
isWhiteSpace(char[] chars, int start, int length)
Determines if the given sequence of characters consists of whitespace characters
void
outOfOrder(String name)
This method is called when an out of order element is encountered
void
redefinedElement(String name)
This method is called when an element which may only be defined once, is redefined.
void
redefinedElement(String name, String xtraInfo)
This method is called when an element which may only be defined once, is redefined.
void
setDocumentLocator(Locator locator)
void
setResolver(Resolver resolver)
Sets the Resolver to be used for resolving id references
void
setURIResolver(URIResolver uriResolver)
Sets the URIResolver to be used for resolving hrefs.
void
startElement(String name, String namespace, AttributeSet atts, Namespaces nsDecls)
Signals the start of an element with the given name.
static int
toInt(String str)
Converts the given String to an int

Field Details

_locator

protected Locator _locator
The document locator

Constructor Details

ComponentReader

public ComponentReader()

Method Details

characters

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

elementName

public abstract String elementName()
Returns the name of the element that this ComponentReader handles
Returns:
the name of the element that this ComponentReader handles

endElement

public void 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.

error

public void error(String err)
            throws XMLException
This method is called for a general error.
Parameters:
err - the error message to report

finish

public void finish()
            throws XMLException
Called to signal an end of unmarshalling. This method should be overridden to perform any necessary clean up by an unmarshaller

getDocumentLocator

public Locator getDocumentLocator()

getObject

public abstract Object getObject()
Returns the Object created by this Unmarshaller
Returns:
the Object created by this Unmarshaller

getResolver

public Resolver getResolver()
Returns the resolver used for resolving id references.
Returns:
the resolver used for resolving id references.

getURIResolver

public URIResolver getURIResolver()
Returns the URIresolver used for resolving hrefs.
Returns:
the URIresolver used for resolving hrefs.

illegalAttribute

public void illegalAttribute(String attName)
            throws XMLException
This method is called when an illegal Attribute is encountered.
Parameters:
attName - the name of the illegal attribute.

illegalElement

public void illegalElement(String name)
            throws XMLException
This method is called when an illegal Element is encountered.
Parameters:
name - the name of the illegal element

isWhiteSpace

public static boolean isWhiteSpace(char[] chars,
                                   int start,
                                   int length)
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

outOfOrder

public void outOfOrder(String name)
            throws XMLException
This method is called when an out of order element is encountered

redefinedElement

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

redefinedElement

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

setDocumentLocator

public void setDocumentLocator(Locator locator)

setResolver

public void setResolver(Resolver resolver)
Sets the Resolver to be used for resolving id references
Parameters:
resolver - the Resolver to be used for resolving id references

setURIResolver

public void setURIResolver(URIResolver uriResolver)
Sets the URIResolver to be used for resolving hrefs.
Parameters:
uriResolver - the URIResolver to be used for resolving hrefs.

startElement

public void 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.

toInt

public static int toInt(String str)
            throws IllegalArgumentException
Converts the given String to an int
Parameters:
str - the String to convert to an int
Returns:
the int derived from the given String

Intalio Inc. (C) 1999-2003. All rights reserved http://www.intalio.com