org.eclipse.persistence.internal.oxm

Class TreeObjectBuilder

java.lang.Object

org.eclipse.persistence.internal.descriptors.ObjectBuilder

org.eclipse.persistence.internal.oxm.XMLObjectBuilder

org.eclipse.persistence.internal.oxm.TreeObjectBuilder

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class TreeObjectBuilder
extends XMLObjectBuilder

INTERNAL:

Purpose: Perform the unmarshal and marshal operations based on the object-to-XML mapping metadata.

Responsibilities:

• Convert mapping metadata to a tree of XPathNodes. This tree is then traversed during unmarshal and marshal operations.
• Create records appropriate to this implementation of ObjectBuilder.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CYCLE_RECOVERABLE
static java.lang.String	CYCLE_RECOVERABLE_CONTEXT
static java.lang.String	ON_CYCLE_DETECTED

Constructor Summary

Constructors

Constructor and Description
TreeObjectBuilder(ClassDescriptor descriptor)

Method Summary

Modifier and Type	Method and Description
XPathNode	addChild(XPathFragment xPathFragment, NodeValue nodeValue, NamespaceResolver namespaceResolver)
void	addContainerValue(ContainerValue containerValue)
void	addDefaultEmptyContainerValue(ContainerValue containerValue)
void	addNullCapableValue(NullCapableValue nullCapableValue)
void	addTransformationMapping(AbstractTransformationMapping transformationMapping)
AbstractRecord	buildRow(AbstractRecord record, java.lang.Object object, AbstractSession session, DatabaseMapping.WriteType writeType) Build the row representation of an object.
AbstractRecord	buildRow(AbstractRecord record, java.lang.Object object, AbstractSession session, XMLMarshaller marshaller, XPathFragment rootFragment, DatabaseMapping.WriteType writeType)
AbstractRecord	createRecord(AbstractSession session) Create a new row/record for the object builder.
AbstractRecord	createRecord(int size, AbstractSession session) Create a new row/record for the object builder.
AbstractRecord	createRecord(java.lang.String rootName, AbstractSession session) Create a new row/record for the object builder with the given name.
AbstractRecord	createRecord(java.lang.String rootName, org.w3c.dom.Node parent, AbstractSession session) Create a new row/record for the object builder with the given name.
java.util.List	getContainerValues()
java.util.List	getDefaultEmptyContainerValues()
java.util.List	getNullCapableValues()
java.util.List<DatabaseMapping>	getPrimaryKeyMappings() Return primary key mappings.
XPathNode	getRootXPathNode()
java.util.List	getTransformationMappings()
void	initialize(AbstractSession session) Cache all the mappings by their attribute and fields.
boolean	marshalAttributes(MarshalRecord marshalRecord, java.lang.Object object, AbstractSession session)

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

addNamespaceDeclarations, addXsiTypeAndClassIndicatorIfRequired, addXsiTypeAndClassIndicatorIfRequired, buildAttributesIntoObject, buildIntoNestedRow, buildIntoNestedRow, buildIntoNestedRow, buildObject, buildRow, buildRow, buildRow, createRecord, createRecordFor, createRecordFor, createRecordFor, extractPrimaryKeyFromExpression, extractPrimaryKeyFromObject, extractPrimaryKeyRowFromExpression, getNamespaceResolver, isXMLObjectBuilder, removeExtraNamespacesFromNamespaceResolver, setDescriptor, writeExtraNamespaces, writeOutMappings

Methods inherited from class org.eclipse.persistence.internal.descriptors.ObjectBuilder

addPrimaryKeyForNonDefaultTable, addPrimaryKeyForNonDefaultTable, assignReturnRow, assignReturnValueForField, assignSequenceNumber, assignSequenceNumber, buildAttributesIntoShallowObject, buildAttributesIntoWorkingCopyClone, buildBackupClone, buildDeleteExpression, buildExpressionFromExample, buildNewInstance, buildObject, buildObjectFromResultSet, buildObjectsInto, buildPrimaryKeyAttributesIntoObject, buildPrimaryKeyExpression, buildPrimaryKeyExpressionFromKeys, buildPrimaryKeyExpressionFromObject, buildRow, buildRowForShallowInsert, buildRowForShallowInsert, buildRowForTranslation, buildRowForUpdate, buildRowForUpdate, buildRowForUpdateAfterShallowInsert, buildRowForUpdateAfterShallowInsert, buildRowForUpdateBeforeShallowDelete, buildRowForUpdateBeforeShallowDelete, buildRowForUpdateWithChangeSet, buildRowForWhereClause, buildRowFromPrimaryKeyValues, buildRowWithChangeSet, buildTemplateInsertRow, buildTemplateInsertRow, buildTemplateUpdateRow, buildUpdateExpression, cacheForeignKeyValues, cacheForeignKeyValues, cascadeDiscoverAndPersistUnregisteredNewObjects, cascadePerformRemove, cascadePerformRemovePrivateOwnedObjectFromChangeSet, cascadeRegisterNewForCreate, clearPrimaryKey, clone, compareForChange, compareObjects, copyInto, copyInto, copyObject, createObjectChangeSet, createObjectChangeSet, createObjectChangeSet, createPrimaryKeyExpression, extractPrimaryKeyFromObject, extractPrimaryKeyFromRow, extractPrimaryKeyRowFromObject, extractRowFromExpression, extractValueFromObjectForField, fixObjectReferences, getBaseChangeRecordForField, getBaseMappingForField, getBaseValueForField, getBatchFetchedAttributes, getCloningMappings, getDescriptor, getEagerMappings, getFieldClassification, getFieldForQueryKeyName, getFieldsMap, getJoinedAttributes, getLockAttribute, getMappingForAttributeName, getMappingForField, getMappingsByField, getParentObjectForField, getPrimaryKeyClassifications, getPrimaryKeyExpression, getReadOnlyMappingsByField, getReadOnlyMappingsForField, getRelationshipMappings, getSequenceMapping, getTargetFieldForQueryKeyName, hasBatchFetchedAttributes, hasInBatchFetchedAttribute, hasJoinedAttributes, hasWrapperPolicy, initializeBatchFetchedAttributes, initializeJoinedAttributes, initializePrimaryKey, instantiateClone, instantiateEagerMappings, instantiateWorkingCopyClone, instantiateWorkingCopyCloneFromRow, isPrimaryKeyComponentInvalid, isPrimaryKeyExpression, isPrimaryKeyMapping, isSimple, iterate, mergeChangesIntoObject, mergeChangesIntoObject, mergeIntoObject, mergeIntoObject, populateAttributesForClone, postInitialize, recordPrivateOwnedRemovals, rehashFieldDependancies, setHasInBatchFetchedAttribute, setHasWrapperPolicy, setMappingsByField, setPrimaryKeyClassifications, setPrimaryKeyExpression, setReadOnlyMappingsByField, setSequenceMapping, toString, trimFieldsForInsert, unwrapObject, updateCachedAttributes, validate, verifyDelete, wrapObject, writeIntoRowFromPrimaryKeyValues

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CYCLE_RECOVERABLE

public static final java.lang.String CYCLE_RECOVERABLE

See Also:

Constant Field Values

CYCLE_RECOVERABLE_CONTEXT

public static final java.lang.String CYCLE_RECOVERABLE_CONTEXT

See Also:

Constant Field Values

ON_CYCLE_DETECTED

public static final java.lang.String ON_CYCLE_DETECTED

See Also:

Constant Field Values

Constructor Detail

TreeObjectBuilder

public TreeObjectBuilder(ClassDescriptor descriptor)

Method Detail

getRootXPathNode

public XPathNode getRootXPathNode()

getPrimaryKeyMappings

public java.util.List<DatabaseMapping> getPrimaryKeyMappings()

Description copied from class: ObjectBuilder

Return primary key mappings.

Overrides:

getPrimaryKeyMappings in class ObjectBuilder

addTransformationMapping

public void addTransformationMapping(AbstractTransformationMapping transformationMapping)

getTransformationMappings

public java.util.List getTransformationMappings()

getContainerValues

public java.util.List getContainerValues()

addDefaultEmptyContainerValue

public void addDefaultEmptyContainerValue(ContainerValue containerValue)

addContainerValue

public void addContainerValue(ContainerValue containerValue)

getNullCapableValues

public java.util.List getNullCapableValues()

getDefaultEmptyContainerValues

public java.util.List getDefaultEmptyContainerValues()

addNullCapableValue

public void addNullCapableValue(NullCapableValue nullCapableValue)

initialize

public void initialize(AbstractSession session)

Description copied from class: ObjectBuilder

Cache all the mappings by their attribute and fields.

Overrides:

initialize in class XMLObjectBuilder

addChild

public XPathNode addChild(XPathFragment xPathFragment,
                          NodeValue nodeValue,
                          NamespaceResolver namespaceResolver)

buildRow

public AbstractRecord buildRow(AbstractRecord record,
                               java.lang.Object object,
                               AbstractSession session,
                               DatabaseMapping.WriteType writeType)

Description copied from class: ObjectBuilder

Build the row representation of an object.

Overrides:

buildRow in class ObjectBuilder

buildRow

public AbstractRecord buildRow(AbstractRecord record,
                               java.lang.Object object,
                               AbstractSession session,
                               XMLMarshaller marshaller,
                               XPathFragment rootFragment,
                               DatabaseMapping.WriteType writeType)

marshalAttributes

public boolean marshalAttributes(MarshalRecord marshalRecord,
                                 java.lang.Object object,
                                 AbstractSession session)

createRecord

public AbstractRecord createRecord(AbstractSession session)

Create a new row/record for the object builder. This allows subclasses to define different record types.

Overrides:

createRecord in class XMLObjectBuilder

createRecord

public AbstractRecord createRecord(java.lang.String rootName,
                                   AbstractSession session)

Create a new row/record for the object builder with the given name. This allows subclasses to define different record types.

Overrides:

createRecord in class XMLObjectBuilder

createRecord

public AbstractRecord createRecord(java.lang.String rootName,
                                   org.w3c.dom.Node parent,
                                   AbstractSession session)

Create a new row/record for the object builder with the given name. This allows subclasses to define different record types.

Overrides:

createRecord in class XMLObjectBuilder

createRecord

public AbstractRecord createRecord(int size,
                                   AbstractSession session)

Create a new row/record for the object builder. This allows subclasses to define different record types.

Overrides:

createRecord in class XMLObjectBuilder