org.eclipse.persistence.oxm

Class XMLUnmarshallerHandler

java.lang.Object

org.eclipse.persistence.platform.xml.SAXDocumentBuilder

org.eclipse.persistence.oxm.XMLUnmarshallerHandler

All Implemented Interfaces:

org.eclipse.persistence.internal.oxm.record.ExtendedContentHandler, org.eclipse.persistence.internal.oxm.UnmarshallerHandler, ContentHandler, LexicalHandler

public class XMLUnmarshallerHandler
extends SAXDocumentBuilder
implements org.eclipse.persistence.internal.oxm.UnmarshallerHandler

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, locator, namespaceDeclarations, nodes, stringBuffer, xmlPlatform

Method Summary

Modifier and Type	Method and Description
void	endDocument()
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, characters, comment, endCDATA, endDTD, endElement, endEntity, endPrefixMapping, getDocument, getInitializedDocument, ignorableWhitespace, processingInstruction, setDocumentLocator, setNil, skippedEntity, startCDATA, startDTD, startElement, startEntity, startPrefixMapping

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.xml.sax.ContentHandler

characters, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startElement, startPrefixMapping

Method Detail

endDocument

public void endDocument()
                 throws SAXException

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class SAXDocumentBuilder

Throws:

SAXException

startDocument

public void startDocument()
                   throws SAXException

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class SAXDocumentBuilder

Throws:

SAXException

getResult

public Object getResult()

Returns the object that was unmarshalled from the SAX events.

Specified by:

getResult in interface org.eclipse.persistence.internal.oxm.UnmarshallerHandler

Returns:

the resulting object

Throws:

XMLMarshalException - if an error occurred during unmarshalling