Public Member Functions | Static Public Member Functions | Protected Attributes

org.exolab.castor.xml.schema.reader.SaxUnmarshaller Class Reference

Inherits org::xml::sax::DocumentHandler.

List of all members.

Public Member Functions

 SaxUnmarshaller ()
abstract String elementName ()
abstract Object getObject ()
void finish () throws SAXException
Locator getDocumentLocator ()
Resolver getResolver ()
void setResolver (Resolver resolver)
void error (String err) throws org.xml.sax.SAXException
void illegalAttribute (String attName) throws org.xml.sax.SAXException
void illegalElement (String name) throws org.xml.sax.SAXException
void redefinedElement (String name) throws org.xml.sax.SAXException
void redefinedElement (String name, String xtraInfo) throws org.xml.sax.SAXException
void outOfOrder (String name) throws org.xml.sax.SAXException
void characters (char[] ch, int start, int length) throws org.xml.sax.SAXException
void endDocument () throws org.xml.sax.SAXException
void endElement (String name) throws org.xml.sax.SAXException
void ignorableWhitespace (char[] ch, int start, int length) throws org.xml.sax.SAXException
void processingInstruction (String target, String data) throws org.xml.sax.SAXException
void setDocumentLocator (Locator locator)
void startDocument () throws org.xml.sax.SAXException
void startElement (String name, AttributeList atts) throws org.xml.sax.SAXException
void error (SAXParseException exception) throws org.xml.sax.SAXException
void fatalError (SAXParseException exception) throws org.xml.sax.SAXException
void warning (SAXParseException exception) throws org.xml.sax.SAXException

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 unmarshallers

Author:
Keith Visco
Version:
Revision:
1.1.1.1
Date:
2003/03/03 07:09:41

Constructor & Destructor Documentation

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

Member Function Documentation

void org.exolab.castor.xml.schema.reader.SaxUnmarshaller.characters ( char[]  ch,
int  start,
int  length 
) throws org.xml.sax.SAXException
abstract String org.exolab.castor.xml.schema.reader.SaxUnmarshaller.elementName (  )  [pure virtual]
void org.exolab.castor.xml.schema.reader.SaxUnmarshaller.endDocument (  )  throws org.xml.sax.SAXException
void org.exolab.castor.xml.schema.reader.SaxUnmarshaller.endElement ( String  name  )  throws org.xml.sax.SAXException
void org.exolab.castor.xml.schema.reader.SaxUnmarshaller.error ( String  err  )  throws org.xml.sax.SAXException

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.SaxUnmarshaller._locator.

void org.exolab.castor.xml.schema.reader.SaxUnmarshaller.error ( SAXParseException  exception  )  throws org.xml.sax.SAXException
void org.exolab.castor.xml.schema.reader.SaxUnmarshaller.fatalError ( SAXParseException  exception  )  throws org.xml.sax.SAXException
void org.exolab.castor.xml.schema.reader.SaxUnmarshaller.finish (  )  throws SAXException

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.SaxUnmarshaller.getDocumentLocator (  ) 
abstract Object org.exolab.castor.xml.schema.reader.SaxUnmarshaller.getObject (  )  [pure virtual]

Returns the Object created by this Unmarshaller

Returns:
the Object created by this Unmarshaller
Resolver org.exolab.castor.xml.schema.reader.SaxUnmarshaller.getResolver (  ) 

Returns the resolver used for resolving id references.

Returns:
the resolver used for resolving id references.
void org.exolab.castor.xml.schema.reader.SaxUnmarshaller.ignorableWhitespace ( char[]  ch,
int  start,
int  length 
) throws org.xml.sax.SAXException
void org.exolab.castor.xml.schema.reader.SaxUnmarshaller.illegalAttribute ( String  attName  )  throws org.xml.sax.SAXException

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.SaxUnmarshaller._locator, and org.exolab.castor.xml.schema.reader.SaxUnmarshaller.elementName().

void org.exolab.castor.xml.schema.reader.SaxUnmarshaller.illegalElement ( String  name  )  throws org.xml.sax.SAXException

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.SaxUnmarshaller._locator, and org.exolab.castor.xml.schema.reader.SaxUnmarshaller.elementName().

static boolean org.exolab.castor.xml.schema.reader.SaxUnmarshaller.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.SaxUnmarshaller.outOfOrder ( String  name  )  throws org.xml.sax.SAXException

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.SaxUnmarshaller.elementName().

void org.exolab.castor.xml.schema.reader.SaxUnmarshaller.processingInstruction ( String  target,
String  data 
) throws org.xml.sax.SAXException
void org.exolab.castor.xml.schema.reader.SaxUnmarshaller.redefinedElement ( String  name,
String  xtraInfo 
) throws org.xml.sax.SAXException

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.SaxUnmarshaller._locator, and org.exolab.castor.xml.schema.reader.SaxUnmarshaller.elementName().

void org.exolab.castor.xml.schema.reader.SaxUnmarshaller.redefinedElement ( String  name  )  throws org.xml.sax.SAXException

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.SaxUnmarshaller.setDocumentLocator ( Locator  locator  ) 
void org.exolab.castor.xml.schema.reader.SaxUnmarshaller.setResolver ( Resolver  resolver  ) 

Sets the Resolver to be used for resolving id references

Parameters:
resolver the Resolver to be used for resolving id references
void org.exolab.castor.xml.schema.reader.SaxUnmarshaller.startDocument (  )  throws org.xml.sax.SAXException
void org.exolab.castor.xml.schema.reader.SaxUnmarshaller.startElement ( String  name,
AttributeList  atts 
) throws org.xml.sax.SAXException
static int org.exolab.castor.xml.schema.reader.SaxUnmarshaller.toInt ( String  str  )  throws IllegalArgumentException [static]

Converts the given String to an int

Parameters:
str the String to convert to an int
Returns:
the int derived from the given String
Exceptions:
IllegalArgumentException when the given String does not represent a valid int
void org.exolab.castor.xml.schema.reader.SaxUnmarshaller.warning ( SAXParseException  exception  )  throws org.xml.sax.SAXException

Member Data Documentation


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties