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

All Superinterfaces:

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

All Known Subinterfaces:

JavaPrimaryKeyJoinColumnRelationshipStrategy, OrmPrimaryKeyJoinColumnRelationshipStrategy

public interface PrimaryKeyJoinColumnRelationshipStrategy
extends RelationshipStrategy

Primary key 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

Version:

2.2

See Also:

RelationshipMapping, PrimaryKeyJoinColumnRelationship

Field Summary

static java.lang.String

PRIMARY_KEY_JOIN_COLUMNS_LIST Change notification identifier for "primaryKeyJoinColumns" list

Method Summary

PrimaryKeyJoinColumn	addPrimaryKeyJoinColumn() Add a primary key join column.
PrimaryKeyJoinColumn	addPrimaryKeyJoinColumn(int index) Add a primary key join column.
PrimaryKeyJoinColumn	getPrimaryKeyJoinColumn(int index) Return the primary key join column at the specified index.
boolean	hasPrimaryKeyJoinColumns() Return whether the relationship has any primary key join columns.
void	movePrimaryKeyJoinColumn(int targetIndex, int sourceIndex) Remove the specified primary key join column.
java.util.ListIterator<? extends PrimaryKeyJoinColumn>	primaryKeyJoinColumns() Return the strategy's primary key join columns.
int	primaryKeyJoinColumnsSize() Return the number of primary key join columns.
void	removePrimaryKeyJoinColumn(int index) Remove the specified primary key join column.
void	removePrimaryKeyJoinColumn(PrimaryKeyJoinColumn primaryKeyJoinColumn) Remove the specified primary key join column.

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

getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, getResourceType, synchronizeWithResourceModel, update

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

getJpaProject, getParent, stateChanged

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

getResource

Field Detail

PRIMARY_KEY_JOIN_COLUMNS_LIST

static final java.lang.String PRIMARY_KEY_JOIN_COLUMNS_LIST

Change notification identifier for "primaryKeyJoinColumns" list

See Also:

Constant Field Values

Method Detail

primaryKeyJoinColumns

java.util.ListIterator<? extends PrimaryKeyJoinColumn> primaryKeyJoinColumns()

Return the strategy's primary key join columns.

primaryKeyJoinColumnsSize

int primaryKeyJoinColumnsSize()

Return the number of primary key join columns.

hasPrimaryKeyJoinColumns

boolean hasPrimaryKeyJoinColumns()

Return whether the relationship has any primary key join columns. (Equivalent to primaryKeyJoinColumnsSize() == 0.)

getPrimaryKeyJoinColumn

PrimaryKeyJoinColumn getPrimaryKeyJoinColumn(int index)

Return the primary key join column at the specified index.

addPrimaryKeyJoinColumn

PrimaryKeyJoinColumn addPrimaryKeyJoinColumn()

Add a primary key join column.

addPrimaryKeyJoinColumn

PrimaryKeyJoinColumn addPrimaryKeyJoinColumn(int index)

Add a primary key join column.

removePrimaryKeyJoinColumn

void removePrimaryKeyJoinColumn(int index)

Remove the specified primary key join column.

removePrimaryKeyJoinColumn

void removePrimaryKeyJoinColumn(PrimaryKeyJoinColumn primaryKeyJoinColumn)

Remove the specified primary key join column.

movePrimaryKeyJoinColumn

void movePrimaryKeyJoinColumn(int targetIndex,
                              int sourceIndex)

Remove the specified primary key join column.