org.eclipse.persistence.oxm.record

Class UnmarshalRecord

java.lang.Object

org.eclipse.persistence.internal.sessions.AbstractRecord

org.eclipse.persistence.oxm.record.XMLRecord

org.eclipse.persistence.oxm.record.UnmarshalRecord

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map, ExtendedContentHandler, Record, org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler

Direct Known Subclasses:

BinaryDataUnmarshalRecord, UnmappedContentHandlerWrapper, XMLBinaryAttachmentHandler, XMLInlineBinaryHandler, XMLRootRecord

public class UnmarshalRecord
extends XMLRecord
implements ExtendedContentHandler, org.xml.sax.ext.LexicalHandler

Purpose:Provide an implementation of ContentHandler that is used by TopLink OXM to build mapped Java Objects from SAX events.

Responsibilities:

• Implement the ContentHandler and LexicalHandler interfaces
• Make calls into the appropriate NodeValues based on the incoming SAXEvents
• Make callbacks into XMLReader for newObject events
• Maintain a map of Collections to be populated for collection mappings.

Author:

bdoughan

See Also:

XPathNode, NodeValue, TreeObjectBuilder, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.persistence.internal.sessions.AbstractRecord

AbstractRecord.NoEntry

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static UnmappedContentHandler	DEFAULT_UNMAPPED_CONTENT_HANDLER

Fields inherited from class org.eclipse.persistence.oxm.record.XMLRecord

NIL

Fields inherited from class org.eclipse.persistence.internal.sessions.AbstractRecord

noEntry

Constructor Summary

Constructors

Constructor and Description
UnmarshalRecord(TreeObjectBuilder treeObjectBuilder)

Method Summary

Modifier and Type	Method and Description
void	addAttributeValue(ContainerValue containerValue, java.lang.Object value)
void	addAttributeValue(ContainerValue containerValue, java.lang.Object value, java.lang.Object collection)
void	characters(char[] ch, int start, int length)
void	characters(java.lang.CharSequence characters)
void	clear() PUBLIC: Clear the sub-nodes of the DOM.
void	comment(char[] data, int start, int length)
void	endCDATA()
void	endDocument()
void	endDTD()
void	endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName)
void	endEntity(java.lang.String entity)
void	endPrefixMapping(java.lang.String prefix)
void	endUnmappedElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName)
java.lang.Object	get(DatabaseField key) INTERNAL: Retrieve the value for the field.
NodeValue	getAttributeChildNodeValue(java.lang.String namespace, java.lang.String localName)
org.xml.sax.Attributes	getAttributes()
java.lang.CharSequence	getCharacters()
UnmarshalRecord	getChildRecord()
UnmarshalRecord	getChildUnmarshalRecord(TreeObjectBuilder treeObjectBuilder)
java.lang.Object	getContainerInstance(ContainerValue c)
java.lang.Object	getContainerInstance(ContainerValue c, boolean createContainerIfNecessary)
XMLDescriptor	getDescriptor()
org.w3c.dom.Document	getDocument() PUBLIC: Return the document.
org.xml.sax.Locator	getDocumentLocator()
org.w3c.dom.Element	getDOM() PUBLIC: Return the DOM.
java.lang.String	getEncoding() PUBLIC: Gets the encoding for this document.
SAXFragmentBuilder	getFragmentBuilder()
int	getLevelIndex()
java.lang.String	getLocalName() PUBLIC: Get the local name of the context root element.
char	getNamespaceSeparator() INTERNAL: The character used to separate the prefix and uri portions when namespaces are present
java.lang.String	getNamespaceURI() PUBLIC: Get the namespace URI for the context root element.
java.lang.String	getNoNamespaceSchemaLocation()
XPathNode	getNonAttributeXPathNode(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attributes) INTERNAL:
java.util.List	getNullCapableValues()
UnmarshalRecord	getParentRecord()
java.util.Map<java.lang.String,java.lang.String>	getPrefixesForFragment() INTERNAL Returns a Map of any prefix mappings that were made before the most recent start element event.
ReferenceResolver	getReferenceResolver() INTERNAL: The ReferenceResolver that is leveraged by key based mappings.
java.lang.String	getRootElementName() Return the root element's prefix qualified name
java.lang.String	getRootElementNamespaceUri() Return the root element's namespace URI
java.lang.String	getSchemaLocation()
NodeValue	getSelfNodeValueForAttribute(java.lang.String namespace, java.lang.String localName)
XPathFragment	getTextWrapperFragment()
DOMRecord	getTransformationRecord()
javax.xml.namespace.QName	getTypeQName()
UnmarshalContext	getUnmarshalContext()
UnmarshalNamespaceResolver	getUnmarshalNamespaceResolver()
java.lang.String	getVersion() PUBLIC: Gets the XML Version for this document.
XMLReader	getXMLReader()
XPathNode	getXPathNode()
void	ignorableWhitespace(char[] ch, int start, int length)
void	initializeRecord(XMLMapping selfRecordMapping)
boolean	isBufferCDATA()
boolean	isNil()
boolean	isSelfRecord() Indicates if this UnmarshalRecord represents a 'self' record
void	processingInstruction(java.lang.String target, java.lang.String data)
void	reference(Reference reference)
void	removeNullCapableValue(NullCapableValue nullCapableValue)
void	resetStringBuffer()
java.lang.String	resolveNamespacePrefix(java.lang.String prefix)
java.lang.String	resolveNamespaceUri(java.lang.String uri)
void	resolveReferences(AbstractSession abstractSession, IDResolver idResolver) INTERNAL: If the UnmarshalRecord has a ReferenceResolver, tell it to resolve its references.
void	setAttributes(org.xml.sax.Attributes attributes)
void	setAttributeValue(java.lang.Object value, DatabaseMapping mapping)
void	setAttributeValueNull(ContainerValue containerValue)
void	setChildRecord(UnmarshalRecord childRecord)
void	setContainerInstance(int index, java.lang.Object containerInstance)
void	setDocumentLocator(org.xml.sax.Locator locator)
void	setEncoding(java.lang.String enc) INTERNAL:
void	setFragmentBuilder(SAXFragmentBuilder builder)
void	setLocalName(java.lang.String localName)
void	setNil(boolean nil) This method can be used to track that the current element is nil
void	setNoNamespaceSchemaLocation(java.lang.String location)
void	setParentRecord(UnmarshalRecord parentRecord)
void	setReferenceResolver(ReferenceResolver referenceResolver) INTERNAL: Set the ReferenceResolver that will be leveraged by key based mappings.
void	setRootElementName(java.lang.String qName)
void	setRootElementNamespaceUri(java.lang.String uri)
void	setSchemaLocation(java.lang.String schemaLocation)
void	setSelfRecord(boolean isSelfRecord) Sets the flag which indicates if this UnmarshalRecord represents a 'self' record
void	setTransformationRecord(DOMRecord transformationRecord)
void	setTypeQName(javax.xml.namespace.QName typeQName)
void	setUnmarshalContext(UnmarshalContext unmarshalContext)
void	setUnmarshaller(XMLUnmarshaller unmarshaller) INTERNAL:
void	setUnmarshalNamespaceResolver(UnmarshalNamespaceResolver anUnmarshalNamespaceResolver)
void	setVersion(java.lang.String version) INTERNAL:
void	setXMLReader(XMLReader xmlReader)
void	skippedEntity(java.lang.String name)
void	startCDATA()
void	startDocument()
void	startDTD(java.lang.String a, java.lang.String b, java.lang.String c)
void	startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts)
void	startEntity(java.lang.String entity)
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri)
void	startUnmappedElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts)
java.lang.String	toString() INTERNAL:
java.lang.String	transformToXML() Return the XML string representation of the DOM.
void	unmappedContent()

Methods inherited from class org.eclipse.persistence.oxm.record.XMLRecord

attribute, attributeWithoutQName, contains, get, getCurrentObject, getDocPresPolicy, getIndicatingNoEntry, getLeafElementType, getMarshaller, getNamespaceResolver, getOwningObject, getSession, getUnmarshaller, hasCustomNamespaceMapper, hasEqualNamespaceResolvers, isNamespaceAware, isXOPPackage, namespaceDeclaration, put, setCurrentObject, setCustomNamespaceMapper, setDocPresPolicy, setEqualNamespaceResolvers, setLeafElementType, setLeafElementType, setMarshaller, setNamespaceResolver, setOwningObject, setSession, setXOPPackage

Methods inherited from class org.eclipse.persistence.internal.sessions.AbstractRecord

add, clone, containsKey, containsKey, containsKey, containsValue, elements, entrySet, get, getField, getFields, getIndicatingNoEntry, getValues, getValues, getValues, hasNullValueInFields, isEmpty, keys, keySet, mergeFrom, put, put, putAll, remove, remove, remove, replaceAt, setNullValueInFields, size, values

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

DEFAULT_UNMAPPED_CONTENT_HANDLER

public static final UnmappedContentHandler DEFAULT_UNMAPPED_CONTENT_HANDLER

Constructor Detail

UnmarshalRecord

public UnmarshalRecord(TreeObjectBuilder treeObjectBuilder)

Method Detail

getLocalName

public java.lang.String getLocalName()

Description copied from class: XMLRecord

PUBLIC: Get the local name of the context root element.

Specified by:

getLocalName in class XMLRecord

setLocalName

public void setLocalName(java.lang.String localName)

getNamespaceURI

public java.lang.String getNamespaceURI()

Description copied from class: XMLRecord

PUBLIC: Get the namespace URI for the context root element.

Specified by:

getNamespaceURI in class XMLRecord

clear

public void clear()

Description copied from class: XMLRecord

PUBLIC: Clear the sub-nodes of the DOM.

Specified by:

clear in interface java.util.Map

Specified by:

clear in class XMLRecord

getDocument

public org.w3c.dom.Document getDocument()

Description copied from class: XMLRecord

PUBLIC: Return the document.

Specified by:

getDocument in class XMLRecord

getDOM

public org.w3c.dom.Element getDOM()

Description copied from class: XMLRecord

PUBLIC: Return the DOM.

Specified by:

getDOM in class XMLRecord

transformToXML

public java.lang.String transformToXML()

Description copied from class: XMLRecord

Return the XML string representation of the DOM.

Specified by:

transformToXML in class XMLRecord

getXMLReader

public XMLReader getXMLReader()

setXMLReader

public void setXMLReader(XMLReader xmlReader)

getChildRecord

public UnmarshalRecord getChildRecord()

setChildRecord

public void setChildRecord(UnmarshalRecord childRecord)

getParentRecord

public UnmarshalRecord getParentRecord()

getReferenceResolver

public ReferenceResolver getReferenceResolver()

INTERNAL: The ReferenceResolver that is leveraged by key based mappings.

Since:

EclipseLink 2.5.0

setReferenceResolver

public void setReferenceResolver(ReferenceResolver referenceResolver)

INTERNAL: Set the ReferenceResolver that will be leveraged by key based mappings.

Since:

EclipseLink 2.5.0

getRootElementName

public java.lang.String getRootElementName()

Return the root element's prefix qualified name

setRootElementName

public void setRootElementName(java.lang.String qName)

getRootElementNamespaceUri

public java.lang.String getRootElementNamespaceUri()

Return the root element's namespace URI

setRootElementNamespaceUri

public void setRootElementNamespaceUri(java.lang.String uri)

setParentRecord

public void setParentRecord(UnmarshalRecord parentRecord)

getTransformationRecord

public DOMRecord getTransformationRecord()

setTransformationRecord

public void setTransformationRecord(DOMRecord transformationRecord)

getUnmarshalNamespaceResolver

public UnmarshalNamespaceResolver getUnmarshalNamespaceResolver()

setUnmarshalNamespaceResolver

public void setUnmarshalNamespaceResolver(UnmarshalNamespaceResolver anUnmarshalNamespaceResolver)

getNullCapableValues

public java.util.List getNullCapableValues()

removeNullCapableValue

public void removeNullCapableValue(NullCapableValue nullCapableValue)

getContainerInstance

public java.lang.Object getContainerInstance(ContainerValue c)

getContainerInstance

public java.lang.Object getContainerInstance(ContainerValue c,
                                             boolean createContainerIfNecessary)

setContainerInstance

public void setContainerInstance(int index,
                                 java.lang.Object containerInstance)

getEncoding

public java.lang.String getEncoding()

PUBLIC: Gets the encoding for this document. Only set on the root-level UnmarshalRecord

Returns:

a String representing the encoding for this doc

setEncoding

public void setEncoding(java.lang.String enc)

INTERNAL:

getVersion

public java.lang.String getVersion()

PUBLIC: Gets the XML Version for this document. Only set on the root-level UnmarshalRecord, if supported by the parser.

setVersion

public void setVersion(java.lang.String version)

INTERNAL:

getSchemaLocation

public java.lang.String getSchemaLocation()

setSchemaLocation

public void setSchemaLocation(java.lang.String schemaLocation)

getNoNamespaceSchemaLocation

public java.lang.String getNoNamespaceSchemaLocation()

setNoNamespaceSchemaLocation

public void setNoNamespaceSchemaLocation(java.lang.String location)

getCharacters

public java.lang.CharSequence getCharacters()

getAttributes

public org.xml.sax.Attributes getAttributes()

setAttributes

public void setAttributes(org.xml.sax.Attributes attributes)

getTypeQName

public javax.xml.namespace.QName getTypeQName()

setTypeQName

public void setTypeQName(javax.xml.namespace.QName typeQName)

setDocumentLocator

public void setDocumentLocator(org.xml.sax.Locator locator)

Specified by:

setDocumentLocator in interface org.xml.sax.ContentHandler

getDocumentLocator

public org.xml.sax.Locator getDocumentLocator()

get

public java.lang.Object get(DatabaseField key)

Description copied from class: XMLRecord

INTERNAL: Retrieve the value for the field. If missing null is returned.

Overrides:

get in class XMLRecord

getXPathNode

public XPathNode getXPathNode()

getDescriptor

public XMLDescriptor getDescriptor()

getUnmarshalContext

public UnmarshalContext getUnmarshalContext()

setUnmarshalContext

public void setUnmarshalContext(UnmarshalContext unmarshalContext)

isNil

public boolean isNil()

setNil

public void setNil(boolean nil)

Description copied from interface: ExtendedContentHandler

This method can be used to track that the current element is nil

Specified by:

setNil in interface ExtendedContentHandler

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

initializeRecord

public void initializeRecord(XMLMapping selfRecordMapping)
                      throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                               java.lang.String uri)
                        throws org.xml.sax.SAXException

Specified by:

startPrefixMapping in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)
                      throws org.xml.sax.SAXException

Specified by:

endPrefixMapping in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

startElement

public void startElement(java.lang.String namespaceURI,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes atts)
                  throws org.xml.sax.SAXException

Specified by:

startElement in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

startUnmappedElement

public void startUnmappedElement(java.lang.String namespaceURI,
                                 java.lang.String localName,
                                 java.lang.String qName,
                                 org.xml.sax.Attributes atts)
                          throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

endElement

public void endElement(java.lang.String namespaceURI,
                       java.lang.String localName,
                       java.lang.String qName)
                throws org.xml.sax.SAXException

Specified by:

endElement in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

endUnmappedElement

public void endUnmappedElement(java.lang.String namespaceURI,
                               java.lang.String localName,
                               java.lang.String qName)
                        throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws org.xml.sax.SAXException

Specified by:

characters in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

characters

public void characters(java.lang.CharSequence characters)
                throws org.xml.sax.SAXException

Specified by:

characters in interface ExtendedContentHandler

Throws:

org.xml.sax.SAXException

ignorableWhitespace

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

Specified by:

ignorableWhitespace in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

processingInstruction

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

Specified by:

processingInstruction in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

skippedEntity

public void skippedEntity(java.lang.String name)
                   throws org.xml.sax.SAXException

Specified by:

skippedEntity in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

getNonAttributeXPathNode

public XPathNode getNonAttributeXPathNode(java.lang.String namespaceURI,
                                          java.lang.String localName,
                                          java.lang.String qName,
                                          org.xml.sax.Attributes attributes)

INTERNAL:

resolveNamespacePrefix

public java.lang.String resolveNamespacePrefix(java.lang.String prefix)

Overrides:

resolveNamespacePrefix in class XMLRecord

resolveNamespaceUri

public java.lang.String resolveNamespaceUri(java.lang.String uri)

toString

public java.lang.String toString()

Description copied from class: AbstractRecord

INTERNAL:

Overrides:

toString in class AbstractRecord

getSelfNodeValueForAttribute

public NodeValue getSelfNodeValueForAttribute(java.lang.String namespace,
                                              java.lang.String localName)

getAttributeChildNodeValue

public NodeValue getAttributeChildNodeValue(java.lang.String namespace,
                                            java.lang.String localName)

getFragmentBuilder

public SAXFragmentBuilder getFragmentBuilder()

setFragmentBuilder

public void setFragmentBuilder(SAXFragmentBuilder builder)

resetStringBuffer

public void resetStringBuffer()

isBufferCDATA

public boolean isBufferCDATA()

comment

public void comment(char[] data,
                    int start,
                    int length)

Specified by:

comment in interface org.xml.sax.ext.LexicalHandler

startCDATA

public void startCDATA()

Specified by:

startCDATA in interface org.xml.sax.ext.LexicalHandler

endCDATA

public void endCDATA()

Specified by:

endCDATA in interface org.xml.sax.ext.LexicalHandler

startEntity

public void startEntity(java.lang.String entity)

Specified by:

startEntity in interface org.xml.sax.ext.LexicalHandler

endEntity

public void endEntity(java.lang.String entity)

Specified by:

endEntity in interface org.xml.sax.ext.LexicalHandler

startDTD

public void startDTD(java.lang.String a,
                     java.lang.String b,
                     java.lang.String c)

Specified by:

startDTD in interface org.xml.sax.ext.LexicalHandler

endDTD

public void endDTD()

Specified by:

endDTD in interface org.xml.sax.ext.LexicalHandler

setSelfRecord

public void setSelfRecord(boolean isSelfRecord)

Sets the flag which indicates if this UnmarshalRecord represents a 'self' record

Parameters:

isSelfRecord - true if this record represents 'self', false otherwise

isSelfRecord

public boolean isSelfRecord()

Indicates if this UnmarshalRecord represents a 'self' record

Returns:

true if this record represents 'self', false otherwise

getLevelIndex

public int getLevelIndex()

setAttributeValue

public void setAttributeValue(java.lang.Object value,
                              DatabaseMapping mapping)

addAttributeValue

public void addAttributeValue(ContainerValue containerValue,
                              java.lang.Object value)

addAttributeValue

public void addAttributeValue(ContainerValue containerValue,
                              java.lang.Object value,
                              java.lang.Object collection)

setAttributeValueNull

public void setAttributeValueNull(ContainerValue containerValue)

reference

public void reference(Reference reference)

unmappedContent

public void unmappedContent()

getChildUnmarshalRecord

public UnmarshalRecord getChildUnmarshalRecord(TreeObjectBuilder treeObjectBuilder)

setUnmarshaller

public void setUnmarshaller(XMLUnmarshaller unmarshaller)

INTERNAL:

Overrides:

setUnmarshaller in class XMLRecord

getPrefixesForFragment

public java.util.Map<java.lang.String,java.lang.String> getPrefixesForFragment()

INTERNAL Returns a Map of any prefix mappings that were made before the most recent start element event. This Map is used so the prefix mappings can be passed along to a fragment builder in the event that the element in question is going to be unmarshalled as a Node.

getNamespaceSeparator

public char getNamespaceSeparator()

Description copied from class: XMLRecord

INTERNAL: The character used to separate the prefix and uri portions when namespaces are present

Overrides:

getNamespaceSeparator in class XMLRecord

getTextWrapperFragment

public XPathFragment getTextWrapperFragment()

resolveReferences

public void resolveReferences(AbstractSession abstractSession,
                              IDResolver idResolver)

INTERNAL: If the UnmarshalRecord has a ReferenceResolver, tell it to resolve its references.

Since:

EclipseLink 2.5.0