org.eclipse.jpt.jpa.core.jpa2.context
Interface MapsIdDerivedIdentityStrategy2_0

All Superinterfaces:
DerivedIdentityStrategy2_0, org.eclipse.core.runtime.IAdaptable, IResourcePart, JpaContextNode, JpaNode, Model
All Known Subinterfaces:
JavaMapsIdDerivedIdentityStrategy2_0, OrmMapsIdDerivedIdentityStrategy2_0

public interface MapsIdDerivedIdentityStrategy2_0
extends DerivedIdentityStrategy2_0

Maps ID derived identity strategy

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:
2.3

Field Summary
static java.lang.String DEFAULT_VALUE_PROPERTY
          String associated with changes to the default value property of this object
static java.lang.String SPECIFIED_VALUE_PROPERTY
          String associated with changes to the specified value property of this object
 
Method Summary
 java.lang.String getDefaultValue()
          Return the default attribute name.
 AttributeMapping getResolvedAttributeMappingValue()
          Return attribute mapping referenced by the attribute name, which may be a mapping on the entity or a mapping within the embeddable mapping referenced by the entity's embedded ID mapping.
 java.lang.Iterable<java.lang.String> getSortedValueChoices()
          Return a sorted list of possible attribute names.
 java.lang.String getSpecifiedValue()
          Return the specified attribute name.
 java.lang.String getValue()
          Return the specified attribute name, or in its absence, the default attribute name.
 void setSpecifiedValue(java.lang.String value)
          Set the specified attribute name.
 boolean usesDefaultValue()
          Return whether a default value is ever used.
 
Methods inherited from interface org.eclipse.jpt.jpa.core.jpa2.context.DerivedIdentityStrategy2_0
addStrategy, isSpecified, removeStrategy
 
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_VALUE_PROPERTY

static final java.lang.String SPECIFIED_VALUE_PROPERTY
String associated with changes to the specified value property of this object

See Also:
Constant Field Values

DEFAULT_VALUE_PROPERTY

static final java.lang.String DEFAULT_VALUE_PROPERTY
String associated with changes to the default value property of this object

See Also:
Constant Field Values
Method Detail

getValue

java.lang.String getValue()
Return the specified attribute name, or in its absence, the default attribute name. This the name of the ID attribute the relationship mapping also maps (e.g. a Child's parent mapping also maps part of the Child's primary key, the parent ID).


getSpecifiedValue

java.lang.String getSpecifiedValue()
Return the specified attribute name. Return null if no name is specified.


setSpecifiedValue

void setSpecifiedValue(java.lang.String value)
Set the specified attribute name.


usesDefaultValue

boolean usesDefaultValue()
Return whether a default value is ever used. (In some cases, there can be no default.)


getDefaultValue

java.lang.String getDefaultValue()
Return the default attribute name.


getSortedValueChoices

java.lang.Iterable<java.lang.String> getSortedValueChoices()
Return a sorted list of possible attribute names.


getResolvedAttributeMappingValue

AttributeMapping getResolvedAttributeMappingValue()
Return attribute mapping referenced by the attribute name, which may be a mapping on the entity or a mapping within the embeddable mapping referenced by the entity's embedded ID mapping.