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

All Superinterfaces:

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

All Known Subinterfaces:

JavaSpecifiedPrimaryKeyJoinColumnRelationshipStrategy, OrmSpecifiedPrimaryKeyJoinColumnRelationshipStrategy

public interface SpecifiedPrimaryKeyJoinColumnRelationshipStrategy
extends SpecifiedRelationshipStrategy

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

See Also:

RelationshipMapping, PrimaryKeyJoinColumnRelationship

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

PRIMARY_KEY_JOIN_COLUMNS_LIST Change notification identifier for "primaryKeyJoinColumns" list

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

TRANSFORMER

Method Summary

SpecifiedPrimaryKeyJoinColumn	addPrimaryKeyJoinColumn() Add a primary key join column.
SpecifiedPrimaryKeyJoinColumn	addPrimaryKeyJoinColumn(int index) Add a primary key join column.
SpecifiedPrimaryKeyJoinColumn	getPrimaryKeyJoinColumn(int index) Return the primary key join column at the specified index.
org.eclipse.jpt.common.utility.iterable.ListIterable<? extends SpecifiedPrimaryKeyJoinColumn>	getPrimaryKeyJoinColumns() Return the strategy's primary key join columns.
int	getPrimaryKeyJoinColumnsSize() Return the number of primary key join columns.
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.
void	removePrimaryKeyJoinColumn(int index) Remove the specified primary key join column.
void	removePrimaryKeyJoinColumn(SpecifiedPrimaryKeyJoinColumn primaryKeyJoinColumn) Remove the specified primary key join column.

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

Field Detail

PRIMARY_KEY_JOIN_COLUMNS_LIST

static final String PRIMARY_KEY_JOIN_COLUMNS_LIST

Change notification identifier for "primaryKeyJoinColumns" list

See Also:

Constant Field Values

Method Detail

getPrimaryKeyJoinColumns

org.eclipse.jpt.common.utility.iterable.ListIterable<? extends SpecifiedPrimaryKeyJoinColumn> getPrimaryKeyJoinColumns()

Return the strategy's primary key join columns.

getPrimaryKeyJoinColumnsSize

int getPrimaryKeyJoinColumnsSize()

Return the number of primary key join columns.

hasPrimaryKeyJoinColumns

boolean hasPrimaryKeyJoinColumns()

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

getPrimaryKeyJoinColumn

SpecifiedPrimaryKeyJoinColumn getPrimaryKeyJoinColumn(int index)

Return the primary key join column at the specified index.

addPrimaryKeyJoinColumn

SpecifiedPrimaryKeyJoinColumn addPrimaryKeyJoinColumn()

Add a primary key join column.

addPrimaryKeyJoinColumn

SpecifiedPrimaryKeyJoinColumn addPrimaryKeyJoinColumn(int index)

Add a primary key join column.

removePrimaryKeyJoinColumn

void removePrimaryKeyJoinColumn(int index)

Remove the specified primary key join column.

removePrimaryKeyJoinColumn

void removePrimaryKeyJoinColumn(SpecifiedPrimaryKeyJoinColumn primaryKeyJoinColumn)

Remove the specified primary key join column.

movePrimaryKeyJoinColumn

void movePrimaryKeyJoinColumn(int targetIndex,
                              int sourceIndex)

Remove the specified primary key join column.