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

public Class StructureMapping

extends AbstractCompositeObjectMapping
Class Inheritance
Imports
org.eclipse.persistence.exceptions.*, org.eclipse.persistence.internal.sessions.AbstractSession, .AbstractRecord, org.eclipse.persistence.internal.descriptors.ObjectBuilder, org.eclipse.persistence.internal.identitymaps.CacheKey, org.eclipse.persistence.queries.ObjectBuildingQuery, org.eclipse.persistence.internal.queries.JoinedAttributeManager, org.eclipse.persistence.mappings.foundation.AbstractCompositeObjectMapping

Purpose: A structure is an object-relational user-defined data-type or object-type. A structure is similar to a Java class as it defines attributes or fields where each attribute is either a primitive data-type, another structure, an array, or a reference to another structure. The mapping is similar to an AggregateObjectMapping, as multiple objects are stored in a single table.

Field Summary

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

Constructor Summary

AccessConstructor and Description
public
StructureMapping()

Default constructor.

Method Summary

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

INTERNAL: Return the name of the structure.

public void
public boolean
public boolean
public void
setFieldName(String fieldName)

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

Constructor Detail

StructureMappingback to summary
public StructureMapping()

Default constructor.

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
getStructureNameback to summary
public String getStructureName()

INTERNAL: 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.AbstractCompositeObjectMapping.initialize.

INTERNAL: Initialize the mapping.

Annotations
@Override
isRelationalMappingback to summary
public boolean isRelationalMapping()

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

INTERNAL:

Annotations
@Override
isStructureMappingback to summary
public boolean isStructureMapping()

Overrides org.eclipse.persistence.mappings.DatabaseMapping.isStructureMapping.

INTERNAL:

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