org.eclipse.jpt.jpa.core.context.orm
Interface OrmAttributeOverrideContainer

All Superinterfaces:

AttributeOverrideContainer, IAdaptable, JpaContextModel, JpaModel, JptResourceTypeReference, Model, OrmOverrideContainer, OverrideContainer

public interface OrmAttributeOverrideContainer
extends AttributeOverrideContainer, OrmOverrideContainer

orm.xml attribute override container

Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Since:

2.3

Nested Class Summary

static interface

OrmAttributeOverrideContainer.ParentAdapter

Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.JpaModel

JpaModel.JpaVersionIsCompatibleWith

Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

JptResourceTypeReference.ResourceTypeIsKindOf, JptResourceTypeReference.ResourceTypeTransformer

Field Summary

Fields inherited from interface org.eclipse.jpt.jpa.core.context.OverrideContainer

SPECIFIED_OVERRIDES_LIST, VIRTUAL_OVERRIDES_LIST

Fields inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

TRANSFORMER

Method Summary

OrmSpecifiedAttributeOverride	convertOverrideToSpecified(VirtualOverride virtualOverride) Convert the specified virtual override to specified.
OrmVirtualAttributeOverride	convertOverrideToVirtual(SpecifiedOverride specifiedOverride) Convert the specified specified override to virtual.
OrmSpecifiedAttributeOverride	getSpecifiedOverride(int index) Return the specified override at the specified index.
OrmSpecifiedAttributeOverride	getSpecifiedOverrideNamed(String name) Return the specified override at the specified index.
org.eclipse.jpt.common.utility.iterable.ListIterable<OrmSpecifiedAttributeOverride>	getSpecifiedOverrides() Return the specified overrides.
org.eclipse.jpt.common.utility.iterable.ListIterable<OrmVirtualAttributeOverride>	getVirtualOverrides() Return the virtual overrides (i.e. those not specified).
void	initializeFrom(OrmAttributeOverrideContainer oldContainer) Called when converting an embedded mapping to an embedded ID mapping (and vice-versa); to preserve any specified attribute overrides.

Methods inherited from interface org.eclipse.jpt.jpa.core.context.AttributeOverrideContainer

getOverrideNamed, getOverrides, resolveOverriddenColumn

Methods inherited from interface org.eclipse.jpt.jpa.core.context.OverrideContainer

buildColumnValidator, buildOverrideValidator, getAllOverridableNames, getCandidateTableNames, getDefaultTableName, getOverridableTypeMapping, getOverridesSize, getSpecifiedOverridesSize, getTypeMapping, getVirtualOverridesSize, moveSpecifiedOverride, resolveDbTable, tableNameIsInvalid

Methods inherited from interface org.eclipse.jpt.jpa.core.context.JpaContextModel

getCompletionProposals, getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getParent, getPersistenceUnit, getValidationTextRange, synchronizeWithResourceModel, update, validate

Methods inherited from interface org.eclipse.jpt.jpa.core.JpaModel

getJpaPlatform, getJpaProject, getJpaProjectManager, getResource, stateChanged

Methods inherited from interface org.eclipse.jpt.common.utility.model.Model

addChangeListener, addCollectionChangeListener, addListChangeListener, addPropertyChangeListener, addStateChangeListener, removeChangeListener, removeCollectionChangeListener, removeListChangeListener, removePropertyChangeListener, removeStateChangeListener

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Methods inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

getResourceType

Method Detail

initializeFrom

void initializeFrom(OrmAttributeOverrideContainer oldContainer)

Called when converting an embedded mapping to an embedded ID mapping (and vice-versa); to preserve any specified attribute overrides.

NB: There is no corresponding method on the Java container because Java mapping conversions simply change the mapping annotation and leave the [sibling] attribute override annotations in place; while orm.xml mapping conversions must move the [nested] attribute override XML elements to the new mapping XML element.

NB: There is no corresponding method on the association override container because embedded ID mappings do not have association overrides; so there is no need to convert those.

getSpecifiedOverrides

org.eclipse.jpt.common.utility.iterable.ListIterable<OrmSpecifiedAttributeOverride> getSpecifiedOverrides()

Description copied from interface: OverrideContainer

Return the specified overrides. The container has no API for adding or removing specified overrides. The container's virtual overrides are built according to the list of overridable attribute names returned by the container's parent. Specified overrides can be created via VirtualOverride.convertToSpecified(). Specified overrides can be remvoed via SpecifiedOverride.convertToVirtual().

Specified by:

getSpecifiedOverrides in interface AttributeOverrideContainer

Specified by:

getSpecifiedOverrides in interface OrmOverrideContainer

Specified by:

getSpecifiedOverrides in interface OverrideContainer

getSpecifiedOverride

OrmSpecifiedAttributeOverride getSpecifiedOverride(int index)

Description copied from interface: OverrideContainer

Return the specified override at the specified index.

Specified by:

getSpecifiedOverride in interface AttributeOverrideContainer

Specified by:

getSpecifiedOverride in interface OrmOverrideContainer

Specified by:

getSpecifiedOverride in interface OverrideContainer

getSpecifiedOverrideNamed

OrmSpecifiedAttributeOverride getSpecifiedOverrideNamed(String name)

Description copied from interface: OverrideContainer

Return the specified override at the specified index.

Specified by:

getSpecifiedOverrideNamed in interface AttributeOverrideContainer

Specified by:

getSpecifiedOverrideNamed in interface OrmOverrideContainer

Specified by:

getSpecifiedOverrideNamed in interface OverrideContainer

getVirtualOverrides

org.eclipse.jpt.common.utility.iterable.ListIterable<OrmVirtualAttributeOverride> getVirtualOverrides()

Description copied from interface: OverrideContainer

Return the virtual overrides (i.e. those not specified).

Specified by:

getVirtualOverrides in interface AttributeOverrideContainer

Specified by:

getVirtualOverrides in interface OrmOverrideContainer

Specified by:

getVirtualOverrides in interface OverrideContainer

convertOverrideToVirtual

OrmVirtualAttributeOverride convertOverrideToVirtual(SpecifiedOverride specifiedOverride)

Description copied from interface: OverrideContainer

Convert the specified specified override to virtual. Return the new override.

Specified by:

convertOverrideToVirtual in interface AttributeOverrideContainer

Specified by:

convertOverrideToVirtual in interface OrmOverrideContainer

Specified by:

convertOverrideToVirtual in interface OverrideContainer

convertOverrideToSpecified

OrmSpecifiedAttributeOverride convertOverrideToSpecified(VirtualOverride virtualOverride)

Description copied from interface: OverrideContainer

Convert the specified virtual override to specified. Return the new override.

Specified by:

convertOverrideToSpecified in interface AttributeOverrideContainer

Specified by:

convertOverrideToSpecified in interface OrmOverrideContainer

Specified by:

convertOverrideToSpecified in interface OverrideContainer