Package org.eclipse.persistence.internal.oxm

Class NodeValue

java.lang.Object

org.eclipse.persistence.internal.oxm.NodeValue

Direct Known Subclasses:

CollectionGroupingElementNodeValue, FieldTransformerNodeValue, MappingNodeValue, TypeNodeValue, XMLBinaryDataMappingNodeValue, XMLFragmentCollectionMappingNodeValue

public abstract class NodeValue
extends Object

INTERNAL:

Purpose: A NodeValue is responsible for performing the unmarshal and marshal operation at a mapping or policy level. The operations are based on a SAX ContextHandler.

Responsibilities:

• Maintain a reference to the owning XPathNode.
• Given a XPathFragment recognize the node to which the mapping should be applied.
• Perform the unmarshal and marshal operation for the given mapping or policy.

Field Summary

Fields

Modifier and Type	Field	Description
protected XPathNode	xPathNode

Constructor Summary

Constructors

Constructor	Description
NodeValue()

Method Summary

Modifier and Type	Method	Description
void	attribute(UnmarshalRecord unmarshalRecord, String URI, String localName, String value)	INTERNAL:
UnmarshalRecord	buildSelfRecord(UnmarshalRecord unmarshalRecord, Attributes atts)	INTERNAL:
void	endElement(XPathFragment xPathFragment, UnmarshalRecord unmarshalRecord)	INTERNAL:
void	endElement(XPathFragment xPathFragment, UnmarshalRecord unmarshalRecord, Object collection)
void	endSelfNodeValue(UnmarshalRecord unmarshalRecord, UnmarshalRecord selfRecord, Attributes atts)
XPathNode	getXPathNode()
boolean	isAnyMappingNodeValue()
boolean	isContainerValue()	INTERNAL:
boolean	isMappingNodeValue()
boolean	isMarshalNodeValue()
boolean	isMarshalOnlyNodeValue()	INTERNAL: Return whether we ignore this node value when marshalling its parent
boolean	isMixedContentNodeValue()	INTERNAL: Return true if this is the node value representing mixed content.
boolean	isNullCapableValue()	INTERNAL:
boolean	isOwningNode(XPathFragment xPathFragment)	INTERNAL:
boolean	isUnmarshalNodeValue()
boolean	isWhitespaceAware()
boolean	isWrapperNodeValue()
abstract boolean	marshal(XPathFragment xPathFragment, MarshalRecord marshalRecord, Object object, CoreAbstractSession session, NamespaceResolver namespaceResolver)	INTERNAL:
boolean	marshal(XPathFragment xPathFragment, MarshalRecord marshalRecord, Object object, CoreAbstractSession session, NamespaceResolver namespaceResolver, Marshaller marshaller)	INTERNAL: This method is no longer required as now MarshalRecord maintains a reference to the XMLMarshaller.
boolean	marshal(XPathFragment xPathFragment, MarshalRecord marshalRecord, Object object, CoreAbstractSession session, NamespaceResolver namespaceResolver, MarshalContext marshalContext)	INTERNAL: Override this method if the NodeValue is applicable to sequenced objects.
boolean	marshal(XPathFragment xPathFragment, MarshalRecord marshalRecord, Object object, CoreAbstractSession session, NamespaceResolver namespaceResolver, MarshalContext marshalContext, XPathFragment rootFragment)	INTERNAL:
boolean	marshalSelfAttributes(XPathFragment xPathFragment, MarshalRecord marshalRecord, Object object, CoreAbstractSession session, NamespaceResolver namespaceResolver, Marshaller marshaller)	INTERNAL: Marshal any 'self' mapped attributes.
abstract boolean	marshalSingleValue(XPathFragment xPathFragment, MarshalRecord marshalRecord, Object object, Object objectValue, CoreAbstractSession session, NamespaceResolver namespaceResolver, MarshalContext marshalContext)	INTERNAL: This method provides an optimization in cases where the value has already been calculated.
boolean	marshalSingleValue(XPathFragment xPathFragment, MarshalRecord marshalRecord, Object object, Object objectValue, CoreAbstractSession session, NamespaceResolver namespaceResolver, MarshalContext marshalContext, XPathFragment rootFragment)	INTERNAL: This method provides an optimization in cases where the value has already been calculated.
void	setXPathNode(XPathNode xPathNode)
boolean	startElement(XPathFragment xPathFragment, UnmarshalRecord unmarshalRecord, Attributes atts)	INTERNAL:

Methods inherited from class java.lang.Object

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

Field Detail

xPathNode

protected XPathNode xPathNode

Constructor Detail

NodeValue

public NodeValue()

Method Detail

getXPathNode

public XPathNode getXPathNode()

setXPathNode

public void setXPathNode(XPathNode xPathNode)

isMarshalOnlyNodeValue

public boolean isMarshalOnlyNodeValue()

INTERNAL: Return whether we ignore this node value when marshalling its parent

Returns:

isOwningNode

public boolean isOwningNode(XPathFragment xPathFragment)

INTERNAL:

Parameters:

xPathFragment -

Returns:

marshal

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

INTERNAL:

Parameters:

xPathFragment -

marshalRecord -

object -

session -

namespaceResolver -

Returns:

marshal

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

INTERNAL: This method is no longer required as now MarshalRecord maintains a reference to the XMLMarshaller.

Parameters:

xPathFragment -

marshalRecord -

object -

session -

namespaceResolver -

marshaller -

Returns:

marshal

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

INTERNAL:

Parameters:

xPathFragment -

marshalRecord -

object -

session -

namespaceResolver -

Returns:

marshalSingleValue

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

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

Parameters:

xPathFragment -

marshalRecord -

object -

objectValue -

session -

namespaceResolver -

marshalContext -

Returns:

marshalSingleValue

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

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

Parameters:

xPathFragment -

marshalRecord -

object -

objectValue -

session -

namespaceResolver -

marshalContext -

Returns:

marshal

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

INTERNAL: Override this method if the NodeValue is applicable to sequenced objects.

Parameters:

xPathFragment -

marshalRecord -

object -

session -

namespaceResolver -

marshalContext -

Returns:

startElement

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

INTERNAL:

Parameters:

xPathFragment -

unmarshalRecord -

atts -

Returns:

attribute

public void attribute(UnmarshalRecord unmarshalRecord,
                      String URI,
                      String localName,
                      String value)

INTERNAL:

Parameters:

unmarshalRecord -

URI -

localName -

value -

endElement

public void endElement(XPathFragment xPathFragment,
                       UnmarshalRecord unmarshalRecord)

INTERNAL:

Parameters:

xPathFragment -

unmarshalRecord -

buildSelfRecord

public UnmarshalRecord buildSelfRecord(UnmarshalRecord unmarshalRecord,
                                       Attributes atts)

INTERNAL:

Parameters:

unmarshalRecord -

atts -

Returns:

endSelfNodeValue

public void endSelfNodeValue(UnmarshalRecord unmarshalRecord,
                             UnmarshalRecord selfRecord,
                             Attributes atts)

isContainerValue

public boolean isContainerValue()

INTERNAL:

Returns:

Returns true if the NodeValue implements ContainerValue.

See Also:

ContainerValue

isNullCapableValue

public boolean isNullCapableValue()

INTERNAL:

Returns:

Returns true if the NodeValue implements NullCapableValue.

See Also:

NullCapableValue

endElement

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

isUnmarshalNodeValue

public boolean isUnmarshalNodeValue()

isMarshalNodeValue

public boolean isMarshalNodeValue()

marshalSelfAttributes

public boolean marshalSelfAttributes(XPathFragment xPathFragment,
                                     MarshalRecord marshalRecord,
                                     Object object,
                                     CoreAbstractSession session,
                                     NamespaceResolver namespaceResolver,
                                     Marshaller marshaller)

INTERNAL: Marshal any 'self' mapped attributes.

Parameters:

xPathFragment -

marshalRecord -

object -

session -

namespaceResolver -

marshaller -

Returns:

isMappingNodeValue

public boolean isMappingNodeValue()

isWhitespaceAware

public boolean isWhitespaceAware()

isAnyMappingNodeValue

public boolean isAnyMappingNodeValue()

isMixedContentNodeValue

public boolean isMixedContentNodeValue()

INTERNAL: Return true if this is the node value representing mixed content.

Returns:

isWrapperNodeValue

public boolean isWrapperNodeValue()