org.eclipse.jpt.core.context
Interface JoinTable

All Superinterfaces:

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

All Known Subinterfaces:

JavaJoinTable, OrmJoinTable

public interface JoinTable
extends ReferenceTable

Used by ManyToMany and OneToMany 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

Field Summary

static java.lang.String	DEFAULT_INVERSE_JOIN_COLUMN
static java.lang.String	SPECIFIED_INVERSE_JOIN_COLUMNS_LIST

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

DEFAULT_JOIN_COLUMN, SPECIFIED_JOIN_COLUMNS_LIST

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

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(int index) Add a specified 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.
JoinTableJoiningStrategy	getParent() Return the JPA node's parent.
RelationshipMapping	getRelationshipMapping()
boolean	hasSpecifiedInverseJoinColumns() Return whether the join table has specified inverse join columns.
<T extends JoinColumn> java.util.ListIterator<T>	inverseJoinColumns() Return the join table's inverse join columns, whether specified or default.
int	inverseJoinColumnsSize() Return the number of 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.
<T extends JoinColumn> java.util.ListIterator<T>	specifiedInverseJoinColumns() Return the specified inverse join columns.
int	specifiedInverseJoinColumnsSize() Return the number of specified inverse join columns.

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

addSpecifiedJoinColumn, clearSpecifiedJoinColumns, convertDefaultToSpecifiedJoinColumn, getDefaultJoinColumn, getPersistentAttribute, hasSpecifiedJoinColumns, joinColumns, joinColumnsSize, moveSpecifiedJoinColumn, removeSpecifiedJoinColumn, removeSpecifiedJoinColumn, specifiedJoinColumns, specifiedJoinColumnsSize

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

addUniqueConstraint, getCatalog, getDbCatalog, getDbSchema, getDbSchemaContainer, getDbTable, getDefaultCatalog, getDefaultName, getDefaultSchema, getName, getSchema, getSpecifiedCatalog, getSpecifiedName, getSpecifiedSchema, hasResolvedCatalog, hasResolvedSchema, isResolved, isResourceSpecified, moveUniqueConstraint, removeUniqueConstraint, removeUniqueConstraint, setSpecifiedCatalog, setSpecifiedName, setSpecifiedSchema, uniqueConstraints, uniqueConstraintsSize

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

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

SPECIFIED_INVERSE_JOIN_COLUMNS_LIST

static final java.lang.String SPECIFIED_INVERSE_JOIN_COLUMNS_LIST

See Also:

Constant Field Values

DEFAULT_INVERSE_JOIN_COLUMN

static final java.lang.String DEFAULT_INVERSE_JOIN_COLUMN

See Also:

Constant Field Values

Method Detail

getRelationshipMapping

RelationshipMapping getRelationshipMapping()

getParent

JoinTableJoiningStrategy 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

inverseJoinColumns

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

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

inverseJoinColumnsSize

int inverseJoinColumnsSize()

Return the number of inverse join columns, whether specified or default.

convertDefaultToSpecifiedInverseJoinColumn

void convertDefaultToSpecifiedInverseJoinColumn()

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

specifiedInverseJoinColumns

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

Return the specified inverse join columns.

specifiedInverseJoinColumnsSize

int specifiedInverseJoinColumnsSize()

Return the number of specified inverse join columns.

getDefaultInverseJoinColumn

JoinColumn getDefaultInverseJoinColumn()

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

addSpecifiedInverseJoinColumn

JoinColumn addSpecifiedInverseJoinColumn(int index)

Add a specified 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.

hasSpecifiedInverseJoinColumns

boolean hasSpecifiedInverseJoinColumns()

Return whether the join table has specified inverse join columns.

clearSpecifiedInverseJoinColumns

void clearSpecifiedInverseJoinColumns()

Remove all the join table's inverse join columns.