Module org.eclipse.persistence.core

Package org.eclipse.persistence.internal.oxm

Class XMLCompositeCollectionMappingNodeValue

java.lang.Object

org.eclipse.persistence.internal.oxm.NodeValue

org.eclipse.persistence.internal.oxm.MappingNodeValue

org.eclipse.persistence.internal.oxm.XMLRelationshipMappingNodeValue

org.eclipse.persistence.internal.oxm.XMLCompositeCollectionMappingNodeValue

All Implemented Interfaces:

ContainerValue

public class XMLCompositeCollectionMappingNodeValue
extends XMLRelationshipMappingNodeValue
implements ContainerValue

INTERNAL:

Purpose: This is how the XML Composite Collection Mapping is handled when used with the TreeObjectBuilder.

Field Summary

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

xPathNode

Constructor Summary

Constructors

Constructor	Description
XMLCompositeCollectionMappingNodeValue(CompositeCollectionMapping xmlCompositeCollectionMapping)
XMLCompositeCollectionMappingNodeValue(CompositeCollectionMapping xmlCompositeCollectionMapping, boolean isInverse)

Method Summary

Modifier and Type	Method	Description
void	endElement(XPathFragment xPathFragment, UnmarshalRecord unmarshalRecord)	INTERNAL:
void	endElement(XPathFragment xPathFragment, UnmarshalRecord unmarshalRecord, Object collection)
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
CompositeCollectionMapping	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	isContainerValue()	INTERNAL:
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	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
protected void	setOrAddAttributeValue(UnmarshalRecord unmarshalRecord, Object value, XPathFragment xPathFragment, Object collection)
boolean	startElement(XPathFragment xPathFragment, UnmarshalRecord unmarshalRecord, Attributes atts)	INTERNAL:

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

addTypeAttribute, endElementProcessText, findReferenceDescriptor, getClassForQName, processChild, setOrAddAttributeValueForKeepAsElement, setupHandlerForKeepAsElementPolicy, writeExtraNamespaces

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, endSelfNodeValue, getXPathNode, isAnyMappingNodeValue, isMarshalNodeValue, isMarshalOnlyNodeValue, isMixedContentNodeValue, isNullCapableValue, isOwningNode, isUnmarshalNodeValue, isWhitespaceAware, isWrapperNodeValue, marshal, marshal, marshal, marshalSelfAttributes, marshalSingleValue, setXPathNode

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLCompositeCollectionMappingNodeValue

public XMLCompositeCollectionMappingNodeValue(CompositeCollectionMapping xmlCompositeCollectionMapping)

XMLCompositeCollectionMappingNodeValue

public XMLCompositeCollectionMappingNodeValue(CompositeCollectionMapping xmlCompositeCollectionMapping,
                                              boolean isInverse)

Method Detail

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

startElement

public boolean startElement(XPathFragment xPathFragment,
                            UnmarshalRecord unmarshalRecord,
                            Attributes atts)

Description copied from class: NodeValue

INTERNAL:

Overrides:

startElement in class NodeValue

endElement

public void endElement(XPathFragment xPathFragment,
                       UnmarshalRecord unmarshalRecord)

Description copied from class: NodeValue

INTERNAL:

Overrides:

endElement in class NodeValue

endElement

public void endElement(XPathFragment xPathFragment,
                       UnmarshalRecord unmarshalRecord,
                       Object collection)

Overrides:

endElement in class NodeValue

getContainerInstance

public Object getContainerInstance()

Specified by:

getContainerInstance in interface ContainerValue

setContainerInstance

public void setContainerInstance(Object object,
                                 Object containerInstance)

Specified by:

setContainerInstance in interface ContainerValue

getContainerPolicy

public CoreContainerPolicy getContainerPolicy()

Specified by:

getContainerPolicy in interface ContainerValue

isContainerValue

public boolean isContainerValue()

Description copied from class: NodeValue

INTERNAL:

Overrides:

isContainerValue in class NodeValue

Returns:

Returns true if the NodeValue implements ContainerValue.

See Also:

ContainerValue

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

getMapping

public CompositeCollectionMapping 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

setOrAddAttributeValue

protected void setOrAddAttributeValue(UnmarshalRecord unmarshalRecord,
                                      Object value,
                                      XPathFragment xPathFragment,
                                      Object collection)

Specified by:

setOrAddAttributeValue in class XMLRelationshipMappingNodeValue

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

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

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