org.eclipse.jpt.core.context
Interface ReferenceTable

All Superinterfaces:

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

All Known Subinterfaces:

CollectionTable2_0, JavaCollectionTable2_0, JavaJoinTable, JavaReferenceTable, JoinTable, OrmCollectionTable2_0, OrmJoinTable, OrmReferenceTable

public interface ReferenceTable
extends Table

Common interface for JoinTable and CollectionTable 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.3

Version:

2.3

Field Summary

static java.lang.String	DEFAULT_JOIN_COLUMN
static java.lang.String	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	addSpecifiedJoinColumn(int index) Add a specified join column to the join table.
void	clearSpecifiedJoinColumns() Remove all the join table's join columns.
void	convertDefaultToSpecifiedJoinColumn() Convert the join table's default join column to a specified join column.
JoinColumn	getDefaultJoinColumn() Return the default join column or null.
PersistentAttribute	getPersistentAttribute()
boolean	hasSpecifiedJoinColumns() Return whether the join table has specified join columns.
<T extends JoinColumn> java.util.ListIterator<T>	joinColumns() Return the join table's join columns, whether specified or default.
int	joinColumnsSize() Return the number of join columns, whether specified or default.
void	moveSpecifiedJoinColumn(int targetIndex, int sourceIndex) Move a join column from the specified source index to the specified target index.
void	removeSpecifiedJoinColumn(int index) Remove the join column at the specified index from the join table.
void	removeSpecifiedJoinColumn(JoinColumn joinColumn) Remove the specified join column from the join table.
<T extends JoinColumn> java.util.ListIterator<T>	specifiedJoinColumns() Return the specified join columns.
int	specifiedJoinColumnsSize() Return the number of specified join columns.

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

SPECIFIED_JOIN_COLUMNS_LIST

static final java.lang.String SPECIFIED_JOIN_COLUMNS_LIST

See Also:

Constant Field Values

DEFAULT_JOIN_COLUMN

static final java.lang.String DEFAULT_JOIN_COLUMN

See Also:

Constant Field Values

Method Detail

getPersistentAttribute

PersistentAttribute getPersistentAttribute()

joinColumns

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

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

joinColumnsSize

int joinColumnsSize()

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

convertDefaultToSpecifiedJoinColumn

void convertDefaultToSpecifiedJoinColumn()

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

specifiedJoinColumns

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

Return the specified join columns.

specifiedJoinColumnsSize

int specifiedJoinColumnsSize()

Return the number of specified join columns.

getDefaultJoinColumn

JoinColumn getDefaultJoinColumn()

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

addSpecifiedJoinColumn

JoinColumn addSpecifiedJoinColumn(int index)

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

removeSpecifiedJoinColumn

void removeSpecifiedJoinColumn(int index)

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

removeSpecifiedJoinColumn

void removeSpecifiedJoinColumn(JoinColumn joinColumn)

Remove the specified join column from the join table.

moveSpecifiedJoinColumn

void moveSpecifiedJoinColumn(int targetIndex,
                             int sourceIndex)

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

hasSpecifiedJoinColumns

boolean hasSpecifiedJoinColumns()

Return whether the join table has specified join columns.

clearSpecifiedJoinColumns

void clearSpecifiedJoinColumns()

Remove all the join table's join columns.