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:
- java.io.Serializable, java.lang.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. |
- See Also:
EISDescriptor.useIndexedRecordFormat()
,
EISDescriptor.useMappedRecordFormat()
,
EISDescriptor.useXMLRecordFormat()
,
Serialized Form- Since:
- Oracle TopLink 10g Release 2 (10.1.3)
Fields inherited from class org.eclipse.persistence.mappings.DatabaseMapping |
attributeAccessor, attributeName, descriptor, fields, isLazy, isOptional, isReadOnly, isRemotelyInitialized, NO_FIELDS, NO_WEIGHT, primaryKeyMapping, properties, weight, WEIGHT_1 |
Method Summary |
protected java.lang.Object |
buildCompositeObject(ObjectBuilder objectBuilder,
AbstractRecord nestedRow,
ObjectBuildingQuery query,
JoinedAttributeManager joinManager)
|
protected java.lang.Object |
buildCompositeRow(java.lang.Object attributeValue,
AbstractSession session,
AbstractRecord record)
|
java.lang.String |
getFieldName()
PUBLIC:
Return the name of the field mapped by the mapping. |
java.lang.String |
getXPath()
Get the XPath String |
boolean |
isEISMapping()
INTERNAL: |
void |
setFieldName(java.lang.String fieldName)
PUBLIC:
Set the name of the field mapped by the mapping. |
void |
setXPath(java.lang.String xpathString)
Set the Mapping field name attribute to the given XPath String |
void |
writeFromObjectIntoRow(java.lang.Object object,
AbstractRecord record,
AbstractSession session)
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, collectFields, getAttributeValueFromObject, getConverter, getField, hasConverter, initialize, isAbstractCompositeObjectMapping, setAttributeValueInObject, setConverter, setField, valueFromObject, valueFromRow, writeFromObjectIntoRowForUpdate, writeFromObjectIntoRowWithChangeRecord, writeInsertFieldsIntoRow |
Methods inherited from class org.eclipse.persistence.mappings.AggregateMapping |
buildAggregateDeleteQuery, buildAggregateModifyQuery, buildAggregateWriteQuery, buildBackupClone, buildBackupClonePart, buildClone, buildCloneFromRow, buildClonePart, buildCopy, buildCopyOfAttributeValue, buildExpression, buildNewMergeInstanceOf, compareAttributeValues, compareForChange, compareObjects, convertClassNamesToClasses, executeEvent, fixAttributeValue, fixObjectReferences, getAttributeValueFromBackupClone, getObjectBuilder, getObjectBuilderForClass, getQueryManager, getReferenceClass, getReferenceClassName, getReferenceDescriptor, getReferenceDescriptor, getReferenceDescriptor, isAggregateMapping, iterate, iterateOnAttributeValue, mergeAttributeValue, mergeChangesIntoObject, mergeIntoObject, postDelete, postDeleteAttributeValue, postInsert, postInsertAttributeValue, postUpdate, postUpdateAttributeValue, preDelete, preDeleteAttributeValue, preInsert, preInsertAttributeValue, preUpdate, preUpdateAttributeValue, remoteInitialization, setReferenceClass, setReferenceClassName, setReferenceDescriptor, updateChangeRecord, verifyDelete, verifyDeleteOfAttributeValue |
Methods inherited from class org.eclipse.persistence.mappings.DatabaseMapping |
addToCollectionChangeRecord, buildBackupCloneForPartObject, buildChangeRecord, buildCloneForPartObject, buildObjectJoinExpression, buildObjectJoinExpression, calculateDeferredChanges, cascadeMerge, clone, cloneFields, createUnitOfWorkValueHolder, extractNestedExpressions, fixRealObjectReferences, getAttributeAccessor, getAttributeClassification, getAttributeName, getContainerPolicy, getDescriptor, getFieldClassification, getFields, getGetMethodName, getObjectCorrespondingTo, getProperties, getProperty, getRealAttributeValueFromObject, getRealCollectionAttributeValueFromObject, getRelationshipPartner, getSelectFields, getSelectTables, getSetMethodName, getValueFromRemoteValueHolder, getWeight, hasConstraintDependency, hasDependency, hasInverseConstraintDependency, hasRootExpressionThatShouldUseOuterJoin, isAbstractCompositeCollectionMapping, isAbstractCompositeDirectCollectionMapping, isAbstractDirectMapping, isAggregateCollectionMapping, isAggregateObjectMapping, isCascadedLockingSupported, isChangeTrackingSupported, isCloningRequired, isCollectionMapping, isDatabaseMapping, isDirectCollectionMapping, isDirectMapMapping, isDirectToFieldMapping, isDirectToXMLTypeMapping, isForeignReferenceMapping, isJoiningSupported, isLazy, isManyToManyMapping, isNestedTableMapping, isObjectReferenceMapping, isObjectTypeMapping, isOneToManyMapping, isOneToOneMapping, isOptional, isPrimaryKeyMapping, isPrivateOwned, isReadOnly, isReferenceMapping, isRelationalMapping, isRemotelyInitialized, isSerializedObjectMapping, isStructureMapping, isTransformationMapping, isTypeConversionMapping, isUsingMethodAccess, isVariableOneToOneMapping, isWriteOnly, isXMLMapping, iterateOnRealAttributeValue, performDataModificationEvent, postInitialize, preInitialize, prepareCascadeLockingPolicy, readFromResultSetIntoObject, readFromRowIntoObject, readFromRowIntoObject, readOnly, readWrite, rehashFieldDependancies, remotelyInitialized, removeFromCollectionChangeRecord, replaceValueHoldersIn, setAttributeAccessor, setAttributeName, setChangeListener, setDescriptor, setFields, setGetMethodName, setIsLazy, setIsOptional, setIsPrimaryKeyMapping, setIsReadOnly, setProperties, setProperty, setRealAttributeValueInObject, setSetMethodName, setWeight, simpleAddToCollectionChangeRecord, simpleRemoveFromCollectionChangeRecord, toString, validateAfterInitialization, validateBeforeInitialization, valueFromResultSet, valueFromRow, writeFromAttributeIntoRow, writeFromObjectIntoRowForShallowInsert, writeFromObjectIntoRowForShallowInsertWithChangeRecord, writeFromObjectIntoRowForWhereClause, writeUpdateFieldsIntoRow |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
EISCompositeObjectMapping
public EISCompositeObjectMapping()
isEISMapping
public boolean isEISMapping()
- INTERNAL:
- Overrides:
isEISMapping
in class DatabaseMapping
getXPath
public java.lang.String getXPath()
- Get the XPath String
- Returns:
- String the XPath String associated with this Mapping
setXPath
public void setXPath(java.lang.String xpathString)
- Set the Mapping field name attribute to the given XPath String
- Parameters:
xpathString
- String
getFieldName
public java.lang.String getFieldName()
- PUBLIC:
Return the name of the field mapped by the mapping.
setFieldName
public void setFieldName(java.lang.String fieldName)
- PUBLIC:
Set the name of the field mapped by the mapping.
buildCompositeRow
protected java.lang.Object buildCompositeRow(java.lang.Object attributeValue,
AbstractSession session,
AbstractRecord record)
- Specified by:
buildCompositeRow
in class AbstractCompositeObjectMapping
buildCompositeObject
protected java.lang.Object buildCompositeObject(ObjectBuilder objectBuilder,
AbstractRecord nestedRow,
ObjectBuildingQuery query,
JoinedAttributeManager joinManager)
- Specified by:
buildCompositeObject
in class AbstractCompositeObjectMapping
writeFromObjectIntoRow
public void writeFromObjectIntoRow(java.lang.Object object,
AbstractRecord record,
AbstractSession session)
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