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

All Superinterfaces:

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

All Known Subinterfaces:

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

public interface ReferenceTable
extends Table, ReadOnlyReferenceTable

Reference table (i.e. a table that joins with one other table, as opposed to a "join table" that joins with two other tables)

• join table
• collection table

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

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.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	addSpecifiedJoinColumn() Add and return a specified join column to the reference table.
JoinColumn	addSpecifiedJoinColumn(int index) Add and return a specified join column to the reference table.
void	convertDefaultToSpecifiedJoinColumn() Convert the reference table's default join column to a specified join column.
JoinColumn	getDefaultJoinColumn() Return the default join column or null.
JoinColumn	getSpecifiedJoinColumn(int index) Return the specified join column at the specified index.
java.util.ListIterator<? extends JoinColumn>	joinColumns() Return the reference table's join columns, whether specified or default.
void	moveSpecifiedJoinColumn(int targetIndex, int sourceIndex) Move the join column at the specified source index to the specified target index.
void	removeSpecifiedJoinColumn(int index) Remove the join column at the specified index from the reference table.
void	removeSpecifiedJoinColumn(JoinColumn joinColumn) Remove the specified join column from the reference table.
java.util.ListIterator<? extends JoinColumn>	specifiedJoinColumns() Return the reference table's specified join columns.

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

convertDefaultToSpecifiedJoinColumn

void convertDefaultToSpecifiedJoinColumn()

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

joinColumns

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

Description copied from interface: ReadOnlyReferenceTable

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

Specified by:

joinColumns in interface ReadOnlyReferenceTable

specifiedJoinColumns

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

Description copied from interface: ReadOnlyReferenceTable

Return the reference table's specified join columns.

Specified by:

specifiedJoinColumns in interface ReadOnlyReferenceTable

getSpecifiedJoinColumn

JoinColumn getSpecifiedJoinColumn(int index)

Description copied from interface: ReadOnlyReferenceTable

Return the specified join column at the specified index.

Specified by:

getSpecifiedJoinColumn in interface ReadOnlyReferenceTable

addSpecifiedJoinColumn

JoinColumn addSpecifiedJoinColumn()

Add and return a specified join column to the reference table.

addSpecifiedJoinColumn

JoinColumn addSpecifiedJoinColumn(int index)

Add and return a specified join column to the reference table.

removeSpecifiedJoinColumn

void removeSpecifiedJoinColumn(int index)

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

removeSpecifiedJoinColumn

void removeSpecifiedJoinColumn(JoinColumn joinColumn)

Remove the specified join column from the reference table.

moveSpecifiedJoinColumn

void moveSpecifiedJoinColumn(int targetIndex,
                             int sourceIndex)

Move the join column at the specified source index to the specified target index.

getDefaultJoinColumn

JoinColumn getDefaultJoinColumn()

Description copied from interface: ReadOnlyReferenceTable

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

Specified by:

getDefaultJoinColumn in interface ReadOnlyReferenceTable