org.eclipse.persistence.eis.mappings
Class EISCompositeObjectMapping

java.lang.Object
  org.eclipse.persistence.mappings.DatabaseMapping
      org.eclipse.persistence.mappings.AggregateMapping
          org.eclipse.persistence.mappings.foundation.AbstractCompositeObjectMapping
              org.eclipse.persistence.eis.mappings.EISCompositeObjectMapping

All Implemented Interfaces:

Serializable, Cloneable, EISMapping

public class EISCompositeObjectMapping
extends AbstractCompositeObjectMapping
implements EISMapping

EIS Composite Object Mappings map a Java object to a privately owned, one-to-one relationship to an EIS Record according to its descriptor's record type.

Record Type	Description
Indexed	Ordered collection of record elements. The indexed record EIS format enables Java class attribute values to be retreived by position or index.
Mapped	Key-value map based representation of record elements. The mapped record EIS format enables Java class attribute values to be retreived by an object key.
XML	Record/Map representation of an XML DOM element.

Since:

Oracle TopLink 10g Release 2 (10.1.3)

See Also:

EISDescriptor.useIndexedRecordFormat(), EISDescriptor.useMappedRecordFormat(), EISDescriptor.useXMLRecordFormat(), Serialized Form

Nested Class Summary

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

DatabaseMapping.WriteType

Constructor Summary

EISCompositeObjectMapping()

Method Summary

String	getFieldName() PUBLIC: Return the name of the field mapped by the mapping.
String	getXPath() Get the XPath String
boolean	isEISMapping() INTERNAL:
void	setFieldName(String fieldName) PUBLIC: Set the name of the field mapped by the mapping.
void	setXPath(String xpathString) Set the Mapping field name attribute to the given XPath String
void	writeFromObjectIntoRow(Object object, org.eclipse.persistence.internal.sessions.AbstractRecord record, org.eclipse.persistence.internal.sessions.AbstractSession session, DatabaseMapping.WriteType writeType) INTERNAL: Build the value for the database field and put it in the specified database row.

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

buildShallowOriginalFromRow, cascadeDiscoverAndPersistUnregisteredNewObjects, cascadePerformRemoveIfRequired, cascadeRegisterNewIfRequired, convertClassNamesToClasses, getAttributeValueFromObject, getConverter, getField, hasConverter, initialize, isAbstractCompositeObjectMapping, setAttributeValueInObject, setConverter, setField, valueFromObject, valueFromRow, writeFromObjectIntoRowForUpdate, writeFromObjectIntoRowWithChangeRecord, writeInsertFieldsIntoRow

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

buildBackupClone, buildClone, buildCloneFromRow, buildCopy, buildExpression, compareForChange, compareObjects, fixObjectReferences, getReferenceClass, getReferenceClassName, getReferenceDescriptor, isAggregateMapping, iterate, mergeChangesIntoObject, mergeIntoObject, postDelete, postDeleteAttributeValue, postInsert, postInsertAttributeValue, postUpdate, postUpdateAttributeValue, preDelete, preDeleteAttributeValue, preInsert, preInsertAttributeValue, preUpdate, preUpdateAttributeValue, remoteInitialization, setReferenceClass, setReferenceClassName, updateChangeRecord, verifyDelete

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

buildBackupCloneForPartObject, buildChangeRecord, buildCloneForPartObject, buildObjectJoinExpression, buildObjectJoinExpression, calculateDeferredChanges, cascadeMerge, cascadePerformRemovePrivateOwnedObjectFromChangeSetIfRequired, clone, createUnitOfWorkValueHolder, derivesId, earlyPreDelete, fixRealObjectReferences, getAttributeAccessor, getAttributeClassification, getAttributeName, getContainerPolicy, getDerivedIdMapping, getDescriptor, getFieldClassification, getFields, getGetMethodName, getMapsIdValue, getObjectCorrespondingTo, getProperties, getProperty, getRealAttributeValueFromAttribute, getRealAttributeValueFromObject, getRealCollectionAttributeValueFromObject, getRelationshipPartner, getSelectFields, getSelectTables, getSetMethodName, getValueFromRemoteValueHolder, getWeight, hasConstraintDependency, hasDependency, hasInverseConstraintDependency, hasMapsIdValue, instantiateAttribute, isAbstractCompositeCollectionMapping, isAbstractCompositeDirectCollectionMapping, isAbstractDirectMapping, isAggregateCollectionMapping, isAggregateObjectMapping, isCandidateForPrivateOwnedRemoval, isCascadedLockingSupported, isChangeTrackingSupported, isCloningRequired, isCollectionMapping, isDatabaseMapping, isDirectCollectionMapping, isDirectMapMapping, isDirectToFieldMapping, isDirectToXMLTypeMapping, 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, postInitialize, preInitialize, prepareCascadeLockingPolicy, readFromResultSetIntoObject, readFromRowIntoObject, readOnly, readWrite, recordPrivateOwnedRemovals, rehashFieldDependancies, replaceValueHoldersIn, setAttributeAccessor, setAttributeName, setChangeListener, setDerivedIdMapping, setDerivesId, setDescriptor, setGetMethodName, setIsJPAId, setIsLazy, setIsMapKeyMapping, setIsOptional, setIsPrimaryKeyMapping, setIsReadOnly, setMapsIdValue, setProperties, setProperty, setRealAttributeValueInObject, setSetMethodName, setWeight, simpleAddToCollectionChangeRecord, simpleRemoveFromCollectionChangeRecord, toString, updateCollectionChangeRecord, validateAfterInitialization, validateBeforeInitialization, valueFromResultSet, valueFromRow, writeFromAttributeIntoRow, writeFromObjectIntoRowForShallowInsert, writeFromObjectIntoRowForShallowInsertWithChangeRecord, writeFromObjectIntoRowForWhereClause, writeUpdateFieldsIntoRow

Methods inherited from class java.lang.Object

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

Constructor Detail

EISCompositeObjectMapping

public EISCompositeObjectMapping()

Method Detail

isEISMapping

public boolean isEISMapping()

INTERNAL:

Overrides:

isEISMapping in class DatabaseMapping

getXPath

public String getXPath()

Get the XPath String

Returns:

String the XPath String associated with this Mapping

setXPath

public void setXPath(String xpathString)

Set the Mapping field name attribute to the given XPath String

Parameters:

xpathString - String

getFieldName

public String getFieldName()

PUBLIC: Return the name of the field mapped by the mapping.

setFieldName

public void setFieldName(String fieldName)

PUBLIC: Set the name of the field mapped by the mapping.

writeFromObjectIntoRow

public void writeFromObjectIntoRow(Object object,
                                   org.eclipse.persistence.internal.sessions.AbstractRecord record,
                                   org.eclipse.persistence.internal.sessions.AbstractSession session,
                                   DatabaseMapping.WriteType writeType)
                            throws DescriptorException

INTERNAL: Build the value for the database field and put it in the specified database row.

Overrides:

writeFromObjectIntoRow in class AbstractCompositeObjectMapping

Throws:

DescriptorException