org.eclipse.jpt.core.context
Interface PrimaryKeyJoinColumnJoiningStrategy

All Superinterfaces:

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

All Known Subinterfaces:

JavaPrimaryKeyJoinColumnJoiningStrategy, OrmPrimaryKeyJoinColumnJoiningStrategy

public interface PrimaryKeyJoinColumnJoiningStrategy
extends JoiningStrategy

Joining strategy that uses primary key join columns

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}, PrimaryKeyJoinColumnEnabledRelationshipReference}

Field Summary

static java.lang.String

PRIMARY_KEY_JOIN_COLUMNS_LIST Change notification identifier for "primaryKeyJoinColumns" list

Method Summary

PrimaryKeyJoinColumn	addPrimaryKeyJoinColumn(int index) Add a specified join column to the join table return the object representing it.
boolean	hasPrimaryKeyJoinColumns() Return whether this has any primary key join columns.
void	movePrimaryKeyJoinColumn(int targetIndex, int sourceIndex) Move the specified join column from the source index to the target index.
<T extends PrimaryKeyJoinColumn> java.util.ListIterator<T>	primaryKeyJoinColumns() Return a list iterator of the primary key join columns.
int	primaryKeyJoinColumnsSize() Return the number of join columns, both specified and default.
void	removePrimaryKeyJoinColumn(int index) Remove the specified join column from the join table.
void	removePrimaryKeyJoinColumn(PrimaryKeyJoinColumn primaryKeyJoinColumn) Remove the specified join column at the index from the join table.

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

addStrategy, getColumnTableNotValidDescription, getDbTable, getRelationshipReference, getTableName, isOverridableAssociation, removeStrategy, tableNameIsInvalid

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

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

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

Return a list iterator of the primary key join columns. This will not be null.

primaryKeyJoinColumnsSize

int primaryKeyJoinColumnsSize()

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

hasPrimaryKeyJoinColumns

boolean hasPrimaryKeyJoinColumns()

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

addPrimaryKeyJoinColumn

PrimaryKeyJoinColumn addPrimaryKeyJoinColumn(int index)

Add a specified join column to the join table return the object representing it.

removePrimaryKeyJoinColumn

void removePrimaryKeyJoinColumn(int index)

Remove the specified join column from the join table.

removePrimaryKeyJoinColumn

void removePrimaryKeyJoinColumn(PrimaryKeyJoinColumn primaryKeyJoinColumn)

Remove the specified join column at the index from the join table.

movePrimaryKeyJoinColumn

void movePrimaryKeyJoinColumn(int targetIndex,
                              int sourceIndex)

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