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

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable, IResourcePart, JpaContextNode, JpaNode, Model, ReadOnlyJoinTable, ReadOnlyReferenceTable, ReadOnlyTable, ReferenceTable, Table

All Known Subinterfaces:

JavaJoinTable, OrmJoinTable

public interface JoinTable
extends ReferenceTable, ReadOnlyJoinTable

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

Version:

2.3

Nested Class Summary

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

Table.Owner

Field Summary

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

DEFAULT_INVERSE_JOIN_COLUMN, SPECIFIED_INVERSE_JOIN_COLUMNS_LIST

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

DEFAULT_JOIN_COLUMN_PROPERTY, SPECIFIED_JOIN_COLUMNS_LIST

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

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

Method Summary

JoinColumn	addSpecifiedInverseJoinColumn() Add a specified inverse join column to the join table.
JoinColumn	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	convertDefaultToSpecifiedInverseJoinColumn() Convert the join table's default inverse join column to a specified inverse join column.
JoinColumn	getDefaultInverseJoinColumn() Return the default inverse join column or null.
JoinTableRelationshipStrategy	getParent() Return the JPA node's parent.
JoinColumn	getSpecifiedInverseJoinColumn(int index) Return the specified inverse join column at the specified index.
void	initializeFrom(ReadOnlyJoinTable oldJoinTable)
void	initializeFromVirtual(ReadOnlyJoinTable virtualJoinTable)
java.util.ListIterator<? extends JoinColumn>	inverseJoinColumns() Return the join table's inverse join columns, whether specified or default.
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(JoinColumn joinColumn) Remove the specified inverse join column from the join table.
java.util.ListIterator<? extends JoinColumn>	specifiedInverseJoinColumns() Return the specified inverse join columns.

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

addSpecifiedJoinColumn, addSpecifiedJoinColumn, convertDefaultToSpecifiedJoinColumn, getDefaultJoinColumn, getSpecifiedJoinColumn, joinColumns, moveSpecifiedJoinColumn, removeSpecifiedJoinColumn, removeSpecifiedJoinColumn, specifiedJoinColumns

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

addUniqueConstraint, addUniqueConstraint, catalogIsResolved, getUniqueConstraint, isResolved, isSpecifiedInResource, moveUniqueConstraint, removeUniqueConstraint, removeUniqueConstraint, schemaIsResolved, setSpecifiedCatalog, setSpecifiedName, setSpecifiedSchema, uniqueConstraints, validatesAgainstDatabase

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

getRelationshipMapping, hasSpecifiedInverseJoinColumns, inverseJoinColumnsSize, specifiedInverseJoinColumnsSize

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

getPersistentAttribute, hasSpecifiedJoinColumns, joinColumnsSize, specifiedJoinColumnsSize

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

getCatalog, getDbCatalog, getDbSchema, getDbSchemaContainer, getDbTable, getDefaultCatalog, getDefaultName, getDefaultSchema, getName, getSchema, getSpecifiedCatalog, getSpecifiedName, getSpecifiedSchema, uniqueConstraintsSize

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

Method Detail

getParent

JoinTableRelationshipStrategy getParent()

Description copied from interface: JpaNode

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

Specified by:

getParent in interface JpaNode

Specified by:

getParent in interface ReadOnlyJoinTable

initializeFrom

void initializeFrom(ReadOnlyJoinTable oldJoinTable)

initializeFromVirtual

void initializeFromVirtual(ReadOnlyJoinTable virtualJoinTable)

convertDefaultToSpecifiedInverseJoinColumn

void convertDefaultToSpecifiedInverseJoinColumn()

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

inverseJoinColumns

java.util.ListIterator<? extends JoinColumn> inverseJoinColumns()

Description copied from interface: ReadOnlyJoinTable

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

Specified by:

inverseJoinColumns in interface ReadOnlyJoinTable

specifiedInverseJoinColumns

java.util.ListIterator<? extends JoinColumn> specifiedInverseJoinColumns()

Description copied from interface: ReadOnlyJoinTable

Return the specified inverse join columns.

Specified by:

specifiedInverseJoinColumns in interface ReadOnlyJoinTable

getSpecifiedInverseJoinColumn

JoinColumn getSpecifiedInverseJoinColumn(int index)

Description copied from interface: ReadOnlyJoinTable

Return the specified inverse join column at the specified index.

Specified by:

getSpecifiedInverseJoinColumn in interface ReadOnlyJoinTable

addSpecifiedInverseJoinColumn

JoinColumn addSpecifiedInverseJoinColumn()

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

addSpecifiedInverseJoinColumn

JoinColumn 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(JoinColumn 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

JoinColumn getDefaultInverseJoinColumn()

Description copied from interface: ReadOnlyJoinTable

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 ReadOnlyJoinTable