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

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable, IResourcePart, JpaContextNode, JpaNode, Model

All Known Subinterfaces:

AssociationOverrideContainer, AttributeOverrideContainer, JavaAssociationOverrideContainer, JavaAttributeOverrideContainer, JavaOverrideContainer, OrmAssociationOverrideContainer, 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

Version:

3.0

Nested Class Summary

static interface

OverrideContainer.Owner

Field Summary

static java.lang.String	SPECIFIED_OVERRIDES_LIST
static java.lang.String	VIRTUAL_OVERRIDES_LIST

Method Summary

java.util.Iterator<java.lang.String>	allOverridableNames() Return the names of all attributes that can be overridden
org.eclipse.jpt.jpa.core.internal.context.JptValidator	buildColumnValidator(Override_ override, BaseColumn column, BaseColumn.Owner owner, org.eclipse.jpt.jpa.core.internal.context.BaseColumnTextRangeResolver textRangeResolver)
org.eclipse.jpt.jpa.core.internal.context.JptValidator	buildValidator(Override_ override, org.eclipse.jpt.jpa.core.internal.context.OverrideTextRangeResolver textRangeResolver)
java.util.Iterator<java.lang.String>	candidateTableNames() Return the names of tables that are valid for the overrides column or join columns.
Override_	convertOverrideToSpecified(VirtualOverride virtualOverride) Convert the specified virtual override to specified.
VirtualOverride	convertOverrideToVirtual(Override_ specifiedOverride) Convert the specified specified override to virtual.
java.lang.String	getDefaultTableName() Return the name of the table which the column belongs to by default
TypeMapping	getOverridableTypeMapping() Return the type mapping that contains the attributes/associations to be overridden.
ReadOnlyOverride	getOverrideNamed(java.lang.String name) Return the override with the specified name, whether specified or virtual.
Override_	getSpecifiedOverride(int index) Return the specified override at the specified index.
Override_	getSpecifiedOverrideNamed(java.lang.String name)
TypeMapping	getTypeMapping() Return the type mapping that this override is contained in
void	moveSpecifiedOverride(int targetIndex, int sourceIndex) Move the specified override from the source index to the target index.
java.util.ListIterator<? extends ReadOnlyOverride>	overrides() Return the overrides, both specified and virtual.
int	overridesSize() Return the number of overrides, both specified and default.
Table	resolveDbTable(java.lang.String tableName) Return the database table for the specified table name
java.util.ListIterator<? extends Override_>	specifiedOverrides() Return the specified overrides.
int	specifiedOverridesSize() Return the number of specified overrides.
boolean	tableNameIsInvalid(java.lang.String tableName) return whether the given table cannot be explicitly specified in the column or join column's 'table' element
java.util.ListIterator<? extends VirtualOverride>	virtualOverrides() Return the virtual overrides, those not specified.
int	virtualOverridesSize() Return the number of virtual overrides.

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

getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, getResourceType, synchronizeWithResourceModel, update

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

getJpaProject, getParent, stateChanged

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

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

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

getAdapter

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

getResource

Field Detail

SPECIFIED_OVERRIDES_LIST

static final java.lang.String SPECIFIED_OVERRIDES_LIST

See Also:

Constant Field Values

VIRTUAL_OVERRIDES_LIST

static final java.lang.String VIRTUAL_OVERRIDES_LIST

See Also:

Constant Field Values

Method Detail

getTypeMapping

TypeMapping getTypeMapping()

Return the type mapping that this override is contained in

getOverridableTypeMapping

TypeMapping getOverridableTypeMapping()

Return the type mapping that contains the attributes/associations to be overridden. (Though the type mapping may not directly own them (i.e. they may be on a supertype mapping). (For example: for an entity, this would be the supertype mapping of that entity; for an embedded, this would be the target type mapping of the embedded.)

allOverridableNames

java.util.Iterator<java.lang.String> allOverridableNames()

Return the names of all attributes that can be overridden

convertOverrideToVirtual

VirtualOverride convertOverrideToVirtual(Override_ specifiedOverride)

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

convertOverrideToSpecified

Override_ convertOverrideToSpecified(VirtualOverride virtualOverride)

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

tableNameIsInvalid

boolean tableNameIsInvalid(java.lang.String tableName)

return whether the given table cannot be explicitly specified in the column or join column's 'table' element

candidateTableNames

java.util.Iterator<java.lang.String> candidateTableNames()

Return the names of tables that are valid for the overrides column or join columns.

resolveDbTable

Table resolveDbTable(java.lang.String tableName)

Return the database table for the specified table name

getDefaultTableName

java.lang.String getDefaultTableName()

Return the name of the table which the column belongs to by default

buildColumnValidator

org.eclipse.jpt.jpa.core.internal.context.JptValidator buildColumnValidator(Override_ override,
                                                                            BaseColumn column,
                                                                            BaseColumn.Owner owner,
                                                                            org.eclipse.jpt.jpa.core.internal.context.BaseColumnTextRangeResolver textRangeResolver)

buildValidator

org.eclipse.jpt.jpa.core.internal.context.JptValidator buildValidator(Override_ override,
                                                                      org.eclipse.jpt.jpa.core.internal.context.OverrideTextRangeResolver textRangeResolver)

overrides

java.util.ListIterator<? extends ReadOnlyOverride> overrides()

Return the overrides, both specified and virtual.

overridesSize

int overridesSize()

Return the number of overrides, both specified and default.

getOverrideNamed

ReadOnlyOverride getOverrideNamed(java.lang.String name)

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

specifiedOverrides

java.util.ListIterator<? extends Override_> specifiedOverrides()

Return the specified overrides. No add/remove for specified overrides, the virtual overrides will be populated from the owner, then use VirtualOverride.convertToSpecified() to add/remove the override from the container.

specifiedOverridesSize

int specifiedOverridesSize()

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(java.lang.String name)

virtualOverrides

java.util.ListIterator<? extends VirtualOverride> virtualOverrides()

Return the virtual overrides, those not specified.

virtualOverridesSize

int virtualOverridesSize()

Return the number of virtual overrides.