org.eclipse.jpt.jpa.core.context
Interface AssociationOverrideContainer

All Superinterfaces:

IAdaptable, JpaContextModel, JpaModel, JptResourceTypeReference, Model, OverrideContainer

All Known Subinterfaces:

AssociationOverrideContainer2_0, JavaAssociationOverrideContainer, JavaAssociationOverrideContainer2_0, OrmAssociationOverrideContainer, OrmAssociationOverrideContainer2_0

public interface AssociationOverrideContainer
extends OverrideContainer

Association override container.

Clients:

• entity - override mapped superclass association mappings
• embedded mapping - override embeddable association mappings
• element collection mapping - override (value/map value) embeddable association mappings

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

AssociationOverrideContainer.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

SpecifiedAssociationOverride	convertOverrideToSpecified(VirtualOverride virtualOverride) Convert the specified virtual override to specified.
VirtualAssociationOverride	convertOverrideToVirtual(SpecifiedOverride specifiedOverride) Convert the specified specified override to virtual.
AssociationOverride	getOverrideNamed(String name) Return the override with the specified name, whether specified or virtual.
org.eclipse.jpt.common.utility.iterable.ListIterable<? extends AssociationOverride>	getOverrides() Return the overrides, both specified and virtual.
RelationshipMapping	getRelationshipMapping(String attributeName) Return the relationship mapping for the specified attribute.
SpecifiedAssociationOverride	getSpecifiedOverride(int index) Return the specified override at the specified index.
SpecifiedAssociationOverride	getSpecifiedOverrideNamed(String name) Return the specified override at the specified index.
org.eclipse.jpt.common.utility.iterable.ListIterable<? extends SpecifiedAssociationOverride>	getSpecifiedOverrides() Return the specified overrides.
org.eclipse.jpt.common.utility.iterable.ListIterable<? extends VirtualAssociationOverride>	getVirtualOverrides() Return the virtual overrides (i.e. those not specified).
Relationship	resolveOverriddenRelationship(String attributeName) Return the relationship with the specified attribute name.

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

getRelationshipMapping

RelationshipMapping getRelationshipMapping(String attributeName)

Return the relationship mapping for the specified attribute. Return null if it does not exist. This relationship mapping will be found in the mapped superclass or embeddable type whose mapping is being overridden, not in the owning entity

resolveOverriddenRelationship

Relationship resolveOverriddenRelationship(String attributeName)

Return the relationship with the specified attribute name.

getOverrides

org.eclipse.jpt.common.utility.iterable.ListIterable<? extends AssociationOverride> getOverrides()

Description copied from interface: OverrideContainer

Return the overrides, both specified and virtual.

Specified by:

getOverrides in interface OverrideContainer

getOverrideNamed

AssociationOverride getOverrideNamed(String name)

Description copied from interface: OverrideContainer

Return the override with the specified name, whether specified or virtual.

Specified by:

getOverrideNamed in interface OverrideContainer

getSpecifiedOverrides

org.eclipse.jpt.common.utility.iterable.ListIterable<? extends SpecifiedAssociationOverride> 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 OverrideContainer

getSpecifiedOverride

SpecifiedAssociationOverride getSpecifiedOverride(int index)

Description copied from interface: OverrideContainer

Return the specified override at the specified index.

Specified by:

getSpecifiedOverride in interface OverrideContainer

getSpecifiedOverrideNamed

SpecifiedAssociationOverride getSpecifiedOverrideNamed(String name)

Description copied from interface: OverrideContainer

Return the specified override at the specified index.

Specified by:

getSpecifiedOverrideNamed in interface OverrideContainer

getVirtualOverrides

org.eclipse.jpt.common.utility.iterable.ListIterable<? extends VirtualAssociationOverride> getVirtualOverrides()

Description copied from interface: OverrideContainer

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

Specified by:

getVirtualOverrides in interface OverrideContainer

convertOverrideToVirtual

VirtualAssociationOverride convertOverrideToVirtual(SpecifiedOverride specifiedOverride)

Description copied from interface: OverrideContainer

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

Specified by:

convertOverrideToVirtual in interface OverrideContainer

convertOverrideToSpecified

SpecifiedAssociationOverride convertOverrideToSpecified(VirtualOverride virtualOverride)

Description copied from interface: OverrideContainer

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

Specified by:

convertOverrideToSpecified in interface OverrideContainer