org.eclipse.persistence.mappings.structures

Class ArrayMapping

java.lang.Object

org.eclipse.persistence.mappings.DatabaseMapping

org.eclipse.persistence.mappings.foundation.AbstractCompositeDirectCollectionMapping

org.eclipse.persistence.mappings.structures.ArrayMapping

All Implemented Interfaces:

Serializable, Cloneable, ContainerMapping, ArrayCollectionMapping

public class ArrayMapping
extends AbstractCompositeDirectCollectionMapping
implements ArrayCollectionMapping

Purpose: In an object-relational data model, structures can contain "Arrays" or collections of other data-types. In Oracle 8i, a "VARRAY" is typically used to represent a collection of primitive data or aggregate structures. These arrays are stored with their parent structure in the same table.

See Also:

StructureMapping, NestedTableMapping, ReferenceMapping, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.persistence.mappings.DatabaseMapping

DatabaseMapping.WriteType

Constructor Summary

Constructors

Constructor and Description
ArrayMapping() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
org.eclipse.persistence.internal.sessions.ChangeRecord	compareForChange(Object clone, Object backup, org.eclipse.persistence.internal.sessions.ObjectChangeSet owner, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Build and return the change record that results from comparing the two direct collection attributes.
boolean	compareObjects(Object object1, Object object2, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Compare the attributes belonging to this mapping for the objects.
String	getElementDataTypeName() PUBLIC: Return the "data type" associated with each element in the nested collection.
String	getStructureName() PUBLIC: Return the name of the structure.
void	initialize(org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Initialize the mapping.
void	mergeChangesIntoObject(Object target, org.eclipse.persistence.internal.sessions.ChangeRecord changeRecord, Object source, org.eclipse.persistence.internal.sessions.MergeManager mergeManager) INTERNAL: Merge changes from the source to the target object.
void	mergeIntoObject(Object target, boolean isTargetUnInitialized, Object source, org.eclipse.persistence.internal.sessions.MergeManager mergeManager) INTERNAL: Merge changes from the source to the target object.
void	setElementDataTypeName(String elementDataTypeName) PUBLIC: Set the "data type" associated with each element in the nested collection.
void	setFieldName(String fieldName) PUBLIC: Set the name of the field that holds the nested collection.
void	setStructureName(String structureName) PUBLIC: Set the name of the structure.
void	simpleAddToCollectionChangeRecord(Object referenceKey, Object changeSetToAdd, org.eclipse.persistence.internal.sessions.ObjectChangeSet changeSet, org.eclipse.persistence.internal.sessions.AbstractSession session) ADVANCED: This method is used to have an object add to a collection once the changeSet is applied The referenceKey parameter should only be used for direct Maps.
void	simpleRemoveFromCollectionChangeRecord(Object referenceKey, Object changeSetToRemove, org.eclipse.persistence.internal.sessions.ObjectChangeSet changeSet, org.eclipse.persistence.internal.sessions.AbstractSession session) ADVANCED: This method is used to have an object removed from a collection once the changeSet is applied The referenceKey parameter should only be used for direct Maps.

Methods inherited from class org.eclipse.persistence.mappings.foundation.AbstractCompositeDirectCollectionMapping

buildAddedElementFromChangeSet, buildBackupClone, buildChangeSet, buildClone, buildCloneFromRow, buildCopy, buildElementFromElement, buildRemovedElementFromChangeSet, cascadePerformRemoveIfRequired, cascadeRegisterNewIfRequired, compareElements, compareElementsForChange, convertClassNamesToClasses, fixObjectReferences, getAttributeElementClass, getContainerPolicy, getField, getFieldClassification, getFieldElementClass, getFieldName, getRealCollectionAttributeValueFromObject, getValueConverter, hasValueConverter, isAbstractCompositeDirectCollectionMapping, isCollectionMapping, iterate, mapKeyHasChanged, setAttributeElementClass, setContainerPolicy, setField, setFieldElementClass, setUsesSingleNode, setValueConverter, useCollectionClass, useMapClass, usesSingleNode, valueFromRow, writeFromObjectIntoRow, writeFromObjectIntoRowForUpdate, writeFromObjectIntoRowWithChangeRecord, writeInsertFieldsIntoRow

Methods inherited from class org.eclipse.persistence.mappings.DatabaseMapping

buildBackupCloneForPartObject, buildChangeRecord, buildCloneForPartObject, buildExpression, buildObjectJoinExpression, buildObjectJoinExpression, buildShallowOriginalFromRow, calculateDeferredChanges, cascadeDiscoverAndPersistUnregisteredNewObjects, cascadeMerge, cascadePerformRemovePrivateOwnedObjectFromChangeSetIfRequired, clone, createUnitOfWorkValueHolder, derivesId, earlyPreDelete, fixRealObjectReferences, getAttributeAccessor, getAttributeClassification, getAttributeName, getAttributeValueFromObject, getDerivedIdMapping, getDescriptor, getFields, getGetMethodName, getMapsIdValue, getObjectCorrespondingTo, getProperties, getProperty, getRealAttributeValueFromAttribute, getRealAttributeValueFromObject, getReferenceDescriptor, getRelationshipPartner, getSelectFields, getSelectTables, getSetMethodName, getValueFromRemoteValueHolder, getWeight, hasConstraintDependency, hasDependency, hasInverseConstraintDependency, hasMapsIdValue, instantiateAttribute, isAbstractCompositeCollectionMapping, isAbstractCompositeObjectMapping, isAbstractDirectMapping, isAggregateCollectionMapping, isAggregateMapping, isAggregateObjectMapping, isCandidateForPrivateOwnedRemoval, isCascadedLockingSupported, isChangeTrackingSupported, isCloningRequired, isDatabaseMapping, isDirectCollectionMapping, isDirectMapMapping, isDirectToFieldMapping, isDirectToXMLTypeMapping, isEISMapping, isForeignReferenceMapping, isJoiningSupported, isJPAId, isLazy, isLockableMapping, isManyToManyMapping, isManyToOneMapping, isMapKeyMapping, isNestedTableMapping, isObjectReferenceMapping, isOneToManyMapping, isOneToOneMapping, isOptional, isOwned, isPrimaryKeyMapping, isPrivateOwned, isReadOnly, isReferenceMapping, isRelationalMapping, isStructureMapping, isTransformationMapping, isUnidirectionalOneToManyMapping, isUsingMethodAccess, isVariableOneToOneMapping, isWriteOnly, isXMLMapping, iterateOnRealAttributeValue, performDataModificationEvent, postCalculateChanges, postCalculateChangesOnDeleted, postDelete, postInitialize, postInsert, postUpdate, preDelete, preInitialize, preInsert, prepareCascadeLockingPolicy, preUpdate, readFromResultSetIntoObject, readFromRowIntoObject, readOnly, readWrite, recordPrivateOwnedRemovals, rehashFieldDependancies, remoteInitialization, replaceValueHoldersIn, setAttributeAccessor, setAttributeName, setAttributeValueInObject, setChangeListener, setDerivedIdMapping, setDerivesId, setDescriptor, setGetMethodName, setIsJPAId, setIsLazy, setIsMapKeyMapping, setIsOptional, setIsPrimaryKeyMapping, setIsReadOnly, setMapsIdValue, setProperties, setProperty, setRealAttributeValueInObject, setSetMethodName, setWeight, toString, updateChangeRecord, updateCollectionChangeRecord, validateAfterInitialization, validateBeforeInitialization, valueFromObject, valueFromResultSet, valueFromRow, verifyDelete, writeFromAttributeIntoRow, writeFromObjectIntoRowForShallowInsert, writeFromObjectIntoRowForShallowInsertWithChangeRecord, writeFromObjectIntoRowForWhereClause, writeUpdateFieldsIntoRow

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.persistence.mappings.structures.ArrayCollectionMapping

buildAddedElementFromChangeSet, buildChangeSet, buildElementFromElement, buildRemovedElementFromChangeSet, compareElements, compareElementsForChange, getAttributeName, getRealCollectionAttributeValueFromObject, mapKeyHasChanged, setRealAttributeValueInObject

Methods inherited from interface org.eclipse.persistence.mappings.ContainerMapping

getContainerPolicy, setContainerPolicy, useCollectionClass, useMapClass

Constructor Detail

ArrayMapping

public ArrayMapping()

Default constructor.

Method Detail

setFieldName

public void setFieldName(String fieldName)

PUBLIC: Set the name of the field that holds the nested collection.

getStructureName

public String getStructureName()

PUBLIC: Return the name of the structure. This is the name of the user-defined data type as defined on the database.

setStructureName

public void setStructureName(String structureName)

PUBLIC: Set the name of the structure. This is the name of the user-defined data type as defined on the database.

getElementDataTypeName

public String getElementDataTypeName()

PUBLIC: Return the "data type" associated with each element in the nested collection. Depending on the data store, this could be optional.

setElementDataTypeName

public void setElementDataTypeName(String elementDataTypeName)

PUBLIC: Set the "data type" associated with each element in the nested collection. Depending on the data store, this could be optional.

initialize

public void initialize(org.eclipse.persistence.internal.sessions.AbstractSession session)
                throws DescriptorException

INTERNAL: Initialize the mapping.

Overrides:

initialize in class AbstractCompositeDirectCollectionMapping

Throws:

DescriptorException

compareForChange

public org.eclipse.persistence.internal.sessions.ChangeRecord compareForChange(Object clone,
                                                                      Object backup,
                                                                      org.eclipse.persistence.internal.sessions.ObjectChangeSet owner,
                                                                      org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: Build and return the change record that results from comparing the two direct collection attributes.

Overrides:

compareForChange in class AbstractCompositeDirectCollectionMapping

Returns:

prototype.changeset.ChangeRecord

compareObjects

public boolean compareObjects(Object object1,
                     Object object2,
                     org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: Compare the attributes belonging to this mapping for the objects.

Overrides:

compareObjects in class AbstractCompositeDirectCollectionMapping

mergeChangesIntoObject

public void mergeChangesIntoObject(Object target,
                          org.eclipse.persistence.internal.sessions.ChangeRecord changeRecord,
                          Object source,
                          org.eclipse.persistence.internal.sessions.MergeManager mergeManager)

INTERNAL: Merge changes from the source to the target object.

Overrides:

mergeChangesIntoObject in class AbstractCompositeDirectCollectionMapping

mergeIntoObject

public void mergeIntoObject(Object target,
                   boolean isTargetUnInitialized,
                   Object source,
                   org.eclipse.persistence.internal.sessions.MergeManager mergeManager)

INTERNAL: Merge changes from the source to the target object. Simply replace the entire target collection.

Overrides:

mergeIntoObject in class AbstractCompositeDirectCollectionMapping

simpleAddToCollectionChangeRecord

public void simpleAddToCollectionChangeRecord(Object referenceKey,
                                     Object changeSetToAdd,
                                     org.eclipse.persistence.internal.sessions.ObjectChangeSet changeSet,
                                     org.eclipse.persistence.internal.sessions.AbstractSession session)

ADVANCED: This method is used to have an object add to a collection once the changeSet is applied The referenceKey parameter should only be used for direct Maps.

Overrides:

simpleAddToCollectionChangeRecord in class AbstractCompositeDirectCollectionMapping

simpleRemoveFromCollectionChangeRecord

public void simpleRemoveFromCollectionChangeRecord(Object referenceKey,
                                          Object changeSetToRemove,
                                          org.eclipse.persistence.internal.sessions.ObjectChangeSet changeSet,
                                          org.eclipse.persistence.internal.sessions.AbstractSession session)

ADVANCED: This method is used to have an object removed from a collection once the changeSet is applied The referenceKey parameter should only be used for direct Maps.

Overrides:

simpleRemoveFromCollectionChangeRecord in class AbstractCompositeDirectCollectionMapping