ecologylab.xml
Class ElementStateSAXHandler

java.lang.Object
  extended by ecologylab.generic.Debug
      extended by ecologylab.xml.ElementStateSAXHandler
All Implemented Interfaces:
OptimizationTypes, org.xml.sax.ContentHandler

public class ElementStateSAXHandler
extends Debug
implements org.xml.sax.ContentHandler, OptimizationTypes

Use SAX to translate XML into a typed tree of ElementState objects.

Author:
andruid

Field Summary
 
Fields inherited from interface ecologylab.xml.OptimizationTypes
BAD_FIELD, COLLECTION_ELEMENT, COLLECTION_SCALAR, IGNORED_ATTRIBUTE, IGNORED_ELEMENT, LEAF_NODE_VALUE, MAP_ELEMENT, MAP_SCALAR, NAME_SPACE_ATTRIBUTE, NAME_SPACE_LEAF_NODE, NAME_SPACE_MASK, NAME_SPACE_NESTED_ELEMENT, NAMESPACE_IGNORED_ELEMENT, NAMESPACE_TRIAL_ELEMENT, OTHER_NESTED_ELEMENT, REGULAR_ATTRIBUTE, REGULAR_NESTED_ELEMENT, ROOT, UNSET_TYPE, XMLNS_ATTRIBUTE, XMLNS_IGNORED
 
Constructor Summary
ElementStateSAXHandler(TranslationSpace translationSpace)
           
 
Method Summary
 void characters(char[] chars, int startIndex, int length)
          ${tags}
static org.xml.sax.XMLReader createXMLReader()
           
 void endDocument()
          ${tags}
 void endElement(java.lang.String arg0, java.lang.String arg1, java.lang.String arg2)
          ${tags}
 void endPrefixMapping(java.lang.String prefix)
          ${tags}
 void ignorableWhitespace(char[] ch, int start, int length)
          ${tags}
static void main(java.lang.String[] args)
           
 ElementState parse(java.lang.CharSequence charSequence)
          Parse the CharSequence of XML, using UTF-8 encoding.
 ElementState parse(java.lang.CharSequence charSequence, int charsetType)
          Parse the CharSequence of XML, given the charsetType encoding info.
 ElementState parse(java.io.File file)
          Translate a file from XML to a strongly typed tree of XML objects.
 ElementState parse(org.xml.sax.InputSource inputSource)
           
 ElementState parse(java.io.InputStream inputStream)
           
 ElementState parse(ParsedURL purl)
          Translate an XML document read from a ParsedURL to a strongly typed tree of XML objects.
 ElementState parse(java.io.Reader reader)
           
 ElementState parse(java.net.URL url)
          Translate an XML document read from a URL to a strongly typed tree of XML objects.
 ElementState parseString(java.lang.String xmlString)
           
 void processingInstruction(java.lang.String target, java.lang.String data)
          ${tags}
 ElementState root()
           
 void setDocumentLocator(org.xml.sax.Locator locator)
          ${tags}
 void skippedEntity(java.lang.String name)
          ${tags}
 void startDocument()
          ${tags}
 void startElement(java.lang.String uri, java.lang.String localName, java.lang.String tagName, org.xml.sax.Attributes attributes)
          ${tags}
 void startPrefixMapping(java.lang.String nsID, java.lang.String urn)
          ${tags}
 
Methods inherited from class ecologylab.generic.Debug
classSimpleName, closeLoggingFile, debug, debug, debug, debug, debugA, debugA, debugA, debugI, debugI, debugI, error, error, getClassName, getClassName, getInteractive, getPackageName, getPackageName, getPackageName, initialize, level, level, level, logToFile, print, print, println, println, println, println, println, println, printlnA, printlnA, printlnA, printlnI, printlnI, printlnI, printlnI, setLoggingFile, show, show, superString, toggleInteractive, toString, toString, warning, warning, weird, weird
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ElementStateSAXHandler

public ElementStateSAXHandler(TranslationSpace translationSpace)
Method Detail

createXMLReader

public static org.xml.sax.XMLReader createXMLReader()
                                             throws org.xml.sax.SAXException
Throws:
org.xml.sax.SAXException

parse

public ElementState parse(java.lang.CharSequence charSequence)
                   throws XMLTranslationException
Parse the CharSequence of XML, using UTF-8 encoding.

Parameters:
charSequence -
Returns:
Throws:
XMLTranslationException

parse

public ElementState parse(java.lang.CharSequence charSequence,
                          int charsetType)
                   throws XMLTranslationException
Parse the CharSequence of XML, given the charsetType encoding info.

Parameters:
charSequence -
charsetType -
Returns:
Throws:
XMLTranslationException

parseString

public ElementState parseString(java.lang.String xmlString)
                         throws XMLTranslationException
Throws:
XMLTranslationException

parse

public ElementState parse(java.net.URL url)
                   throws XMLTranslationException
Translate an XML document read from a URL to a strongly typed tree of XML objects. Use SAX or DOM parsing depending on the value of useDOMForTranslateTo.

Parameters:
purl - XML source material.
translationSpace - Specifies mapping from XML nodes (elements and attributes) to Java types.
Returns:
Strongly typed tree of ElementState objects.
Throws:
XMLTranslationException

parse

public ElementState parse(ParsedURL purl)
                   throws XMLTranslationException
Translate an XML document read from a ParsedURL to a strongly typed tree of XML objects. Use SAX or DOM parsing depending on the value of useDOMForTranslateTo.

Parameters:
purl - XML source material.
translationSpace - Specifies mapping from XML nodes (elements and attributes) to Java types.
Returns:
Strongly typed tree of ElementState objects.
Throws:
XMLTranslationException

parse

public ElementState parse(java.io.File file)
                   throws XMLTranslationException
Translate a file from XML to a strongly typed tree of XML objects. Use SAX or DOM parsing depending on the value of useDOMForTranslateTo.

Parameters:
file - XML source material.
translationSpace - Specifies mapping from XML nodes (elements and attributes) to Java types.
Returns:
Strongly typed tree of ElementState objects.
Throws:
XMLTranslationException

parse

public ElementState parse(java.io.Reader reader)
                   throws XMLTranslationException
Throws:
XMLTranslationException

parse

public ElementState parse(java.io.InputStream inputStream)
                   throws XMLTranslationException
Throws:
XMLTranslationException

parse

public ElementState parse(org.xml.sax.InputSource inputSource)
                   throws XMLTranslationException
Throws:
XMLTranslationException

startElement

public void startElement(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String tagName,
                         org.xml.sax.Attributes attributes)
                  throws org.xml.sax.SAXException
${tags}

Specified by:
startElement in interface org.xml.sax.ContentHandler
Throws:
org.xml.sax.SAXException
See Also:
ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)

endElement

public void endElement(java.lang.String arg0,
                       java.lang.String arg1,
                       java.lang.String arg2)
                throws org.xml.sax.SAXException
${tags}

Specified by:
endElement in interface org.xml.sax.ContentHandler
Throws:
org.xml.sax.SAXException
See Also:
ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)

characters

public void characters(char[] chars,
                       int startIndex,
                       int length)
                throws org.xml.sax.SAXException
${tags}

Specified by:
characters in interface org.xml.sax.ContentHandler
Throws:
org.xml.sax.SAXException
See Also:
ContentHandler.characters(char[], int, int)

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException
${tags}

Specified by:
endDocument in interface org.xml.sax.ContentHandler
Throws:
org.xml.sax.SAXException
See Also:
ContentHandler.endDocument()

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)
                      throws org.xml.sax.SAXException
${tags}

Specified by:
endPrefixMapping in interface org.xml.sax.ContentHandler
Throws:
org.xml.sax.SAXException
See Also:
ContentHandler.endPrefixMapping(java.lang.String)

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int length)
                         throws org.xml.sax.SAXException
${tags}

Specified by:
ignorableWhitespace in interface org.xml.sax.ContentHandler
Throws:
org.xml.sax.SAXException
See Also:
ContentHandler.ignorableWhitespace(char[], int, int)

processingInstruction

public void processingInstruction(java.lang.String target,
                                  java.lang.String data)
                           throws org.xml.sax.SAXException
${tags}

Specified by:
processingInstruction in interface org.xml.sax.ContentHandler
Throws:
org.xml.sax.SAXException
See Also:
ContentHandler.processingInstruction(java.lang.String, java.lang.String)

setDocumentLocator

public void setDocumentLocator(org.xml.sax.Locator locator)
${tags}

Specified by:
setDocumentLocator in interface org.xml.sax.ContentHandler
See Also:
ContentHandler.setDocumentLocator(org.xml.sax.Locator)

skippedEntity

public void skippedEntity(java.lang.String name)
                   throws org.xml.sax.SAXException
${tags}

Specified by:
skippedEntity in interface org.xml.sax.ContentHandler
Throws:
org.xml.sax.SAXException
See Also:
ContentHandler.skippedEntity(java.lang.String)

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException
${tags}

Specified by:
startDocument in interface org.xml.sax.ContentHandler
Throws:
org.xml.sax.SAXException
See Also:
ContentHandler.startDocument()

startPrefixMapping

public void startPrefixMapping(java.lang.String nsID,
                               java.lang.String urn)
                        throws org.xml.sax.SAXException
${tags}

Specified by:
startPrefixMapping in interface org.xml.sax.ContentHandler
Throws:
org.xml.sax.SAXException
See Also:
ContentHandler.startPrefixMapping(java.lang.String, java.lang.String)

main

public static void main(java.lang.String[] args)
Parameters:
args -

root

public ElementState root()
Returns:
the root