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

All Superinterfaces:

IAdaptable, JpaContextNode, JpaNode, JptResourceTypeReference, Model

All Known Subinterfaces:

AssociationOverrideContainer, AssociationOverrideContainer2_0, AttributeOverrideContainer, JavaAssociationOverrideContainer, JavaAssociationOverrideContainer2_0, JavaAttributeOverrideContainer, JavaAttributeOverrideContainer2_0, JavaOverrideContainer, JavaOverrideContainer2_0, OrmAssociationOverrideContainer, OrmAssociationOverrideContainer2_0, OrmAttributeOverrideContainer, OrmOverrideContainer

public interface OverrideContainer
extends JpaContextNode

attribute or association 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

OverrideContainer.Owner

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

JptResourceTypeReference.ResourceTypeTransformer

Field Summary

static String	SPECIFIED_OVERRIDES_LIST
static String	VIRTUAL_OVERRIDES_LIST

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

RESOURCE_TYPE_TRANSFORMER

Method Summary

org.eclipse.jpt.jpa.core.internal.context.JptValidator	buildColumnValidator(ReadOnlyOverride override, ReadOnlyBaseColumn column, ReadOnlyTableColumn.Owner owner)
org.eclipse.jpt.jpa.core.internal.context.JptValidator	buildOverrideValidator(ReadOnlyOverride override)
Override_	convertOverrideToSpecified(VirtualOverride virtualOverride) Convert the specified virtual override to specified.
VirtualOverride	convertOverrideToVirtual(Override_ specifiedOverride) Convert the specified specified override to virtual.
Iterable<String>	getAllOverridableNames() Return the names of all the attributes that can be overridden (i.e. an override must have a name from this list).
Iterable<String>	getCandidateTableNames() Return the names of tables that are valid for an override's column or join column.
String	getDefaultTableName() Return the name of the default table for an override's column or join column.
TypeMapping	getOverridableTypeMapping() Return the type mapping that contains the attributes/associations to be overridden; though the type mapping may not directly own them (e.g. they may be owned by a supertype mapping).
ReadOnlyOverride	getOverrideNamed(String name) Return the override with the specified name, whether specified or virtual.
org.eclipse.jpt.common.utility.iterable.ListIterable<? extends ReadOnlyOverride>	getOverrides() Return the overrides, both specified and virtual.
int	getOverridesSize() Return the number of overrides, both specified and virtual.
Override_	getSpecifiedOverride(int index) Return the specified override at the specified index.
Override_	getSpecifiedOverrideNamed(String name) Return the specified override at the specified index.
org.eclipse.jpt.common.utility.iterable.ListIterable<? extends Override_>	getSpecifiedOverrides() Return the specified overrides.
int	getSpecifiedOverridesSize() Return the number of specified overrides.
TypeMapping	getTypeMapping() Return the type mapping that contains the override container.
org.eclipse.jpt.common.utility.iterable.ListIterable<? extends VirtualOverride>	getVirtualOverrides() Return the virtual overrides (i.e. those not specified).
int	getVirtualOverridesSize() Return the number of virtual overrides.
void	moveSpecifiedOverride(int targetIndex, int sourceIndex) Move the specified override from the source index to the target index.
Table	resolveDbTable(String tableName) Return the database table for the specified table name.
boolean	tableNameIsInvalid(String tableName) Return whether the specified table cannot be explicitly specified as the table for an override's column or join column.

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

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

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

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

Field Detail

SPECIFIED_OVERRIDES_LIST

static final String SPECIFIED_OVERRIDES_LIST

See Also:

Constant Field Values

VIRTUAL_OVERRIDES_LIST

static final String VIRTUAL_OVERRIDES_LIST

See Also:

Constant Field Values

Method Detail

getTypeMapping

TypeMapping getTypeMapping()

Return the type mapping that contains the override container. For example:

• for an entity, this would be the entity itself
• for an embedded, this would be type mapping where the embedded is declared, as opposed to the type mapping the embedded references

getOverridableTypeMapping

TypeMapping getOverridableTypeMapping()

Return the type mapping that contains the attributes/associations to be overridden; though the type mapping may not directly own them (e.g. they may be owned by a supertype mapping). For example:

• for an entity, this would be the entity's supertype mapping
• for an embedded, this would be the embedded's target type mapping

getAllOverridableNames

Iterable<String> getAllOverridableNames()

Return the names of all the attributes that can be overridden (i.e. an override must have a name from this list). This is usually just all of the overridable names of the overridable type mapping.

See Also:

getOverridableTypeMapping()

tableNameIsInvalid

boolean tableNameIsInvalid(String tableName)

Return whether the specified table cannot be explicitly specified as the table for an override's column or join column.

getCandidateTableNames

Iterable<String> getCandidateTableNames()

Return the names of tables that are valid for an override's column or join column.

resolveDbTable

Table resolveDbTable(String tableName)

Return the database table for the specified table name.

getDefaultTableName

String getDefaultTableName()

Return the name of the default table for an override's column or join column.

buildOverrideValidator

org.eclipse.jpt.jpa.core.internal.context.JptValidator buildOverrideValidator(ReadOnlyOverride override)

buildColumnValidator

org.eclipse.jpt.jpa.core.internal.context.JptValidator buildColumnValidator(ReadOnlyOverride override,
                                                                            ReadOnlyBaseColumn column,
                                                                            ReadOnlyTableColumn.Owner owner)

getOverrides

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

Return the overrides, both specified and virtual.

getOverridesSize

int getOverridesSize()

Return the number of overrides, both specified and virtual.

getOverrideNamed

ReadOnlyOverride getOverrideNamed(String name)

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

getSpecifiedOverrides

org.eclipse.jpt.common.utility.iterable.ListIterable<? extends Override_> getSpecifiedOverrides()

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 Override_.convertToVirtual().

getSpecifiedOverridesSize

int getSpecifiedOverridesSize()

Return the number of specified overrides.

getSpecifiedOverride

Override_ getSpecifiedOverride(int index)

Return the specified override at the specified index.

moveSpecifiedOverride

void moveSpecifiedOverride(int targetIndex,
                           int sourceIndex)

Move the specified override from the source index to the target index.

getSpecifiedOverrideNamed

Override_ getSpecifiedOverrideNamed(String name)

Return the specified override at the specified index.

convertOverrideToVirtual

VirtualOverride convertOverrideToVirtual(Override_ specifiedOverride)

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

getVirtualOverrides

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

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

getVirtualOverridesSize

int getVirtualOverridesSize()

Return the number of virtual overrides.

convertOverrideToSpecified

Override_ convertOverrideToSpecified(VirtualOverride virtualOverride)

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