public abstract class XMLRecord extends AbstractRecord implements AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>, AbstractUnmarshalRecord<AbstractSession,DatabaseField,XMLUnmarshaller>
AbstractRecord.NoEntry
XMLRecord.Nil
Modifier and Type | Field and Description |
---|---|
static XMLRecord.Nil |
NIL
INTERNAL:
Nil: This is used to indicate that this field represents xsi:nil="true"
|
noEntry
DEFAULT_ATTRIBUTE_GROUP
Constructor and Description |
---|
XMLRecord() |
Modifier and Type | Method and Description |
---|---|
java.util.List<Namespace> |
addExtraNamespacesToNamespaceResolver(Descriptor descriptor,
CoreAbstractSession session,
boolean allowOverride,
boolean ignoreEqualResolvers)
INTERNAL
|
boolean |
addXsiTypeAndClassIndicatorIfRequired(Descriptor descriptor,
Descriptor referenceDescriptor,
Field xmlField,
boolean isRootElement)
INTERNAL
|
boolean |
addXsiTypeAndClassIndicatorIfRequired(Descriptor descriptor,
Descriptor referenceDescriptor,
Field xmlField,
java.lang.Object originalObject,
java.lang.Object obj,
boolean wasXMLRoot,
boolean isRootElement)
INTERNAL
|
void |
attribute(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String qName,
java.lang.String value)
Marshal an attribute for the give namespaceURI, localName, qualifiedName and value
|
void |
attributeWithoutQName(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String prefix,
java.lang.String value)
Marshal an attribute for the give namespaceURI, localName, preifx and value
|
abstract void |
clear()
PUBLIC:
Clear the sub-nodes of the DOM.
|
boolean |
contains(java.lang.Object value)
PUBLIC:
Check if the value is contained in the row.
|
java.lang.Object |
get(DatabaseField key)
INTERNAL:
Retrieve the value for the field.
|
java.lang.Object |
get(java.lang.String key)
PUBLIC:
Add the field-value pair to the row.
|
ConversionManager |
getConversionManager()
INTERNAL
|
java.lang.Object |
getCurrentObject()
INTERNAL:
|
DocumentPreservationPolicy |
getDocPresPolicy() |
abstract org.w3c.dom.Document |
getDocument()
PUBLIC:
Return the document.
|
abstract org.w3c.dom.Node |
getDOM()
PUBLIC:
Return the DOM.
|
java.lang.Object |
getIndicatingNoEntry(java.lang.String fieldName)
INTERNAL:
Retrieve the value for the field name.
|
XPathQName |
getLeafElementType()
INTERNAL:
|
abstract java.lang.String |
getLocalName()
PUBLIC:
Get the local name of the context root element.
|
XMLMarshaller |
getMarshaller()
INTERNAL:
|
NamespaceResolver |
getNamespaceResolver() |
char |
getNamespaceSeparator()
INTERNAL:
The character used to separate the prefix and uri portions when namespaces are present
|
abstract java.lang.String |
getNamespaceURI()
PUBLIC:
Get the namespace URI for the context root element.
|
java.lang.Object |
getOwningObject()
INTERNAL:
|
AbstractSession |
getSession() |
XMLUnmarshaller |
getUnmarshaller()
INTERNAL:
|
boolean |
hasCustomNamespaceMapper() |
boolean |
hasEqualNamespaceResolvers() |
boolean |
isNamespaceAware()
INTERNAL:
Determine if namespaces will be considered during marshal/unmarshal operations.
|
boolean |
isXOPPackage() |
void |
namespaceDeclaration(java.lang.String prefix,
java.lang.String namespaceURI)
Marshal a namespace declaration for the given prefix and url
|
java.lang.Object |
put(java.lang.String key,
java.lang.Object value)
PUBLIC:
Add the field-value pair to the row.
|
void |
removeExtraNamespacesFromNamespaceResolver(java.util.List<Namespace> extraNamespaces,
CoreAbstractSession session)
INTERNAL
|
java.lang.String |
resolveNamespacePrefix(java.lang.String prefix) |
void |
setCurrentObject(java.lang.Object obj)
INTERNAL:
|
void |
setCustomNamespaceMapper(boolean customNamespaceMapper) |
void |
setDocPresPolicy(DocumentPreservationPolicy policy) |
void |
setEqualNamespaceResolvers(boolean equalNRs) |
void |
setLeafElementType(javax.xml.namespace.QName leafElementType)
INTERNAL:
|
void |
setLeafElementType(XPathQName leafElementType)
INTERNAL:
|
void |
setMarshaller(XMLMarshaller marshaller)
INTERNAL:
|
void |
setNamespaceResolver(NamespaceResolver nr) |
void |
setOwningObject(java.lang.Object owningObject)
INTERNAL:
|
void |
setSession(AbstractSession session) |
void |
setUnmarshaller(XMLUnmarshaller unmarshaller)
INTERNAL:
|
void |
setXOPPackage(boolean isXOPPackage) |
abstract java.lang.String |
transformToXML()
Return the XML string representation of the DOM.
|
void |
writeXsiTypeAttribute(Descriptor descriptor,
java.lang.String typeUri,
java.lang.String typeLocal,
java.lang.String typePrefix,
boolean addToNamespaceResolver)
INTERNAL
|
void |
writeXsiTypeAttribute(Descriptor xmlDescriptor,
XMLSchemaReference xmlRef,
boolean addToNamespaceResolver)
INTERNAL
|
add, clone, containsKey, containsKey, containsKey, containsValue, elements, entrySet, get, getField, getFields, getIndicatingNoEntry, getSopObject, getValues, getValues, getValues, hasNullValueInFields, hasSopObject, isEmpty, keys, keySet, mergeFrom, put, put, putAll, remove, remove, remove, replaceAt, replaceAt, setNullValueInFields, setSopObject, size, toString, values
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
put
public static final XMLRecord.Nil NIL
public java.lang.Object get(java.lang.String key)
get
in class AbstractRecord
public java.lang.Object put(java.lang.String key, java.lang.Object value)
put
in class AbstractRecord
public void attributeWithoutQName(java.lang.String namespaceURI, java.lang.String localName, java.lang.String prefix, java.lang.String value)
attributeWithoutQName
in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
namespaceURI
- localName
- prefix
- value
- public void attribute(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, java.lang.String value)
attribute
in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
namespaceURI
- localName
- qName
- value
- public void namespaceDeclaration(java.lang.String prefix, java.lang.String namespaceURI)
namespaceDeclaration
in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
prefix
- namespaceURI
- public abstract java.lang.String getLocalName()
public abstract java.lang.String getNamespaceURI()
public abstract void clear()
clear
in interface java.util.Map
clear
in class AbstractRecord
public abstract org.w3c.dom.Document getDocument()
public boolean contains(java.lang.Object value)
contains
in class AbstractRecord
public abstract org.w3c.dom.Node getDOM()
getDOM
in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
public abstract java.lang.String transformToXML()
public java.lang.Object get(DatabaseField key)
get
in interface AbstractUnmarshalRecord<AbstractSession,DatabaseField,XMLUnmarshaller>
get
in class AbstractRecord
public java.lang.Object getIndicatingNoEntry(java.lang.String fieldName)
getIndicatingNoEntry
in class AbstractRecord
public java.lang.String resolveNamespacePrefix(java.lang.String prefix)
resolveNamespacePrefix
in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
resolveNamespacePrefix
in interface AbstractUnmarshalRecord<AbstractSession,DatabaseField,XMLUnmarshaller>
public XMLMarshaller getMarshaller()
getMarshaller
in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
public void setMarshaller(XMLMarshaller marshaller)
setMarshaller
in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
public XMLUnmarshaller getUnmarshaller()
getUnmarshaller
in interface AbstractUnmarshalRecord<AbstractSession,DatabaseField,XMLUnmarshaller>
public void setUnmarshaller(XMLUnmarshaller unmarshaller)
public void setDocPresPolicy(DocumentPreservationPolicy policy)
public DocumentPreservationPolicy getDocPresPolicy()
public java.lang.Object getOwningObject()
getOwningObject
in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
public void setOwningObject(java.lang.Object owningObject)
setOwningObject
in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
public java.lang.Object getCurrentObject()
public void setCurrentObject(java.lang.Object obj)
public XPathQName getLeafElementType()
getLeafElementType
in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
public void setLeafElementType(XPathQName leafElementType)
setLeafElementType
in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
public void setLeafElementType(javax.xml.namespace.QName leafElementType)
setLeafElementType
in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
public void setNamespaceResolver(NamespaceResolver nr)
setNamespaceResolver
in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
public NamespaceResolver getNamespaceResolver()
getNamespaceResolver
in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
public AbstractSession getSession()
getSession
in interface XMLRecord<AbstractSession>
public void setSession(AbstractSession session)
setSession
in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
public void setEqualNamespaceResolvers(boolean equalNRs)
setEqualNamespaceResolvers
in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
public boolean hasEqualNamespaceResolvers()
hasEqualNamespaceResolvers
in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
public boolean isXOPPackage()
isXOPPackage
in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
public void setXOPPackage(boolean isXOPPackage)
setXOPPackage
in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
public boolean isNamespaceAware()
isNamespaceAware
in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
isNamespaceAware
in interface XMLRecord<AbstractSession>
public char getNamespaceSeparator()
getNamespaceSeparator
in interface XMLRecord<AbstractSession>
public boolean hasCustomNamespaceMapper()
hasCustomNamespaceMapper
in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
public void setCustomNamespaceMapper(boolean customNamespaceMapper)
setCustomNamespaceMapper
in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
public java.util.List<Namespace> addExtraNamespacesToNamespaceResolver(Descriptor descriptor, CoreAbstractSession session, boolean allowOverride, boolean ignoreEqualResolvers)
addExtraNamespacesToNamespaceResolver
in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
public boolean addXsiTypeAndClassIndicatorIfRequired(Descriptor descriptor, Descriptor referenceDescriptor, Field xmlField, boolean isRootElement)
addXsiTypeAndClassIndicatorIfRequired
in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
public boolean addXsiTypeAndClassIndicatorIfRequired(Descriptor descriptor, Descriptor referenceDescriptor, Field xmlField, java.lang.Object originalObject, java.lang.Object obj, boolean wasXMLRoot, boolean isRootElement)
addXsiTypeAndClassIndicatorIfRequired
in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
public void removeExtraNamespacesFromNamespaceResolver(java.util.List<Namespace> extraNamespaces, CoreAbstractSession session)
removeExtraNamespacesFromNamespaceResolver
in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
public void writeXsiTypeAttribute(Descriptor descriptor, java.lang.String typeUri, java.lang.String typeLocal, java.lang.String typePrefix, boolean addToNamespaceResolver)
writeXsiTypeAttribute
in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
public void writeXsiTypeAttribute(Descriptor xmlDescriptor, XMLSchemaReference xmlRef, boolean addToNamespaceResolver)
writeXsiTypeAttribute
in interface AbstractMarshalRecord<AbstractSession,DatabaseField,XMLMarshaller,NamespaceResolver>
public ConversionManager getConversionManager()
getConversionManager
in interface XMLRecord<AbstractSession>
EclipseLink 2.6.3, "build v20160428-59c81c5" API Reference