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

All Superinterfaces:

IAdaptable, JoinTable, JpaContextModel, JpaModel, JptResourceTypeReference, Model, ReferenceTable, SpecifiedReferenceTable, SpecifiedTable, Table

All Known Subinterfaces:

JavaSpecifiedJoinTable, OrmSpecifiedJoinTable

public interface SpecifiedJoinTable
extends SpecifiedReferenceTable, JoinTable

Used by many-to-many and one-to-many mappings.

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.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.context.Table

Table.DbTableTransformer, Table.NameTransformer, Table.ParentAdapter<P extends JpaContextModel>

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.JoinTable

DEFAULT_INVERSE_JOIN_COLUMN, SPECIFIED_INVERSE_JOIN_COLUMNS_LIST

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

DEFAULT_JOIN_COLUMN_PROPERTY, SPECIFIED_JOIN_COLUMNS_LIST

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

DB_TABLE_TRANSFORMER, DEFAULT_CATALOG_PROPERTY, DEFAULT_NAME_PROPERTY, DEFAULT_SCHEMA_PROPERTY, NAME_TRANSFORMER, SPECIFIED_CATALOG_PROPERTY, SPECIFIED_NAME_PROPERTY, SPECIFIED_SCHEMA_PROPERTY, UNIQUE_CONSTRAINTS_LIST

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

TRANSFORMER

Method Summary

SpecifiedJoinColumn	addSpecifiedInverseJoinColumn() Add a specified inverse join column to the join table.
SpecifiedJoinColumn	addSpecifiedInverseJoinColumn(int index) Add a specified inverse join column to the join table.
void	clearSpecifiedInverseJoinColumns() Remove all the join table's inverse join columns.
void	convertDefaultInverseJoinColumnToSpecified() Convert the join table's default inverse join column to a specified inverse join column.
SpecifiedJoinColumn	getDefaultInverseJoinColumn() Return the default inverse join column or null.
org.eclipse.jpt.common.utility.iterable.ListIterable<? extends SpecifiedJoinColumn>	getInverseJoinColumns() Return the join table's inverse join columns, whether specified or default.
SpecifiedJoinTableRelationshipStrategy	getParent() Return the JPA node's parent.
SpecifiedJoinColumn	getSpecifiedInverseJoinColumn(int index) Return the specified inverse join column at the specified index.
org.eclipse.jpt.common.utility.iterable.ListIterable<? extends SpecifiedJoinColumn>	getSpecifiedInverseJoinColumns() Return the specified inverse join columns.
void	initializeFrom(VirtualJoinTable virtualTable)
void	moveSpecifiedInverseJoinColumn(int targetIndex, int sourceIndex) Move an inverse join column from the specified source index to the specified target index.
void	removeSpecifiedInverseJoinColumn(int index) Remove the inverse join column at the specified index from the join table.
void	removeSpecifiedInverseJoinColumn(SpecifiedJoinColumn joinColumn) Remove the specified inverse join column from the join table.

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

addSpecifiedJoinColumn, addSpecifiedJoinColumn, clearSpecifiedJoinColumns, convertDefaultJoinColumnToSpecified, getDefaultJoinColumn, getJoinColumns, getSpecifiedJoinColumn, getSpecifiedJoinColumns, moveSpecifiedJoinColumn, removeSpecifiedJoinColumn, removeSpecifiedJoinColumn

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

addUniqueConstraint, addUniqueConstraint, getUniqueConstraint, getUniqueConstraints, isSpecifiedInResource, moveUniqueConstraint, removeUniqueConstraint, removeUniqueConstraint, setSpecifiedCatalog, setSpecifiedName, setSpecifiedSchema

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

getInverseJoinColumnsSize, getRelationshipMapping, getSpecifiedInverseJoinColumnsSize, hasSpecifiedInverseJoinColumns

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

getJoinColumnsSize, getPersistentAttribute, getSpecifiedJoinColumnsSize, hasSpecifiedJoinColumns

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

catalogIsResolved, getCatalog, getCatalogValidationTextRange, getDbCatalog, getDbSchema, getDbSchemaContainer, getDbTable, getDefaultCatalog, getDefaultName, getDefaultSchema, getName, getNameValidationTextRange, getSchema, getSchemaValidationTextRange, getSpecifiedCatalog, getSpecifiedName, getSpecifiedSchema, getUniqueConstraintsSize, isResolved, schemaIsResolved, validatesAgainstDatabase

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

getCompletionProposals, getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, 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

getParent

SpecifiedJoinTableRelationshipStrategy getParent()

Description copied from interface: JpaModel

Return the JPA node's parent. The JPA project will not have a parent.

Specified by:

getParent in interface JoinTable

Specified by:

getParent in interface JpaContextModel

Specified by:

getParent in interface JpaModel

initializeFrom

void initializeFrom(VirtualJoinTable virtualTable)

See Also:

SpecifiedJoinTableRelationshipStrategy.initializeFrom(VirtualJoinTableRelationshipStrategy)

convertDefaultInverseJoinColumnToSpecified

void convertDefaultInverseJoinColumnToSpecified()

Convert the join table's default inverse join column to a specified inverse join column.

getInverseJoinColumns

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

Description copied from interface: JoinTable

Return the join table's inverse join columns, whether specified or default.

Specified by:

getInverseJoinColumns in interface JoinTable

getSpecifiedInverseJoinColumns

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

Description copied from interface: JoinTable

Return the specified inverse join columns.

Specified by:

getSpecifiedInverseJoinColumns in interface JoinTable

getSpecifiedInverseJoinColumn

SpecifiedJoinColumn getSpecifiedInverseJoinColumn(int index)

Description copied from interface: JoinTable

Return the specified inverse join column at the specified index.

Specified by:

getSpecifiedInverseJoinColumn in interface JoinTable

addSpecifiedInverseJoinColumn

SpecifiedJoinColumn addSpecifiedInverseJoinColumn()

Add a specified inverse join column to the join table. Return the newly-created join column.

addSpecifiedInverseJoinColumn

SpecifiedJoinColumn addSpecifiedInverseJoinColumn(int index)

Add a specified inverse join column to the join table. Return the newly-created join column.

removeSpecifiedInverseJoinColumn

void removeSpecifiedInverseJoinColumn(int index)

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

removeSpecifiedInverseJoinColumn

void removeSpecifiedInverseJoinColumn(SpecifiedJoinColumn joinColumn)

Remove the specified inverse join column from the join table.

moveSpecifiedInverseJoinColumn

void moveSpecifiedInverseJoinColumn(int targetIndex,
                                    int sourceIndex)

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

clearSpecifiedInverseJoinColumns

void clearSpecifiedInverseJoinColumns()

Remove all the join table's inverse join columns.

getDefaultInverseJoinColumn

SpecifiedJoinColumn getDefaultInverseJoinColumn()

Description copied from interface: JoinTable

Return the default inverse join column or null. A default inverse join column only exists if there are no specified inverse join columns.

Specified by:

getDefaultInverseJoinColumn in interface JoinTable