org.eclipse.jpt.core.context
Interface JoiningStrategy

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable, IResourcePart, JpaContextNode, JpaNode, Model

All Known Subinterfaces:

JavaJoinColumnInAssociationOverrideJoiningStrategy, JavaJoinColumnJoiningStrategy, JavaJoiningStrategy, JavaJoinTableInAssociationOverrideJoiningStrategy2_0, JavaJoinTableJoiningStrategy, JavaMappedByJoiningStrategy, JavaPrimaryKeyJoinColumnJoiningStrategy, JoinColumnJoiningStrategy, JoinTableJoiningStrategy, MappedByJoiningStrategy, OrmJoinColumnInAssociationOverrideJoiningStrategy, OrmJoinColumnJoiningStrategy, OrmJoiningStrategy, OrmJoinTableInAssociationOverrideJoiningStrategy2_0, OrmJoinTableJoiningStrategy, OrmMappedByJoiningStrategy, OrmPrimaryKeyJoinColumnJoiningStrategy, PrimaryKeyJoinColumnJoiningStrategy

public interface JoiningStrategy
extends JpaContextNode

Represents how the information in two entities are joined together via a RelationshipMapping

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

Version:

2.3

See Also:

RelationshipMapping}, RelationshipReference}

Method Summary

void	addStrategy() Add this strategy to the relationship reference
java.lang.String	getColumnTableNotValidDescription() Return a message description used when the column's table is not valid in this context.
Table	getDbTable(java.lang.String tableName) Return the database table for the specified table name
RelationshipReference	getRelationshipReference() Return the relationship reference that owns this strategy
java.lang.String	getTableName() Return the table name associated with columns on this joining strategy.
boolean	isOverridableAssociation() Return whether the mapping can be overridden with an association override
void	removeStrategy() Remove this strategy from the relationship reference
boolean	tableNameIsInvalid(java.lang.String tableName) return whether the given table cannot be explicitly specified in the column's 'table' element

Methods inherited from interface org.eclipse.jpt.core.context.JpaContextNode

getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, getResourceType, postUpdate

Methods inherited from interface org.eclipse.jpt.core.JpaNode

getJpaProject, getParent

Methods inherited from interface org.eclipse.jpt.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.core.IResourcePart

getResource

Method Detail

getRelationshipReference

RelationshipReference getRelationshipReference()

Return the relationship reference that owns this strategy

addStrategy

void addStrategy()

Add this strategy to the relationship reference

removeStrategy

void removeStrategy()

Remove this strategy from the relationship reference

isOverridableAssociation

boolean isOverridableAssociation()

Return whether the mapping can be overridden with an association override

getTableName

java.lang.String getTableName()

Return the table name associated with columns on this joining strategy. The join table name, for instance, or in the case of a bi-directional relationship, the table of the owning relationship.

getDbTable

Table getDbTable(java.lang.String tableName)

Return the database table for the specified table name

tableNameIsInvalid

boolean tableNameIsInvalid(java.lang.String tableName)

return whether the given table cannot be explicitly specified in the column's 'table' element

getColumnTableNotValidDescription

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