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

All Superinterfaces:

IAdaptable, JoinColumnRelationshipStrategy, JpaContextModel, JpaModel, JptResourceTypeReference, Model, RelationshipStrategy, SpecifiedRelationshipStrategy

All Known Subinterfaces:

JavaSpecifiedJoinColumnRelationshipStrategy, OrmSpecifiedJoinColumnRelationshipStrategy

public interface SpecifiedJoinColumnRelationshipStrategy
extends JoinColumnRelationshipStrategy, SpecifiedRelationshipStrategy

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

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

DEFAULT_JOIN_COLUMN_PROPERTY, SPECIFIED_JOIN_COLUMNS_LIST

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

TRANSFORMER

Method Summary

SpecifiedJoinColumn	addSpecifiedJoinColumn() Add a specified join column to the relationship.
SpecifiedJoinColumn	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.
SpecifiedJoinColumn	getDefaultJoinColumn() Return the default join column.
org.eclipse.jpt.common.utility.iterable.ListIterable<? extends SpecifiedJoinColumn>	getJoinColumns() Return the join columns whether specified or default.
SpecifiedJoinColumn	getSpecifiedJoinColumn(int index) Return the specified join column at the specified index.
org.eclipse.jpt.common.utility.iterable.ListIterable<? extends SpecifiedJoinColumn>	getSpecifiedJoinColumns() Return the specified join columns.
void	initializeFrom(JoinColumnRelationshipStrategy oldStrategy)
void	initializeFromVirtual(JoinColumnRelationshipStrategy 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(SpecifiedJoinColumn joinColumn) Remove the specified join column.

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

getJoinColumnsSize, getRelationshipSource, getRelationshipTarget, getSpecifiedJoinColumnsSize, hasSpecifiedJoinColumns, isTargetForeignKey

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

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

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

initializeFrom

void initializeFrom(JoinColumnRelationshipStrategy oldStrategy)

initializeFromVirtual

void initializeFromVirtual(JoinColumnRelationshipStrategy oldStrategy)

getJoinColumns

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

Description copied from interface: JoinColumnRelationshipStrategy

Return the join columns whether specified or default.

Specified by:

getJoinColumns in interface JoinColumnRelationshipStrategy

getSpecifiedJoinColumns

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

Description copied from interface: JoinColumnRelationshipStrategy

Return the specified join columns.

Specified by:

getSpecifiedJoinColumns in interface JoinColumnRelationshipStrategy

getSpecifiedJoinColumn

SpecifiedJoinColumn getSpecifiedJoinColumn(int index)

Description copied from interface: JoinColumnRelationshipStrategy

Return the specified join column at the specified index.

Specified by:

getSpecifiedJoinColumn in interface JoinColumnRelationshipStrategy

addSpecifiedJoinColumn

SpecifiedJoinColumn addSpecifiedJoinColumn()

Add a specified join column to the relationship.

addSpecifiedJoinColumn

SpecifiedJoinColumn addSpecifiedJoinColumn(int index)

Add a specified join column to the relationship.

removeSpecifiedJoinColumn

void removeSpecifiedJoinColumn(int index)

Remove the specified join column.

removeSpecifiedJoinColumn

void removeSpecifiedJoinColumn(SpecifiedJoinColumn 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

SpecifiedJoinColumn getDefaultJoinColumn()

Description copied from interface: JoinColumnRelationshipStrategy

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 JoinColumnRelationshipStrategy

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