Dali Provisional API
Release 3.2

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

All Superinterfaces:
IAdaptable, JpaContextModel, JpaModel, JptResourceTypeReference, Model, OverrideContainer
All Known Subinterfaces:
JavaAttributeOverrideContainer, JavaAttributeOverrideContainer2_0, OrmAttributeOverrideContainer

public interface AttributeOverrideContainer
extends OverrideContainer

Attribute 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

Nested Class Summary
static interface AttributeOverrideContainer.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
 SpecifiedAttributeOverride convertOverrideToSpecified(VirtualOverride virtualOverride)
          Convert the specified virtual override to specified.
 VirtualAttributeOverride convertOverrideToVirtual(SpecifiedOverride specifiedOverride)
          Convert the specified specified override to virtual.
 AttributeOverride getOverrideNamed(String name)
          Return the override with the specified name, whether specified or virtual.
 org.eclipse.jpt.common.utility.iterable.ListIterable<? extends AttributeOverride> getOverrides()
          Return the overrides, both specified and virtual.
 SpecifiedAttributeOverride getSpecifiedOverride(int index)
          Return the specified override at the specified index.
 SpecifiedAttributeOverride getSpecifiedOverrideNamed(String name)
          Return the specified override at the specified index.
 org.eclipse.jpt.common.utility.iterable.ListIterable<? extends SpecifiedAttributeOverride> getSpecifiedOverrides()
          Return the specified overrides.
 org.eclipse.jpt.common.utility.iterable.ListIterable<? extends VirtualAttributeOverride> getVirtualOverrides()
          Return the virtual overrides (i.e. those not specified).
 Column resolveOverriddenColumn(String attributeName)
          Return the column of the mapping or attribute override for the specified attribute.
 
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

resolveOverriddenColumn

Column resolveOverriddenColumn(String attributeName)
Return the column of the mapping or attribute override for the specified attribute. Return null if it does not exist. This column mapping/attribute override will be found in the mapped superclass (or embeddable), not in the owning entity.


getOverrides

org.eclipse.jpt.common.utility.iterable.ListIterable<? extends AttributeOverride> getOverrides()
Description copied from interface: OverrideContainer
Return the overrides, both specified and virtual.

Specified by:
getOverrides in interface OverrideContainer

getOverrideNamed

AttributeOverride 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 SpecifiedAttributeOverride> 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

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

Specified by:
getSpecifiedOverride in interface OverrideContainer

getSpecifiedOverrideNamed

SpecifiedAttributeOverride 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 VirtualAttributeOverride> getVirtualOverrides()
Description copied from interface: OverrideContainer
Return the virtual overrides (i.e. those not specified).

Specified by:
getVirtualOverrides in interface OverrideContainer

convertOverrideToVirtual

VirtualAttributeOverride 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

SpecifiedAttributeOverride 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

Dali Provisional API
Release 3.2

Copyright (c) 2012 Oracle. All rights reserved.