Top Description Fields Constructors Methods
org.eclipse.persistence.eis.mappings

public Class EISCompositeObjectMapping

extends AbstractCompositeObjectMapping
implements EISMapping
Class Inheritance
All Implemented Interfaces
org.eclipse.persistence.eis.mappings.EISMapping
Imports
org.eclipse.persistence.descriptors.changetracking.AttributeChangeTrackingPolicy, .DeferredChangeDetectionPolicy, .ObjectChangeTrackingPolicy, org.eclipse.persistence.eis.EISDescriptor, org.eclipse.persistence.exceptions.DescriptorException, org.eclipse.persistence.internal.descriptors.ObjectBuilder, org.eclipse.persistence.internal.helper.DatabaseField, org.eclipse.persistence.internal.identitymaps.CacheKey, org.eclipse.persistence.internal.oxm.XMLObjectBuilder, org.eclipse.persistence.internal.queries.JoinedAttributeManager, org.eclipse.persistence.internal.sessions.AbstractRecord, .AbstractSession, org.eclipse.persistence.mappings.foundation.AbstractCompositeObjectMapping, org.eclipse.persistence.oxm.XMLField, org.eclipse.persistence.oxm.record.XMLRecord, org.eclipse.persistence.queries.ObjectBuildingQuery

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 formats
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
org.eclipse.persistence.eis.EISDescriptor#useIndexedRecordFormat, org.eclipse.persistence.eis.EISDescriptor#useMappedRecordFormat, org.eclipse.persistence.eis.EISDescriptor#useXMLRecordFormat

Field Summary

Inherited from org.eclipse.persistence.mappings.foundation.AbstractCompositeObjectMapping:
converterfield

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
protected Object
protected Object
public String
getFieldName()

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

public String

Returns:

String the XPath String associated with this Mapping
getXPath
()

Get the XPath String

public boolean
public void
public void
preInitialize(AbstractSession session)

Overrides org.eclipse.persistence.mappings.DatabaseMapping.preInitialize.

Fix field names for XML data descriptors.
public void
setFieldName(String fieldName)

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

public void
setXPath(String
String
xpathString
)

Set the Mapping field name attribute to the given XPath String

public void
writeFromObjectIntoRow(Object object, AbstractRecord record, AbstractSession session, DatabaseMapping.WriteType writeType)

Overrides org.eclipse.persistence.mappings.foundation.AbstractCompositeObjectMapping.writeFromObjectIntoRow.

INTERNAL: Build the value for the database field and put it in the specified database row.
Inherited from org.eclipse.persistence.mappings.foundation.AbstractCompositeObjectMapping:
buildExpressionbuildShallowOriginalFromRowcascadeDiscoverAndPersistUnregisteredNewObjectscascadePerformRemoveIfRequiredcascadeRegisterNewIfRequiredcollectFieldsgetConvertergetFieldhasConverterinitializeisAbstractCompositeObjectMappingsetAttributeValueInObjectsetConvertersetFieldvalueFromObjectvalueFromRowwriteFromObjectIntoRowForUpdatewriteFromObjectIntoRowWithChangeRecordwriteInsertFieldsIntoRow

Constructor Detail

EISCompositeObjectMappingback to summary
public EISCompositeObjectMapping()

Method Detail

buildCompositeObjectback to summary
protected Object buildCompositeObject(ObjectBuilder objectBuilder, AbstractRecord nestedRow, ObjectBuildingQuery query, CacheKey parentCacheKey, JoinedAttributeManager joinManager, AbstractSession targetSession)

Implements abstract org.eclipse.persistence.mappings.foundation.AbstractCompositeObjectMapping.buildCompositeObject.

Annotations
@Override
buildCompositeRowback to summary
protected Object buildCompositeRow(Object attributeValue, AbstractSession session, AbstractRecord record, DatabaseMapping.WriteType writeType)

Implements abstract org.eclipse.persistence.mappings.foundation.AbstractCompositeObjectMapping.buildCompositeRow.

Annotations
@Override
getFieldNameback to summary
public String getFieldName()

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

getXPathback to summary
public String getXPath()

Get the XPath String

Returns:String

String the XPath String associated with this Mapping

isEISMappingback to summary
public boolean isEISMapping()

Overrides org.eclipse.persistence.mappings.DatabaseMapping.isEISMapping.

INTERNAL:

Annotations
@Override
postInitializeback to summary
public void postInitialize(AbstractSession session) throws DescriptorException

Overrides org.eclipse.persistence.mappings.DatabaseMapping.postInitialize.

INTERNAL: Initialize the mapping.

Annotations
@Override
preInitializeback to summary
public void preInitialize(AbstractSession session)

Overrides org.eclipse.persistence.mappings.DatabaseMapping.preInitialize.

Fix field names for XML data descriptors. Since fields are fixed to use text() by default in descriptor, ensure the correct non text field is used here.

Annotations
@Override
setFieldNameback to summary
public void setFieldName(String fieldName)

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

setXPathback to summary
public void setXPath(String xpathString)

Set the Mapping field name attribute to the given XPath String

Parameters
xpathString:String

String

writeFromObjectIntoRowback to summary
public void writeFromObjectIntoRow(Object object, AbstractRecord record, AbstractSession session, DatabaseMapping.WriteType writeType) throws DescriptorException

Overrides org.eclipse.persistence.mappings.foundation.AbstractCompositeObjectMapping.writeFromObjectIntoRow.

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

Annotations
@Override