Package org.eclipse.persistence.internal.oxm

Class XMLCollectionReferenceMappingMarshalNodeValue

java.lang.Object

org.eclipse.persistence.internal.oxm.NodeValue

org.eclipse.persistence.internal.oxm.MappingNodeValue

org.eclipse.persistence.internal.oxm.XMLCollectionReferenceMappingMarshalNodeValue

All Implemented Interfaces:

ContainerValue

public class XMLCollectionReferenceMappingMarshalNodeValue
extends MappingNodeValue
implements ContainerValue

Field Summary

Fields inherited from class org.eclipse.persistence.internal.oxm.NodeValue

xPathNode

Constructor Summary

Constructors

Constructor	Description
XMLCollectionReferenceMappingMarshalNodeValue(CollectionReferenceMapping xmlCollectionReferenceMapping)

Method Summary

Modifier and Type	Method	Description
Object	getContainerInstance()
CoreContainerPolicy	getContainerPolicy()
int	getIndex()	INTERNAL: Set to track the index of the corresponding containerInstance in the containerInstances Object[] on UnmarshalRecord Set during TreeObjectBuilder initialization
CollectionReferenceMapping	getMapping()	Return the mapping associated with this node value.
boolean	getReuseContainer()	Return true if the original container on the object should be used if present.
boolean	isDefaultEmptyContainer()	INTERNAL Return true if an empty container should be set on the object if there is no presence of the collection in the XML document.
boolean	isMarshalNodeValue()
boolean	isOwningNode(XPathFragment fragment)	INTERNAL:
boolean	isUnmarshalNodeValue()
boolean	isWrapperAllowedAsCollectionName()	For media types that provide a native representation of collections (such as JSON arrays), can the representation be simplified so that the grouping element can be used as the collection name.
boolean	marshal(XPathFragment xPathFragment, MarshalRecord marshalRecord, Object object, CoreAbstractSession session, NamespaceResolver namespaceResolver)	INTERNAL:
boolean	marshalSingleValue(XPathFragment xPathFragment, MarshalRecord marshalRecord, Object object, Object value, CoreAbstractSession session, NamespaceResolver namespaceResolver, MarshalContext marshalContext)	INTERNAL: This method provides an optimization in cases where the value has already been calculated.
void	setContainerInstance(Object object, Object containerInstance)
void	setIndex(int index)	INTERNAL: Used to track the index of the corresponding containerInstance in the containerInstances Object[] on UnmarshalRecord

Methods inherited from class org.eclipse.persistence.internal.oxm.MappingNodeValue

addTypeAttribute, isMappingNodeValue, updateNamespaces

Methods inherited from class org.eclipse.persistence.internal.oxm.NodeValue

attribute, buildSelfRecord, endElement, endElement, endSelfNodeValue, getXPathNode, isAnyMappingNodeValue, isContainerValue, isMarshalOnlyNodeValue, isMixedContentNodeValue, isNullCapableValue, isWhitespaceAware, isWrapperNodeValue, marshal, marshal, marshal, marshalSelfAttributes, marshalSingleValue, setXPathNode, startElement

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLCollectionReferenceMappingMarshalNodeValue

public XMLCollectionReferenceMappingMarshalNodeValue(CollectionReferenceMapping xmlCollectionReferenceMapping)

Method Detail

isOwningNode

public boolean isOwningNode(XPathFragment fragment)

Description copied from class: NodeValue

INTERNAL:

Overrides:

isOwningNode in class NodeValue

Returns:

getContainerInstance

public Object getContainerInstance()

Specified by:

getContainerInstance in interface ContainerValue

getContainerPolicy

public CoreContainerPolicy getContainerPolicy()

Specified by:

getContainerPolicy in interface ContainerValue

getMapping

public CollectionReferenceMapping getMapping()

Description copied from class: MappingNodeValue

Return the mapping associated with this node value.

Specified by:

getMapping in interface ContainerValue

Specified by:

getMapping in class MappingNodeValue

getReuseContainer

public boolean getReuseContainer()

Description copied from interface: ContainerValue

Return true if the original container on the object should be used if present. If it is not present then the container policy will be used to create the container.

Specified by:

getReuseContainer in interface ContainerValue

setContainerInstance

public void setContainerInstance(Object object,
                                 Object containerInstance)

Specified by:

setContainerInstance in interface ContainerValue

marshal

public boolean marshal(XPathFragment xPathFragment,
                       MarshalRecord marshalRecord,
                       Object object,
                       CoreAbstractSession session,
                       NamespaceResolver namespaceResolver)

Description copied from class: NodeValue

INTERNAL:

Specified by:

marshal in class NodeValue

Returns:

marshalSingleValue

public boolean marshalSingleValue(XPathFragment xPathFragment,
                                  MarshalRecord marshalRecord,
                                  Object object,
                                  Object value,
                                  CoreAbstractSession session,
                                  NamespaceResolver namespaceResolver,
                                  MarshalContext marshalContext)

Description copied from class: NodeValue

INTERNAL: This method provides an optimization in cases where the value has already been calculated.

Specified by:

marshalSingleValue in interface ContainerValue

Specified by:

marshalSingleValue in class NodeValue

isMarshalNodeValue

public boolean isMarshalNodeValue()

Overrides:

isMarshalNodeValue in class NodeValue

isUnmarshalNodeValue

public boolean isUnmarshalNodeValue()

Overrides:

isUnmarshalNodeValue in class NodeValue

isWrapperAllowedAsCollectionName

public boolean isWrapperAllowedAsCollectionName()

Description copied from interface: ContainerValue

For media types that provide a native representation of collections (such as JSON arrays), can the representation be simplified so that the grouping element can be used as the collection name.

Specified by:

isWrapperAllowedAsCollectionName in interface ContainerValue

setIndex

public void setIndex(int index)

INTERNAL: Used to track the index of the corresponding containerInstance in the containerInstances Object[] on UnmarshalRecord

Specified by:

setIndex in interface ContainerValue

getIndex

public int getIndex()

INTERNAL: Set to track the index of the corresponding containerInstance in the containerInstances Object[] on UnmarshalRecord Set during TreeObjectBuilder initialization

Specified by:

getIndex in interface ContainerValue

isDefaultEmptyContainer

public boolean isDefaultEmptyContainer()

INTERNAL Return true if an empty container should be set on the object if there is no presence of the collection in the XML document.

Specified by:

isDefaultEmptyContainer in interface ContainerValue

Since:

EclipseLink 2.3.3