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:
XPathNode
,
NodeValue
,
TreeObjectBuilder
,
Serialized FormAbstractRecord.NoEntry
Modifier and Type | Field and Description |
---|---|
static UnmappedContentHandler |
DEFAULT_UNMAPPED_CONTENT_HANDLER |
noEntry
Constructor and Description |
---|
UnmarshalRecord(TreeObjectBuilder treeObjectBuilder) |
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() |
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
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
public static final UnmappedContentHandler DEFAULT_UNMAPPED_CONTENT_HANDLER
public UnmarshalRecord(TreeObjectBuilder treeObjectBuilder)
public java.lang.String getLocalName()
XMLRecord
getLocalName
in class XMLRecord
public void setLocalName(java.lang.String localName)
public java.lang.String getNamespaceURI()
XMLRecord
getNamespaceURI
in class XMLRecord
public void clear()
XMLRecord
public org.w3c.dom.Document getDocument()
XMLRecord
getDocument
in class XMLRecord
public org.w3c.dom.Element getDOM()
XMLRecord
public java.lang.String transformToXML()
XMLRecord
transformToXML
in class XMLRecord
public XMLReader getXMLReader()
public void setXMLReader(XMLReader xmlReader)
public UnmarshalRecord getChildRecord()
public void setChildRecord(UnmarshalRecord childRecord)
public UnmarshalRecord getParentRecord()
public ReferenceResolver getReferenceResolver()
public void setReferenceResolver(ReferenceResolver referenceResolver)
public java.lang.String getRootElementName()
public void setRootElementName(java.lang.String qName)
public java.lang.String getRootElementNamespaceUri()
public void setRootElementNamespaceUri(java.lang.String uri)
public void setParentRecord(UnmarshalRecord parentRecord)
public DOMRecord getTransformationRecord()
public void setTransformationRecord(DOMRecord transformationRecord)
public UnmarshalNamespaceResolver getUnmarshalNamespaceResolver()
public void setUnmarshalNamespaceResolver(UnmarshalNamespaceResolver anUnmarshalNamespaceResolver)
public java.util.List getNullCapableValues()
public void removeNullCapableValue(NullCapableValue nullCapableValue)
public java.lang.Object getContainerInstance(ContainerValue c)
public java.lang.Object getContainerInstance(ContainerValue c, boolean createContainerIfNecessary)
public void setContainerInstance(int index, java.lang.Object containerInstance)
public java.lang.String getEncoding()
public void setEncoding(java.lang.String enc)
public java.lang.String getVersion()
public void setVersion(java.lang.String version)
public java.lang.String getSchemaLocation()
public void setSchemaLocation(java.lang.String schemaLocation)
public java.lang.String getNoNamespaceSchemaLocation()
public void setNoNamespaceSchemaLocation(java.lang.String location)
public java.lang.CharSequence getCharacters()
public org.xml.sax.Attributes getAttributes()
public void setAttributes(org.xml.sax.Attributes attributes)
public javax.xml.namespace.QName getTypeQName()
public void setTypeQName(javax.xml.namespace.QName typeQName)
public void setDocumentLocator(org.xml.sax.Locator locator)
setDocumentLocator
in interface org.xml.sax.ContentHandler
public org.xml.sax.Locator getDocumentLocator()
public java.lang.Object get(DatabaseField key)
XMLRecord
public XPathNode getXPathNode()
public XMLDescriptor getDescriptor()
public UnmarshalContext getUnmarshalContext()
public void setUnmarshalContext(UnmarshalContext unmarshalContext)
public boolean isNil()
public void setNil(boolean nil)
ExtendedContentHandler
setNil
in interface ExtendedContentHandler
public void startDocument() throws org.xml.sax.SAXException
startDocument
in interface org.xml.sax.ContentHandler
org.xml.sax.SAXException
public void initializeRecord(XMLMapping selfRecordMapping) throws org.xml.sax.SAXException
org.xml.sax.SAXException
public void endDocument() throws org.xml.sax.SAXException
endDocument
in interface org.xml.sax.ContentHandler
org.xml.sax.SAXException
public void startPrefixMapping(java.lang.String prefix, java.lang.String uri) throws org.xml.sax.SAXException
startPrefixMapping
in interface org.xml.sax.ContentHandler
org.xml.sax.SAXException
public void endPrefixMapping(java.lang.String prefix) throws org.xml.sax.SAXException
endPrefixMapping
in interface org.xml.sax.ContentHandler
org.xml.sax.SAXException
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
startElement
in interface org.xml.sax.ContentHandler
org.xml.sax.SAXException
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
org.xml.sax.SAXException
public void endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName) throws org.xml.sax.SAXException
endElement
in interface org.xml.sax.ContentHandler
org.xml.sax.SAXException
public void endUnmappedElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName) throws org.xml.sax.SAXException
org.xml.sax.SAXException
public void characters(char[] ch, int start, int length) throws org.xml.sax.SAXException
characters
in interface org.xml.sax.ContentHandler
org.xml.sax.SAXException
public void characters(java.lang.CharSequence characters) throws org.xml.sax.SAXException
characters
in interface ExtendedContentHandler
org.xml.sax.SAXException
public void ignorableWhitespace(char[] ch, int start, int length) throws org.xml.sax.SAXException
ignorableWhitespace
in interface org.xml.sax.ContentHandler
org.xml.sax.SAXException
public void processingInstruction(java.lang.String target, java.lang.String data) throws org.xml.sax.SAXException
processingInstruction
in interface org.xml.sax.ContentHandler
org.xml.sax.SAXException
public void skippedEntity(java.lang.String name) throws org.xml.sax.SAXException
skippedEntity
in interface org.xml.sax.ContentHandler
org.xml.sax.SAXException
public XPathNode getNonAttributeXPathNode(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attributes)
public java.lang.String resolveNamespacePrefix(java.lang.String prefix)
resolveNamespacePrefix
in class XMLRecord
public java.lang.String resolveNamespaceUri(java.lang.String uri)
public java.lang.String toString()
AbstractRecord
toString
in class AbstractRecord
public NodeValue getSelfNodeValueForAttribute(java.lang.String namespace, java.lang.String localName)
public NodeValue getAttributeChildNodeValue(java.lang.String namespace, java.lang.String localName)
public SAXFragmentBuilder getFragmentBuilder()
public void setFragmentBuilder(SAXFragmentBuilder builder)
public void resetStringBuffer()
public boolean isBufferCDATA()
public void comment(char[] data, int start, int length)
comment
in interface org.xml.sax.ext.LexicalHandler
public void startCDATA()
startCDATA
in interface org.xml.sax.ext.LexicalHandler
public void endCDATA()
endCDATA
in interface org.xml.sax.ext.LexicalHandler
public void startEntity(java.lang.String entity)
startEntity
in interface org.xml.sax.ext.LexicalHandler
public void endEntity(java.lang.String entity)
endEntity
in interface org.xml.sax.ext.LexicalHandler
public void startDTD(java.lang.String a, java.lang.String b, java.lang.String c)
startDTD
in interface org.xml.sax.ext.LexicalHandler
public void endDTD()
endDTD
in interface org.xml.sax.ext.LexicalHandler
public void setSelfRecord(boolean isSelfRecord)
isSelfRecord
- true if this record represents
'self', false otherwisepublic boolean isSelfRecord()
public int getLevelIndex()
public void setAttributeValue(java.lang.Object value, DatabaseMapping mapping)
public void addAttributeValue(ContainerValue containerValue, java.lang.Object value)
public void addAttributeValue(ContainerValue containerValue, java.lang.Object value, java.lang.Object collection)
public void setAttributeValueNull(ContainerValue containerValue)
public void reference(Reference reference)
public void unmappedContent()
public UnmarshalRecord getChildUnmarshalRecord(TreeObjectBuilder treeObjectBuilder)
public void setUnmarshaller(XMLUnmarshaller unmarshaller)
setUnmarshaller
in class XMLRecord
public java.util.Map<java.lang.String,java.lang.String> getPrefixesForFragment()
public char getNamespaceSeparator()
XMLRecord
getNamespaceSeparator
in class XMLRecord
public XPathFragment getTextWrapperFragment()
public void resolveReferences(AbstractSession abstractSession, IDResolver idResolver)
EclipseLink 2.4.2, "build v20130514-5956486" API Reference