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

All Superinterfaces:

IAdaptable, JpaContextModel, JpaModel, JptResourceTypeReference, Model, RelationshipStrategy

All Known Subinterfaces:

JavaSpecifiedJoinColumnRelationshipStrategy, JavaSpecifiedJoinTableRelationshipStrategy, JavaSpecifiedPrimaryKeyJoinColumnRelationshipStrategy, OrmSpecifiedJoinColumnRelationshipStrategy, OrmSpecifiedJoinTableRelationshipStrategy, OrmSpecifiedPrimaryKeyJoinColumnRelationshipStrategy, SpecifiedJoinColumnRelationshipStrategy, SpecifiedJoinTableRelationshipStrategy, SpecifiedMappedByRelationshipStrategy, SpecifiedMappingRelationshipStrategy2_0, SpecifiedPrimaryKeyJoinColumnRelationshipStrategy

public interface SpecifiedRelationshipStrategy
extends RelationshipStrategy

Strategy describing how two entities are joined, either for a RelationshipMapping or an SpecifiedAssociationOverride:

• join column
• join table
• "mapped by"
• primary key join column

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

See Also:

RelationshipMapping, SpecifiedAssociationOverride, SpecifiedRelationship

Nested Class Summary

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.common.core.JptResourceTypeReference

TRANSFORMER

Method Summary

void	addStrategy() Add this strategy to the relationship.
String	getColumnTableNotValidDescription() Return a message description used when the column's table is not valid in this context.
SpecifiedRelationship	getRelationship() Return the strategy's relationship.
boolean	isOverridable() Return whether the relationship's mapping can be overridden with an association override.
void	removeStrategy() Remove this strategy from the relationship.
Table	resolveDbTable(String tableName) Return the database table for the specified table name.
boolean	tableNameIsInvalid(String tableName) Return whether the specified table cannot be explicitly specified in the column's table element.

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

getTableName

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

getRelationship

SpecifiedRelationship getRelationship()

Description copied from interface: RelationshipStrategy

Return the strategy's relationship.

Specified by:

getRelationship in interface RelationshipStrategy

addStrategy

void addStrategy()

Add this strategy to the relationship.

removeStrategy

void removeStrategy()

Remove this strategy from the relationship.

isOverridable

boolean isOverridable()

Return whether the relationship's mapping can be overridden with an association override.

resolveDbTable

Table resolveDbTable(String tableName)

Return the database table for the specified table name.

tableNameIsInvalid

boolean tableNameIsInvalid(String tableName)

Return whether the specified table cannot be explicitly specified in the column's table element.

getColumnTableNotValidDescription

String getColumnTableNotValidDescription()

Return a message description used when the column's table is not valid in this context. This will be passed in as a parameter to a validation message. Here is an example where the description is what is returned by the implementation:

location: Table "table name" for map key column "column name"

description: does not match join table