Module org.eclipse.persistence.core

Package org.eclipse.persistence.internal.oxm.record

Interface UnmarshalRecord<ABSTRACT_SESSION extends CoreAbstractSession,FIELD extends CoreField,ID_RESOLVER extends IDResolver,OBJECT_BUILDER extends ObjectBuilder,TRANSFORMATION_RECORD extends TransformationRecord,UNMARSHALLER extends Unmarshaller>

All Superinterfaces:

AbstractUnmarshalRecord<ABSTRACT_SESSION,FIELD,UNMARSHALLER>, ContentHandler, ExtendedContentHandler, LexicalHandler, XMLRecord<ABSTRACT_SESSION>

All Known Implementing Classes:

BinaryDataUnmarshalRecord, UnmappedContentHandlerWrapper, UnmarshalRecord, UnmarshalRecordImpl, XMLBinaryAttachmentHandler, XMLInlineBinaryHandler, XMLRootRecord

public interface UnmarshalRecord<ABSTRACT_SESSION extends CoreAbstractSession,FIELD extends CoreField,ID_RESOLVER extends IDResolver,OBJECT_BUILDER extends ObjectBuilder,TRANSFORMATION_RECORD extends TransformationRecord,UNMARSHALLER extends Unmarshaller>
extends AbstractUnmarshalRecord<ABSTRACT_SESSION,FIELD,UNMARSHALLER>, ExtendedContentHandler, LexicalHandler

This class represents unmarshal record behaviour that is specific to the SAX platform.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.persistence.internal.oxm.record.XMLRecord

XMLRecord.Nil

Field Summary

Fields

Modifier and Type	Field	Description
static final UnmappedContentHandler	DEFAULT_UNMAPPED_CONTENT_HANDLER

Fields inherited from interface org.eclipse.persistence.internal.oxm.record.XMLRecord

DEFAULT_ATTRIBUTE_GROUP, NIL

Method Summary

Modifier and Type	Method	Description
void	addAttributeValue(ContainerValue containerValue, Object value)
void	addAttributeValue(ContainerValue containerValue, Object value, Object collection)
Root	createRoot()
void	endUnmappedElement(String uri, String localName, String name)
NodeValue	getAttributeChildNodeValue(String namespace, String localName)
Attributes	getAttributes()
CharSequence	getCharacters()
UnmarshalRecord	getChildRecord()
UnmarshalRecord	getChildUnmarshalRecord(OBJECT_BUILDER targetObjectBuilder)
Object	getContainerInstance(ContainerValue containerValue)
Object	getContainerInstance(ContainerValue containerValue, boolean b)
Object	getCurrentObject()
Descriptor	getDescriptor()
String	getEncoding()	Gets the encoding for this document.
SAXFragmentBuilder	getFragmentBuilder()
XPathQName	getLeafElementType()
int	getLevelIndex()
String	getLocalName()
String	getNoNamespaceSchemaLocation()
XPathNode	getNonAttributeXPathNode(String namespaceURI, String localName, String qName, Attributes attributes)
List<NullCapableValue>	getNullCapableValues()
UnmarshalRecord	getParentRecord()
Map<String,String>	getPrefixesForFragment()
ReferenceResolver	getReferenceResolver()
String	getRootElementName()
String	getRootElementNamespaceUri()
String	getSchemaLocation()
XPathFragment	getTextWrapperFragment()
TRANSFORMATION_RECORD	getTransformationRecord()
QName	getTypeQName()
CoreAttributeGroup	getUnmarshalAttributeGroup()
UnmarshalContext	getUnmarshalContext()
UNMARSHALLER	getUnmarshaller()
UnmarshalNamespaceResolver	getUnmarshalNamespaceResolver()
String	getVersion()	Gets the XML Version for this document.
XMLReader	getXMLReader()
XPathNode	getXPathNode()
UnmarshalRecord	initialize(OBJECT_BUILDER objectBuilder)
void	initializeRecord(Mapping mapping)
boolean	isBufferCDATA()
boolean	isNil()
boolean	isSelfRecord()
void	reference(Reference reference)
void	removeNullCapableValue(NullCapableValue nullCapableValue)
void	resetStringBuffer()
String	resolveNamespaceUri(String namespaceURI)
void	resolveReferences(ABSTRACT_SESSION session, ID_RESOLVER idResolver)
void	setAttributes(Attributes atts)
void	setAttributeValue(Object object, Mapping mapping)
void	setAttributeValueNull(ContainerValue containerValue)
void	setChildRecord(UnmarshalRecord unmarshalRecord)
void	setContainerInstance(int index, Object containerInstance)
void	setCurrentObject(Object object)
void	setFragmentBuilder(SAXFragmentBuilder fragmentBuilder)
void	setLeafElementType(QName leafElementType)
void	setLocalName(String localName)
void	setNil(boolean isNil)	This method can be used to track that the current element is nil
void	setParentRecord(UnmarshalRecord unmarshalRecord)
void	setReferenceResolver(ReferenceResolver referenceResolver)
void	setRootElementName(String rootElementName)
void	setRootElementNamespaceUri(String rootElementNamespaceUri)
void	setSelfRecord(boolean isSelfRecord)
void	setSession(ABSTRACT_SESSION session)
void	setTextWrapperFragment(XPathFragment textWrapperFragment)
void	setTransformationRecord(TRANSFORMATION_RECORD transformationRecord)
void	setTypeQName(QName qname)
void	setUnmarshalAttributeGroup(CoreAttributeGroup group)
void	setUnmarshalContext(UnmarshalContext unmarshalContext)
void	setUnmarshaller(UNMARSHALLER unmarshaller)
void	setUnmarshalNamespaceResolver(UnmarshalNamespaceResolver unmarshalNamespaceResolver)
void	setXMLReader(XMLReader xmlReader)
void	unmappedContent()

Methods inherited from interface org.eclipse.persistence.internal.oxm.record.AbstractUnmarshalRecord

get, resolveNamespacePrefix

Methods inherited from interface org.xml.sax.ContentHandler

characters, declaration, endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping

Methods inherited from interface org.eclipse.persistence.internal.oxm.record.ExtendedContentHandler

characters

Methods inherited from interface org.xml.sax.ext.LexicalHandler

comment, endCDATA, endDTD, endEntity, startCDATA, startDTD, startEntity

Methods inherited from interface org.eclipse.persistence.internal.oxm.record.XMLRecord

getConversionManager, getNamespaceSeparator, getSession, isNamespaceAware

Field Details

DEFAULT_UNMAPPED_CONTENT_HANDLER

static final UnmappedContentHandler DEFAULT_UNMAPPED_CONTENT_HANDLER

Method Details

addAttributeValue

void addAttributeValue(ContainerValue containerValue,
 Object value)

addAttributeValue

void addAttributeValue(ContainerValue containerValue,
 Object value,
 Object collection)

createRoot

Root createRoot()

endUnmappedElement

void endUnmappedElement(String uri,
 String localName,
 String name)
                 throws SAXException

Throws:

SAXException

getAttributeChildNodeValue

NodeValue getAttributeChildNodeValue(String namespace,
 String localName)

getAttributes

Attributes getAttributes()

getCharacters

CharSequence getCharacters()

getChildRecord

UnmarshalRecord getChildRecord()

getChildUnmarshalRecord

UnmarshalRecord getChildUnmarshalRecord(OBJECT_BUILDER targetObjectBuilder)

getContainerInstance

Object getContainerInstance(ContainerValue containerValue)

getContainerInstance

Object getContainerInstance(ContainerValue containerValue,
 boolean b)

getCurrentObject

Object getCurrentObject()

getDescriptor

Descriptor getDescriptor()

getEncoding

String getEncoding()

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

Returns:

a String representing the encoding for this doc

getFragmentBuilder

SAXFragmentBuilder getFragmentBuilder()

getLeafElementType

XPathQName getLeafElementType()

getLevelIndex

int getLevelIndex()

getLocalName

String getLocalName()

getNoNamespaceSchemaLocation

String getNoNamespaceSchemaLocation()

getNonAttributeXPathNode

XPathNode getNonAttributeXPathNode(String namespaceURI,
 String localName,
 String qName,
 Attributes attributes)

getNullCapableValues

List<NullCapableValue> getNullCapableValues()

getParentRecord

UnmarshalRecord getParentRecord()

getPrefixesForFragment

Map<String,String> getPrefixesForFragment()

getReferenceResolver

ReferenceResolver getReferenceResolver()

getRootElementName

String getRootElementName()

getRootElementNamespaceUri

String getRootElementNamespaceUri()

getSchemaLocation

String getSchemaLocation()

getTextWrapperFragment

XPathFragment getTextWrapperFragment()

getTransformationRecord

TRANSFORMATION_RECORD getTransformationRecord()

getTypeQName

QName getTypeQName()

getUnmarshalContext

UnmarshalContext getUnmarshalContext()

getUnmarshaller

UNMARSHALLER getUnmarshaller()

Specified by:

getUnmarshaller in interface AbstractUnmarshalRecord<ABSTRACT_SESSION extends CoreAbstractSession,FIELD extends CoreField,ID_RESOLVER extends IDResolver>

getUnmarshalNamespaceResolver

UnmarshalNamespaceResolver getUnmarshalNamespaceResolver()

getVersion

String getVersion()

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

getXMLReader

XMLReader getXMLReader()

getXPathNode

XPathNode getXPathNode()

initialize

UnmarshalRecord initialize(OBJECT_BUILDER objectBuilder)

initializeRecord

void initializeRecord(Mapping mapping)
               throws SAXException

Throws:

SAXException

isBufferCDATA

boolean isBufferCDATA()

isNil

boolean isNil()

isSelfRecord

boolean isSelfRecord()

reference

void reference(Reference reference)

removeNullCapableValue

void removeNullCapableValue(NullCapableValue nullCapableValue)

resetStringBuffer

void resetStringBuffer()

resolveNamespaceUri

String resolveNamespaceUri(String namespaceURI)

resolveReferences

void resolveReferences(ABSTRACT_SESSION session,
 ID_RESOLVER idResolver)

setAttributes

void setAttributes(Attributes atts)

setAttributeValue

void setAttributeValue(Object object,
 Mapping mapping)

setAttributeValueNull

void setAttributeValueNull(ContainerValue containerValue)

setChildRecord

void setChildRecord(UnmarshalRecord unmarshalRecord)

setContainerInstance

void setContainerInstance(int index,
 Object containerInstance)

setCurrentObject

void setCurrentObject(Object object)

setFragmentBuilder

void setFragmentBuilder(SAXFragmentBuilder fragmentBuilder)

setLeafElementType

void setLeafElementType(QName leafElementType)

setLocalName

void setLocalName(String localName)

setNil

void setNil(boolean isNil)

Description copied from interface: ExtendedContentHandler

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

Specified by:

setNil in interface ExtendedContentHandler

setParentRecord

void setParentRecord(UnmarshalRecord unmarshalRecord)

setReferenceResolver

void setReferenceResolver(ReferenceResolver referenceResolver)

setRootElementName

void setRootElementName(String rootElementName)

setRootElementNamespaceUri

void setRootElementNamespaceUri(String rootElementNamespaceUri)

setSelfRecord

void setSelfRecord(boolean isSelfRecord)

setSession

void setSession(ABSTRACT_SESSION session)

setTextWrapperFragment

void setTextWrapperFragment(XPathFragment textWrapperFragment)

setTransformationRecord

void setTransformationRecord(TRANSFORMATION_RECORD transformationRecord)

setTypeQName

void setTypeQName(QName qname)

setUnmarshalContext

void setUnmarshalContext(UnmarshalContext unmarshalContext)

setUnmarshaller

void setUnmarshaller(UNMARSHALLER unmarshaller)

setUnmarshalNamespaceResolver

void setUnmarshalNamespaceResolver(UnmarshalNamespaceResolver unmarshalNamespaceResolver)

setXMLReader

void setXMLReader(XMLReader xmlReader)

unmappedContent

void unmappedContent()

getUnmarshalAttributeGroup

CoreAttributeGroup getUnmarshalAttributeGroup()

setUnmarshalAttributeGroup

void setUnmarshalAttributeGroup(CoreAttributeGroup group)