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

public Class ArrayMapping

extends AbstractCompositeDirectCollectionMapping
Class Inheritance
Imports
org.eclipse.persistence.exceptions.*, org.eclipse.persistence.internal.sessions.AbstractSession, org.eclipse.persistence.mappings.foundation.AbstractCompositeDirectCollectionMapping

Purpose: In an object-relational data model, structures can contain "Arrays" or collections of other data-types. In Oracle 8i, a "VARRAY" is typically used to represent a collection of primitive data or aggregate structures. These arrays are stored with their parent structure in the same table.

See Also
StructureMapping, NestedTableMapping, ReferenceMapping

Field Summary

Inherited from org.eclipse.persistence.mappings.foundation.AbstractCompositeDirectCollectionMapping:
elementDataTypeNamefieldvalueConverter

Constructor Summary

AccessConstructor and Description
public
ArrayMapping()

Default constructor.

Method Summary

Modifier and TypeMethod and Description
public String
getElementDataTypeName()

PUBLIC: Return the "data type" associated with each element in the nested collection.

public String
getStructureName()

PUBLIC: Return the name of the structure.

public void
initialize(AbstractSession session)

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

INTERNAL: Initialize the mapping.
public boolean
isRelationalMapping()

Overrides org.eclipse.persistence.mappings.DatabaseMapping.isRelationalMapping.

INTERNAL:
public void
setElementDataTypeName(String elementDataTypeName)

PUBLIC: Set the "data type" associated with each element in the nested collection.

public void
setFieldName(String fieldName)

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

public void
setStructureName(String structureName)

PUBLIC: Set the name of the structure.

Inherited from org.eclipse.persistence.mappings.foundation.AbstractCompositeDirectCollectionMapping:
buildAddedElementFromChangeSetbuildBackupClonebuildChangeSetbuildClonebuildCloneFromRowbuildClonePartbuildCopybuildElementFromChangeSetbuildElementFromElementbuildRemovedElementFromChangeSetcascadePerformRemoveIfRequiredcascadeRegisterNewIfRequiredcollectFieldscompareElementscompareElementsForChangecompareForChangecompareObjectsconvertClassNamesToClassesconvertToChangeRecordcreateMapComponentFromRowfixObjectReferencesgetAttributeElementClassgetContainerPolicygetFieldgetFieldClassificationgetFieldElementClassgetFieldNamegetRealCollectionAttributeValueFromObjectgetValueConverterhasValueConverterisAbstractCompositeDirectCollectionMappingisCollectionMappingiteratemapKeyHasChangedmergeChangesIntoObjectmergeIntoObjectsetAttributeElementClasssetAttributeElementClassNamesetContainerPolicysetFieldsetFieldElementClasssetUsesSingleNodesetValueConvertersimpleAddToCollectionChangeRecordsimpleRemoveFromCollectionChangeRecorduseCollectionClassuseCollectionClassNameuseListClassNameuseMapClassuseMapClassNameusesSingleNodevalueFromRowwriteFromObjectIntoRowwriteFromObjectIntoRowForUpdatewriteFromObjectIntoRowWithChangeRecordwriteInsertFieldsIntoRow

Constructor Detail

ArrayMappingback to summary
public ArrayMapping()

Default constructor.

Method Detail

getElementDataTypeNameback to summary
public String getElementDataTypeName()

PUBLIC: Return the "data type" associated with each element in the nested collection. Depending on the data store, this could be optional.

getStructureNameback to summary
public String getStructureName()

PUBLIC: Return the name of the structure. This is the name of the user-defined data type as defined on the database.

initializeback to summary
public void initialize(AbstractSession session) throws DescriptorException

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

INTERNAL: Initialize the mapping.

Annotations
@Override
isRelationalMappingback to summary
public boolean isRelationalMapping()

Overrides org.eclipse.persistence.mappings.DatabaseMapping.isRelationalMapping.

INTERNAL:

Annotations
@Override
setElementDataTypeNameback to summary
public void setElementDataTypeName(String elementDataTypeName)

PUBLIC: Set the "data type" associated with each element in the nested collection. Depending on the data store, this could be optional.

setFieldNameback to summary
public void setFieldName(String fieldName)

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

setStructureNameback to summary
public void setStructureName(String structureName)

PUBLIC: Set the name of the structure. This is the name of the user-defined data type as defined on the database.