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

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable, IResourcePart, JpaContextNode, JpaNode, Model, OverrideContainer
All Known Subinterfaces:
JavaAssociationOverrideContainer, OrmAssociationOverrideContainer

public interface AssociationOverrideContainer
extends OverrideContainer

Association override container. Used by entities, embedded mappings, and element collection 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
Version:
3.0

Nested Class Summary
static interface AssociationOverrideContainer.Owner
           
 
Field Summary
 
Fields inherited from interface org.eclipse.jpt.jpa.core.context.OverrideContainer
SPECIFIED_OVERRIDES_LIST, VIRTUAL_OVERRIDES_LIST
 
Method Summary
 org.eclipse.jpt.jpa.core.internal.context.JptValidator buildJoinTableInverseJoinColumnValidator(AssociationOverride override, JoinColumn column, JoinColumn.Owner owner, org.eclipse.jpt.jpa.core.internal.context.JoinColumnTextRangeResolver textRangeResolver)
           
 org.eclipse.jpt.jpa.core.internal.context.JptValidator buildJoinTableJoinColumnValidator(AssociationOverride override, JoinColumn column, JoinColumn.Owner owner, org.eclipse.jpt.jpa.core.internal.context.JoinColumnTextRangeResolver textRangeResolver)
           
 org.eclipse.jpt.jpa.core.internal.context.JptValidator buildTableValidator(AssociationOverride override, Table table, org.eclipse.jpt.jpa.core.internal.context.TableTextRangeResolver textRangeResolver)
           
 AssociationOverride convertOverrideToSpecified(VirtualOverride virtualOverride)
          Convert the specified virtual override to specified.
 VirtualAssociationOverride convertOverrideToVirtual(Override_ specifiedOverride)
          Convert the specified specified override to virtual.
 ReadOnlyAssociationOverride getOverrideNamed(java.lang.String name)
          Return the override with the specified name, whether specified or virtual.
 RelationshipMapping getRelationshipMapping(java.lang.String attributeName)
          Return the relationship mapping with the given attribute name.
 AssociationOverride getSpecifiedOverride(int index)
          Return the specified override at the specified index.
 AssociationOverride getSpecifiedOverrideNamed(java.lang.String name)
           
 java.util.ListIterator<? extends ReadOnlyAssociationOverride> overrides()
          Return the overrides, both specified and virtual.
 Relationship resolveOverriddenRelationship(java.lang.String attributeName)
          Return the relationship with the specified attribute name.
 java.util.ListIterator<? extends AssociationOverride> specifiedOverrides()
          Return the specified overrides.
 java.util.ListIterator<? extends VirtualAssociationOverride> virtualOverrides()
          Return the virtual overrides, those not specified.
 
Methods inherited from interface org.eclipse.jpt.jpa.core.context.OverrideContainer
allOverridableNames, buildColumnValidator, buildValidator, candidateTableNames, getDefaultTableName, getOverridableTypeMapping, getTypeMapping, moveSpecifiedOverride, overridesSize, resolveDbTable, specifiedOverridesSize, tableNameIsInvalid, virtualOverridesSize
 
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
 

Method Detail

overrides

java.util.ListIterator<? extends ReadOnlyAssociationOverride> overrides()
Description copied from interface: OverrideContainer
Return the overrides, both specified and virtual.

Specified by:
overrides in interface OverrideContainer

getOverrideNamed

ReadOnlyAssociationOverride getOverrideNamed(java.lang.String name)
Description copied from interface: OverrideContainer
Return the override with the specified name, whether specified or virtual.

Specified by:
getOverrideNamed in interface OverrideContainer

specifiedOverrides

java.util.ListIterator<? extends AssociationOverride> specifiedOverrides()
Description copied from interface: OverrideContainer
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.

Specified by:
specifiedOverrides in interface OverrideContainer

getSpecifiedOverride

AssociationOverride getSpecifiedOverride(int index)
Description copied from interface: OverrideContainer
Return the specified override at the specified index.

Specified by:
getSpecifiedOverride in interface OverrideContainer

getSpecifiedOverrideNamed

AssociationOverride getSpecifiedOverrideNamed(java.lang.String name)
Specified by:
getSpecifiedOverrideNamed in interface OverrideContainer

virtualOverrides

java.util.ListIterator<? extends VirtualAssociationOverride> virtualOverrides()
Description copied from interface: OverrideContainer
Return the virtual overrides, those not specified.

Specified by:
virtualOverrides in interface OverrideContainer

convertOverrideToVirtual

VirtualAssociationOverride convertOverrideToVirtual(Override_ specifiedOverride)
Description copied from interface: OverrideContainer
Convert the specified specified override to virtual. Return the new override.

Specified by:
convertOverrideToVirtual in interface OverrideContainer

convertOverrideToSpecified

AssociationOverride 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

getRelationshipMapping

RelationshipMapping getRelationshipMapping(java.lang.String attributeName)
Return the relationship mapping with the given attribute name. Return null if it does not exist. This relationship mapping will be found in the mapped superclass, not in the owning entity


resolveOverriddenRelationship

Relationship resolveOverriddenRelationship(java.lang.String attributeName)
Return the relationship with the specified attribute name.


buildJoinTableJoinColumnValidator

org.eclipse.jpt.jpa.core.internal.context.JptValidator buildJoinTableJoinColumnValidator(AssociationOverride override,
                                                                                         JoinColumn column,
                                                                                         JoinColumn.Owner owner,
                                                                                         org.eclipse.jpt.jpa.core.internal.context.JoinColumnTextRangeResolver textRangeResolver)

buildJoinTableInverseJoinColumnValidator

org.eclipse.jpt.jpa.core.internal.context.JptValidator buildJoinTableInverseJoinColumnValidator(AssociationOverride override,
                                                                                                JoinColumn column,
                                                                                                JoinColumn.Owner owner,
                                                                                                org.eclipse.jpt.jpa.core.internal.context.JoinColumnTextRangeResolver textRangeResolver)

buildTableValidator

org.eclipse.jpt.jpa.core.internal.context.JptValidator buildTableValidator(AssociationOverride override,
                                                                           Table table,
                                                                           org.eclipse.jpt.jpa.core.internal.context.TableTextRangeResolver textRangeResolver)