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

All Superinterfaces:

IAdaptable, JpaContextNode, JpaNode, JptResourceTypeReference, Model, ReadOnlyJoinColumnRelationshipStrategy, ReadOnlyRelationshipStrategy, RelationshipStrategy

All Known Subinterfaces:

JavaJoinColumnRelationshipStrategy, OrmJoinColumnRelationshipStrategy

public interface JoinColumnRelationshipStrategy
extends ReadOnlyJoinColumnRelationshipStrategy, 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.

Since:

2.2

See Also:

RelationshipMapping, AssociationOverride, JoinColumnRelationship

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

JptResourceTypeReference.ResourceTypeTransformer

Field Summary

Fields inherited from interface org.eclipse.jpt.jpa.core.context.ReadOnlyJoinColumnRelationshipStrategy

DEFAULT_JOIN_COLUMN_PROPERTY, SPECIFIED_JOIN_COLUMNS_LIST

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

RESOURCE_TYPE_TRANSFORMER

Method Summary

JoinColumn	addSpecifiedJoinColumn() Add a specified join column to the relationship.
JoinColumn	addSpecifiedJoinColumn(int index) Add a specified join column to the relationship.
void	clearSpecifiedJoinColumns() Remove all the specified join columns.
void	convertDefaultJoinColumnsToSpecified() Add specified join columns for each default join column with the same name and referenced column name.
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.
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.
void	initializeFrom(ReadOnlyJoinColumnRelationshipStrategy oldStrategy)
void	initializeFromVirtual(ReadOnlyJoinColumnRelationshipStrategy oldStrategy)
void	moveSpecifiedJoinColumn(int targetIndex, int sourceIndex) Move the specified join column from the source index to the target index.
void	removeSpecifiedJoinColumn(int index) Remove the specified join column.
void	removeSpecifiedJoinColumn(JoinColumn joinColumn) Remove the specified join column.

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

getJoinColumnsSize, getRelationshipSource, getRelationshipTarget, getSpecifiedJoinColumnsSize, hasSpecifiedJoinColumns, isTargetForeignKey

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

addStrategy, getColumnTableNotValidDescription, getRelationship, isOverridable, removeStrategy, resolveDbTable, tableNameIsInvalid

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

getTableName

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

getCompletionProposals, getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getParent, getPersistenceUnit, getValidationTextRange, synchronizeWithResourceModel, update, validate

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

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

initializeFrom

void initializeFrom(ReadOnlyJoinColumnRelationshipStrategy oldStrategy)

initializeFromVirtual

void initializeFromVirtual(ReadOnlyJoinColumnRelationshipStrategy oldStrategy)

getJoinColumns

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

Description copied from interface: ReadOnlyJoinColumnRelationshipStrategy

Return the join columns whether specified or default.

Specified by:

getJoinColumns in interface ReadOnlyJoinColumnRelationshipStrategy

getSpecifiedJoinColumns

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

Description copied from interface: ReadOnlyJoinColumnRelationshipStrategy

Return the specified join columns.

Specified by:

getSpecifiedJoinColumns in interface ReadOnlyJoinColumnRelationshipStrategy

getSpecifiedJoinColumn

JoinColumn getSpecifiedJoinColumn(int index)

Description copied from interface: ReadOnlyJoinColumnRelationshipStrategy

Return the specified join column at the specified index.

Specified by:

getSpecifiedJoinColumn in interface ReadOnlyJoinColumnRelationshipStrategy

addSpecifiedJoinColumn

JoinColumn addSpecifiedJoinColumn()

Add a specified join column to the relationship.

addSpecifiedJoinColumn

JoinColumn addSpecifiedJoinColumn(int index)

Add a specified join column to the relationship.

removeSpecifiedJoinColumn

void removeSpecifiedJoinColumn(int index)

Remove the specified join column.

removeSpecifiedJoinColumn

void removeSpecifiedJoinColumn(JoinColumn joinColumn)

Remove the specified join column.

moveSpecifiedJoinColumn

void moveSpecifiedJoinColumn(int targetIndex,
                             int sourceIndex)

Move the specified join column from the source index to the target index.

getDefaultJoinColumn

JoinColumn getDefaultJoinColumn()

Description copied from interface: ReadOnlyJoinColumnRelationshipStrategy

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.

Specified by:

getDefaultJoinColumn in interface ReadOnlyJoinColumnRelationshipStrategy

convertDefaultJoinColumnsToSpecified

void convertDefaultJoinColumnsToSpecified()

Add specified join columns for each default join column with the same name and referenced column name. As a side-effect in the update, the default join columns will be recalculated

clearSpecifiedJoinColumns

void clearSpecifiedJoinColumns()

Remove all the specified join columns. As a side-effect in the update, the default join columns will be recalculated