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

All Superinterfaces:

IAdaptable, JpaContextModel, JpaModel, JptResourceTypeReference, Model, Table

All Known Subinterfaces:

CollectionTable2_0, JavaCollectionTable2_0, JavaSpecifiedJoinTable, JavaSpecifiedReferenceTable, JoinTable, OrmCollectionTable2_0, OrmSpecifiedJoinTable, OrmSpecifiedReferenceTable, SpecifiedJoinTable, SpecifiedReferenceTable, VirtualJoinTable, VirtualReferenceTable

public interface ReferenceTable
extends Table

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.

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

static String	DEFAULT_JOIN_COLUMN_PROPERTY
static String	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

JoinColumn	getDefaultJoinColumn() Return the default join column or null.
org.eclipse.jpt.common.utility.iterable.ListIterable<? extends JoinColumn>	getJoinColumns() Return the reference table's join columns, whether specified or default.
int	getJoinColumnsSize() Return the number of join columns, whether specified or default.
SpecifiedPersistentAttribute	getPersistentAttribute()
JoinColumn	getSpecifiedJoinColumn(int index) Return the specified join column at the specified index.
org.eclipse.jpt.common.utility.iterable.ListIterable<? extends JoinColumn>	getSpecifiedJoinColumns() Return the reference table's specified join columns.
int	getSpecifiedJoinColumnsSize() Return the number of specified join columns.
boolean	hasSpecifiedJoinColumns() Return whether the reference table has specified join columns.

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, getUniqueConstraint, getUniqueConstraints, getUniqueConstraintsSize, isResolved, schemaIsResolved, validatesAgainstDatabase

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

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

Field Detail

SPECIFIED_JOIN_COLUMNS_LIST

static final String SPECIFIED_JOIN_COLUMNS_LIST

See Also:

Constant Field Values

DEFAULT_JOIN_COLUMN_PROPERTY

static final String DEFAULT_JOIN_COLUMN_PROPERTY

See Also:

Constant Field Values

Method Detail

getPersistentAttribute

SpecifiedPersistentAttribute getPersistentAttribute()

getJoinColumns

org.eclipse.jpt.common.utility.iterable.ListIterable<? extends JoinColumn> getJoinColumns()

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

getJoinColumnsSize

int getJoinColumnsSize()

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

getSpecifiedJoinColumns

org.eclipse.jpt.common.utility.iterable.ListIterable<? extends JoinColumn> getSpecifiedJoinColumns()

Return the reference table's specified join columns.

getSpecifiedJoinColumnsSize

int getSpecifiedJoinColumnsSize()

Return the number of specified join columns.

hasSpecifiedJoinColumns

boolean hasSpecifiedJoinColumns()

Return whether the reference table has specified join columns.

getSpecifiedJoinColumn

JoinColumn getSpecifiedJoinColumn(int index)

Return the specified join column at the specified index.

getDefaultJoinColumn

JoinColumn getDefaultJoinColumn()

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