org.geotools.xml
Class XMLElementHandler

Object
  extended by XMLElementHandler
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
ComplexElementHandler, DocumentHandler, IgnoreHandler, SimpleElementHandler

public abstract class XMLElementHandler
extends Object
implements Serializable

XSIElementHandler purpose.

This abstract class is intended to act as both a definition of a generic handler.

Author:
dzwiers, Refractions Research, Inc. http://www.refractions.net, $Author:$ (last modification)
See Also:
Serialized Form
Module:

Field Summary
protected static Logger logger
          the logger -- should be used for debugging (assuming there are bugs LOL)
 
Constructor Summary
protected XMLElementHandler()
          Creates a new XSIElementHandler object.
 
Method Summary
 void characters(String text)
          This method throws a SAXNotSupportedException if it is called and not overwritten.
abstract  void endElement(URI namespaceURI, String localName, Map hints)
          handles SAX end Element events.
abstract  Element getElement()
          This returns the Element specified.
abstract  XMLElementHandler getHandler(URI namespaceURI, String localName, Map hints)
          This will find an appropriate XMLElementHandler for the specified child if appropriate.
abstract  String getName()
          This returns the name of the element being represented by this handler.
abstract  Object getValue()
          This method will get the value of the element depending on it's type.
static void setLogLevel(Level l)
           Sets the logger level for all XMLElementHandlers.
abstract  void startElement(URI namespaceURI, String localName, Attributes attr)
          handles SAX start Element events.
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

logger

protected static final Logger logger
the logger -- should be used for debugging (assuming there are bugs LOL)

Constructor Detail

XMLElementHandler

protected XMLElementHandler()
Creates a new XSIElementHandler object. Intended to limit creation to the sub-packages

Method Detail

characters

public void characters(String text)
                throws SAXException
This method throws a SAXNotSupportedException if it is called and not overwritten. When overridding this method, you should be careful to understand that it may be called more than once per element. Therefore it would be advisable to log the text and handle the text's interpretation at a later time (

Parameters:
text -
Throws:
SAXException
SAXNotSupportedException
See Also:
endElement(String,String)).

endElement

public abstract void endElement(URI namespaceURI,
                                String localName,
                                Map hints)
                         throws SAXException,
                                OperationNotSupportedException
handles SAX end Element events. This matches the end of the element declaration in the document ... and responds to the event generated by the SAX parser. This is an opportunity to complete some post-processing.

Parameters:
namespaceURI -
localName -
hints - DOCUMENT ME!
Throws:
SAXException
OperationNotSupportedException
See Also:
SchemaContentHandler#endElement

startElement

public abstract void startElement(URI namespaceURI,
                                  String localName,
                                  Attributes attr)
                           throws SAXException
handles SAX start Element events. This matches the start of the element declaration in the document ... and responds to the event generated by the SAX parser. This is an opportunity to complete some pre-processing.

Parameters:
namespaceURI -
localName -
attr -
Throws:
SAXException
See Also:
SchemaContentHandler#startElement

getHandler

public abstract XMLElementHandler getHandler(URI namespaceURI,
                                             String localName,
                                             Map hints)
                                      throws SAXException
This will find an appropriate XMLElementHandler for the specified child if appropriate. This method may return or throw an exception, depending on the severity, if an error occurs. This method should be used to complete a SAX parse of a document for which the Schema is known, and parsed.

Parameters:
namespaceURI -
localName -
hints - DOCUMENT ME!
Returns:
XMLElementHandler, or null
Throws:
SAXException

getValue

public abstract Object getValue()
                         throws SAXException
This method will get the value of the element depending on it's type.

Returns:
Object (may be null)
Throws:
SAXException
See Also:
Type#getValue

getName

public abstract String getName()
This returns the name of the element being represented by this handler. This name matches the name specified in the Schema.

Returns:
The Name (may not be null)

getElement

public abstract Element getElement()
This returns the Element specified.

Returns:
Element (may not be null)

setLogLevel

public static void setLogLevel(Level l)

Sets the logger level for all XMLElementHandlers.

Parameters:
l -


Copyright © 1996-2009 Geotools. All Rights Reserved.