Top Description Fields Constructors Methods

org.eclipse.persistence.eis.mappings

public Class EISDirectMapping

Class Inheritance

extends AbstractDirectMapping
implements EISMapping

java.lang.Object
org.eclipse.persistence.core.mappings.CoreMapping
org.eclipse.persistence.mappings.DatabaseMapping
org.eclipse.persistence.mappings.foundation.AbstractColumnMapping
org.eclipse.persistence.mappings.foundation.AbstractDirectMapping
org.eclipse.persistence.eis.mappings.EISDirectMapping

All Implemented Interfaces

org.eclipse.persistence.eis.mappings.EISMapping

Imports

org.eclipse.persistence.eis.EISDescriptor, org.eclipse.persistence.internal.helper.DatabaseField, org.eclipse.persistence.internal.sessions.AbstractRecord, .AbstractSession, org.eclipse.persistence.mappings.foundation.AbstractDirectMapping, org.eclipse.persistence.oxm.XMLField, org.eclipse.persistence.oxm.record.XMLRecord

EIS Direct Mappings map a simple Java attribute to and from 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.AbstractDirectMapping:: attributeClassification attributeClassificationName attributeObjectClassification bypassDefaultNullValueCheck fieldClassificationClassName isMutable keyTableForMapKey nullValue

Constructor Summary

Access	Constructor and Description
public	EISDirectMapping()

Method Summary

Modifier and Type	Method and Description
public String	Returns: String the XPath String associated with this Mapping getXPath() Get the XPath String associated with this Mapping
public boolean	isEISMapping() Overrides org.eclipse.persistence.mappings.DatabaseMapping.isEISMapping. INTERNAL:
public void	setFieldName(String fieldName) PUBLIC: Set the field name in 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 row, AbstractSession session, DatabaseMapping.WriteType writeType) Overrides org.eclipse.persistence.mappings.foundation.AbstractDirectMapping.writeFromObjectIntoRow. INTERNAL: We override this method in order to set the session on the record if the data format is XML.
protected void	writeValueIntoRow(AbstractRecord row, DatabaseField field, Object fieldValue) Implements abstract org.eclipse.persistence.mappings.foundation.AbstractDirectMapping.writeValueIntoRow. INTERNAL:

Inherited from org.eclipse.persistence.mappings.foundation.AbstractDirectMapping:: addAdditionalFieldsToQuery addFieldsForMapKey addKeyToDeletedObjectsList buildBackupClone buildChangeRecord buildClone buildCloneFromRow buildCloneValue buildCloneValue buildCopy buildElementClone buildExpression buildSelectionQueryForDirectCollectionKeyMapping buildShallowOriginalFromRow cascadeDiscoverAndPersistUnregisteredNewObjects cascadePerformRemoveIfRequired cascadePerformRemoveIfRequired cascadeRegisterNewIfRequired cascadeRegisterNewIfRequired compareForChange compareObjects compareObjectValues convertClassNamesToClasses createMapComponentFromJoinedRow createMapComponentFromRow createMapComponentsFromSerializableKeyInfo createQueryKeyForMapKey createSerializableMapKeyInfo createStubbedMapComponentFromSerializableKeyInfo deleteMapKey extractIdentityFieldsForQuery getAdditionalSelectionCriteriaForMapKey getAdditionalTablesForJoinQuery getAllFieldsForMapKey getAttributeClassification getAttributeClassificationName getFieldClassification getFieldClassification getFieldClassificationClassName getFieldName getFieldValue getForeignKeyFieldsForMapKey getIdentityFieldsForMapKey getMapKeyTargetType getNestedJoinQuery getNullValue getObjectValue getObjectValueWithoutClassCheck getReferenceDescriptor getTargetVersionOfSourceObject getWeight initialize internalBuildChangeRecord isAbstractDirectMapping isChangeTrackingSupported isCloningRequired isDirectToFieldMapping isMutable iterateOnMapKey mergeChangesIntoObject mergeIntoObject postInitializeMapKey preInitialize preinitializeMapKey remoteInitialization requiresDataModificationEventsForMapKey setAttributeClassification setAttributeClassificationName setFieldClassification setFieldClassificationClassName setFieldType setIsMutable setNullValue toString unwrapKey updateChangeRecord validateBeforeInitialization valueFromObject valueFromResultSet valueFromRow wrapKey writeFromObjectIntoRowForUpdate writeFromObjectIntoRowWithChangeRecord writeInsertFieldsIntoRow writeUpdateFieldsIntoRow

Constructor Detail

EISDirectMapping	back to summary
public EISDirectMapping()

Method Detail

getXPath	back to summary
public String getXPath() Get the XPath String associated with this Mapping Returns:String String the XPath String associated with this Mapping

getXPath

back to summary

public String getXPath()

Get the XPath String associated with this Mapping

Returns:String: String the XPath String associated with this Mapping

isEISMapping	back to summary
public boolean isEISMapping() Overrides org.eclipse.persistence.mappings.DatabaseMapping.isEISMapping. INTERNAL: Annotations @Override

isEISMapping

back to summary

public boolean isEISMapping()

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

INTERNAL:

Annotations

@Override

setFieldName	back to summary
public void setFieldName(String fieldName) PUBLIC: Set the field name in the mapping.

setXPath	back to summary
public void setXPath(String xpathString) Set the Mapping field name attribute to the given XPath String. Parameters xpathString:String String

setXPath

back to summary

public void setXPath(String xpathString)

Set the Mapping field name attribute to the given XPath String.

Parameters

xpathString:String: String

writeFromObjectIntoRow	back to summary
public void writeFromObjectIntoRow(Object object, AbstractRecord row, AbstractSession session, DatabaseMapping.WriteType writeType) Overrides org.eclipse.persistence.mappings.foundation.AbstractDirectMapping.writeFromObjectIntoRow. INTERNAL: We override this method in order to set the session on the record if the data format is XML. Get a value from the object and set that in the respective field of the row. Annotations @Override

writeFromObjectIntoRow

back to summary

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

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

INTERNAL: We override this method in order to set the session on the record if the data format is XML. Get a value from the object and set that in the respective field of the row.

Annotations

@Override

writeValueIntoRow	back to summary
protected void writeValueIntoRow(AbstractRecord row, DatabaseField field, Object fieldValue) Implements abstract org.eclipse.persistence.mappings.foundation.AbstractDirectMapping.writeValueIntoRow. Doc from org.eclipse.persistence.mappings.foundation.AbstractColumnMapping.writeValueIntoRow. INTERNAL: Annotations @Override

writeValueIntoRow

back to summary

protected void writeValueIntoRow(AbstractRecord row, DatabaseField field, Object fieldValue)

Implements abstract org.eclipse.persistence.mappings.foundation.AbstractDirectMapping.writeValueIntoRow.

Doc from org.eclipse.persistence.mappings.foundation.AbstractColumnMapping.writeValueIntoRow.

INTERNAL:

Annotations

@Override