EclipseLink 2.2.0, build 'v20110202-r8913' API Reference

org.eclipse.persistence.oxm
Class XMLUnmarshallerHandler

java.lang.Object
  extended by org.eclipse.persistence.platform.xml.SAXDocumentBuilder
      extended by org.eclipse.persistence.oxm.XMLUnmarshallerHandler
All Implemented Interfaces:
org.xml.sax.ContentHandler

public class XMLUnmarshallerHandler
extends SAXDocumentBuilder

Class used to unmarshal SAX events to objects.

Create an XMLUnmarshallerHandler from an XMLUnmarshaller.
Code Sample
XMLContext context = new XMLContext("mySessionName");
XMLUnmarshaller unmarshaller = context.createUnmarshaller();
XMLUnmarshallerHandler unmarshallerHandler = unmarshaller.getUnmarshallerHandler();

Use the UnmarshallerHandler with an XMLReader
Code Sample
SAXParserFactory saxParserFactory = SAXParserFactory.newInstance();
saxParserFactory.setNamespaceAware(true);
SAXParser saxParser = saxParserFactory.newSAXParser();
XMLReader xmlReader = saxParser.getXMLReader();
xmlReader.setContentHandler(xmlUnmarshallerHandler);
FileInputStream inputStream = new FileInputStream("MyFile.xml");
InputSource inputSource = new InputSource(inputStream);
xmlReader.parse(inputSource);
Object result = xmlUnmarshallerHandler.getResult();

XML that can be unmarshalled is XML which has a root tag that corresponds to a default root element on an XMLDescriptor in the TopLink project associated with the XMLContext.

See Also:
XMLUnmarshaller

Field Summary
 
Fields inherited from class org.eclipse.persistence.platform.xml.SAXDocumentBuilder
document, namespaceDeclarations, nodes, stringBuffer, xmlPlatform
 
Method Summary
 void endDocument()
           
 java.lang.Object getResult()
          Returns the object that was unmarshalled from the SAX events.
 void startDocument()
           
 
Methods inherited from class org.eclipse.persistence.platform.xml.SAXDocumentBuilder
addNamespaceDeclaration, appendChildNode, characters, endElement, endPrefixMapping, getDocument, getInitializedDocument, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startElement, startPrefixMapping
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException
Specified by:
endDocument in interface org.xml.sax.ContentHandler
Overrides:
endDocument in class SAXDocumentBuilder
Throws:
org.xml.sax.SAXException

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException
Specified by:
startDocument in interface org.xml.sax.ContentHandler
Overrides:
startDocument in class SAXDocumentBuilder
Throws:
org.xml.sax.SAXException

getResult

public java.lang.Object getResult()
Returns the object that was unmarshalled from the SAX events.

Returns:
the resulting object
Throws:
XMLMarshalException - if an error occurred during unmarshalling

EclipseLink 2.2.0, build 'v20110202-r8913' API Reference