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

All Superinterfaces:

IAdaptable, JpaContextModel, JpaModel, JptResourceTypeReference, Model, RelationshipStrategy

All Known Subinterfaces:

JavaSpecifiedJoinColumnRelationshipStrategy, OrmSpecifiedJoinColumnRelationshipStrategy, SpecifiedJoinColumnRelationshipStrategy, VirtualJoinColumnRelationshipStrategy

public interface JoinColumnRelationshipStrategy
extends RelationshipStrategy

Join column relationship 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.

See Also:

AssociationOverride, SpecifiedJoinColumnRelationship

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

static String	DEFAULT_JOIN_COLUMN_PROPERTY Change notification identifier for "defaultJoinColumn" property
static String	SPECIFIED_JOIN_COLUMNS_LIST Change notification identifier for "specifiedJoinColumns" list

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

TRANSFORMER

Method Summary

JoinColumn	getDefaultJoinColumn() Return the default join column.
org.eclipse.jpt.common.utility.iterable.ListIterable<? extends JoinColumn>	getJoinColumns() Return the join columns whether specified or default.
int	getJoinColumnsSize() Return the number of join columns, whether specified and default.
TypeMapping	getRelationshipSource() The source of the relationship is usually the owning type mapping.
TypeMapping	getRelationshipTarget() The target of the relationship usually is the target entity.
JoinColumn	getSpecifiedJoinColumn(int index) Return the specified join column at the specified index.
org.eclipse.jpt.common.utility.iterable.ListIterable<? extends JoinColumn>	getSpecifiedJoinColumns() Return the specified join columns.
int	getSpecifiedJoinColumnsSize() Return the number of specified join columns.
boolean	hasSpecifiedJoinColumns() Return whether the strategy has any specified join columns.
boolean	isTargetForeignKey() Return whether this relationship is a target foreign key relationship.

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

getRelationship, 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

Field Detail

SPECIFIED_JOIN_COLUMNS_LIST

static final String SPECIFIED_JOIN_COLUMNS_LIST

Change notification identifier for "specifiedJoinColumns" list

See Also:

Constant Field Values

DEFAULT_JOIN_COLUMN_PROPERTY

static final String DEFAULT_JOIN_COLUMN_PROPERTY

Change notification identifier for "defaultJoinColumn" property

See Also:

Constant Field Values

Method Detail

getRelationshipSource

TypeMapping getRelationshipSource()

The source of the relationship is usually the owning type mapping. In the case of a target foreign key relationship the source and target are swapped.

See Also:

isTargetForeignKey()

getRelationshipTarget

TypeMapping getRelationshipTarget()

The target of the relationship usually is the target entity. In the case of a target foreign key relationship the source and target are swapped.

See Also:

isTargetForeignKey()

isTargetForeignKey

boolean isTargetForeignKey()

Return whether this relationship is a target foreign key relationship. A one-to-many mapping with a join column will have the foreign key in the target table.

getJoinColumns

org.eclipse.jpt.common.utility.iterable.ListIterable<? extends JoinColumn> getJoinColumns()

Return the join columns whether specified or default.

getJoinColumnsSize

int getJoinColumnsSize()

Return the number of join columns, whether specified and default.

getSpecifiedJoinColumns

org.eclipse.jpt.common.utility.iterable.ListIterable<? extends JoinColumn> getSpecifiedJoinColumns()

Return the specified join columns.

getSpecifiedJoinColumnsSize

int getSpecifiedJoinColumnsSize()

Return the number of specified join columns.

hasSpecifiedJoinColumns

boolean hasSpecifiedJoinColumns()

Return whether the strategy has any specified join columns. (Equivalent to getSpecifiedJoinColumnsSize() != 0.)

getSpecifiedJoinColumn

JoinColumn getSpecifiedJoinColumn(int index)

Return the specified join column at the specified index.

getDefaultJoinColumn

JoinColumn getDefaultJoinColumn()

Return the default join column. If there are specified join columns, there is no default join column. There are also times that there may be no default join column even if there are no specified join columns.