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

All Superinterfaces:

DerivedIdentityStrategy2_0, IAdaptable, JpaContextModel, JpaModel, JptResourceTypeReference, Model

All Known Subinterfaces:

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

Nested Class Summary

static class

MapsIdDerivedIdentityStrategy2_0.IdAttributeNameTransformer

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

static String	DEFAULT_ID_ATTRIBUTE_NAME_PROPERTY String associated with changes to the default ID attribute name property.
static org.eclipse.jpt.common.utility.transformer.Transformer<MapsIdDerivedIdentityStrategy2_0,String>	ID_ATTRIBUTE_NAME_TRANSFORMER
static String	SPECIFIED_ID_ATTRIBUTE_NAME_PROPERTY String associated with changes to the specified ID attribute name property.

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

TRANSFORMER

Method Summary

boolean	defaultIdAttributeNameIsPossible() Return whether a default value is ever used.
String	getDefaultIdAttributeName() Return the default ID attribute name.
AttributeMapping	getDerivedIdAttributeMapping() Return attribute mapping referenced by the ID 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.
String	getIdAttributeName() Return the specified ID attribute name or, in its absence, the default ID attribute name.
Iterable<String>	getSortedCandidateIdAttributeNames() Return a sorted list of candidate ID attribute names.
String	getSpecifiedIdAttributeName() Return the specified ID attribute name.
void	setSpecifiedIdAttributeName(String idAttributeName) Set the specified attribute name.

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.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

Field Detail

ID_ATTRIBUTE_NAME_TRANSFORMER

static final org.eclipse.jpt.common.utility.transformer.Transformer<MapsIdDerivedIdentityStrategy2_0,String> ID_ATTRIBUTE_NAME_TRANSFORMER

SPECIFIED_ID_ATTRIBUTE_NAME_PROPERTY

static final String SPECIFIED_ID_ATTRIBUTE_NAME_PROPERTY

String associated with changes to the specified ID attribute name property.

See Also:

Constant Field Values

DEFAULT_ID_ATTRIBUTE_NAME_PROPERTY

static final String DEFAULT_ID_ATTRIBUTE_NAME_PROPERTY

String associated with changes to the default ID attribute name property.

See Also:

Constant Field Values

Method Detail

getIdAttributeName

String getIdAttributeName()

Return the specified ID attribute name or, in its absence, the default ID 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).

getSpecifiedIdAttributeName

String getSpecifiedIdAttributeName()

Return the specified ID attribute name. Return null if no name is specified.

setSpecifiedIdAttributeName

void setSpecifiedIdAttributeName(String idAttributeName)

Set the specified attribute name.

defaultIdAttributeNameIsPossible

boolean defaultIdAttributeNameIsPossible()

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

getDefaultIdAttributeName

String getDefaultIdAttributeName()

Return the default ID attribute name.

getSortedCandidateIdAttributeNames

Iterable<String> getSortedCandidateIdAttributeNames()

Return a sorted list of candidate ID attribute names.

getDerivedIdAttributeMapping

AttributeMapping getDerivedIdAttributeMapping()

Return attribute mapping referenced by the ID 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.