Top Description Fields Constructors Methods

org.eclipse.persistence.eis.mappings

public Class EISCompositeDirectCollectionMapping

Class Inheritance

extends AbstractCompositeDirectCollectionMapping
implements EISMapping

java.lang.Object
org.eclipse.persistence.core.mappings.CoreMapping
org.eclipse.persistence.mappings.DatabaseMapping
org.eclipse.persistence.mappings.foundation.AbstractCompositeDirectCollectionMapping
org.eclipse.persistence.eis.mappings.EISCompositeDirectCollectionMapping

All Implemented Interfaces

org.eclipse.persistence.eis.mappings.EISMapping

Imports

org.eclipse.persistence.exceptions.DescriptorException, org.eclipse.persistence.internal.helper.DatabaseField, org.eclipse.persistence.internal.sessions.AbstractSession, org.eclipse.persistence.mappings.converters.TypeConversionConverter, org.eclipse.persistence.mappings.foundation.AbstractCompositeDirectCollectionMapping, org.eclipse.persistence.oxm.XMLField

EIS Composite Direct Collection Mappings map a collection of simple Java attributes 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 retrieved 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 retrieved 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.AbstractCompositeDirectCollectionMapping:: elementDataTypeName field valueConverter

Constructor Summary

Access	Constructor and Description
public	EISCompositeDirectCollectionMapping()

Method Summary

Modifier and Type	Method and Description
public String	getFieldName() Overrides org.eclipse.persistence.mappings.foundation.AbstractCompositeDirectCollectionMapping.getFieldName. PUBLIC: Return the name of the field that holds the nested collection.
public String	Returns: String the XPath String associated with this Mapping getXPath() Get the XPath String
public void	initialize(AbstractSession session) Overrides org.eclipse.persistence.mappings.foundation.AbstractCompositeDirectCollectionMapping.initialize. INTERNAL: Initialize the mapping.
public boolean	isEISMapping() Overrides org.eclipse.persistence.mappings.DatabaseMapping.isEISMapping. INTERNAL:
public void	setFieldName(String fieldName) PUBLIC: Set the name of the field that holds the nested collection.
public void	setXPath(String String xpathString) Set the Mapping field name attribute to the given XPath String

Inherited from org.eclipse.persistence.mappings.foundation.AbstractCompositeDirectCollectionMapping:: buildAddedElementFromChangeSet buildBackupClone buildChangeSet buildClone buildCloneFromRow buildClonePart buildCopy buildElementFromChangeSet buildElementFromElement buildRemovedElementFromChangeSet cascadePerformRemoveIfRequired cascadeRegisterNewIfRequired collectFields compareElements compareElementsForChange compareForChange compareObjects convertClassNamesToClasses convertToChangeRecord createMapComponentFromRow fixObjectReferences getAttributeElementClass getContainerPolicy getField getFieldClassification getFieldElementClass getRealCollectionAttributeValueFromObject getValueConverter hasValueConverter isAbstractCompositeDirectCollectionMapping isCollectionMapping iterate mapKeyHasChanged mergeChangesIntoObject mergeIntoObject setAttributeElementClass setAttributeElementClassName setContainerPolicy setField setFieldElementClass setUsesSingleNode setValueConverter simpleAddToCollectionChangeRecord simpleRemoveFromCollectionChangeRecord useCollectionClass useCollectionClassName useListClassName useMapClass useMapClassName usesSingleNode valueFromRow writeFromObjectIntoRow writeFromObjectIntoRowForUpdate writeFromObjectIntoRowWithChangeRecord writeInsertFieldsIntoRow

Constructor Detail

EISCompositeDirectCollectionMapping	back to summary
public EISCompositeDirectCollectionMapping()

Method Detail

getFieldName	back to summary
public String getFieldName() Overrides org.eclipse.persistence.mappings.foundation.AbstractCompositeDirectCollectionMapping.getFieldName. PUBLIC: Return the name of the field that holds the nested collection. Annotations @Override

getFieldName

back to summary

public String getFieldName()

Overrides org.eclipse.persistence.mappings.foundation.AbstractCompositeDirectCollectionMapping.getFieldName.

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

Annotations

@Override

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

getXPath

back to summary

public String getXPath()

Get the XPath String

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

initialize	back to summary
public void initialize(AbstractSession session) throws DescriptorException Overrides org.eclipse.persistence.mappings.foundation.AbstractCompositeDirectCollectionMapping.initialize. INTERNAL: Initialize the mapping. Annotations @Override

initialize

back to summary

public void initialize(AbstractSession session) throws DescriptorException

Overrides org.eclipse.persistence.mappings.foundation.AbstractCompositeDirectCollectionMapping.initialize.

INTERNAL: Initialize the mapping.

Annotations

@Override

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 name of the field that holds the nested collection.

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