org.eclipse.jpt.jpa.core.context.orm
Interface OrmReferenceTable

All Superinterfaces:

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

All Known Subinterfaces:

OrmCollectionTable2_0, OrmJoinTable

public interface OrmReferenceTable
extends ReferenceTable, OrmTable

orm.xml join table or 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

OrmJoinColumn	addSpecifiedJoinColumn() Add and return a specified join column to the reference table.
OrmJoinColumn	addSpecifiedJoinColumn(int index) Add and return a specified join column to the reference table.
OrmJoinColumn	getDefaultJoinColumn() Return the default join column or null.
OrmJoinColumn	getSpecifiedJoinColumn(int index) Return the specified join column at the specified index.
java.util.ListIterator<OrmJoinColumn>	joinColumns() Return the reference table's join columns, whether specified or default.
java.util.ListIterator<OrmJoinColumn>	specifiedJoinColumns() Return the reference table's specified join columns.

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

convertDefaultToSpecifiedJoinColumn, moveSpecifiedJoinColumn, removeSpecifiedJoinColumn, removeSpecifiedJoinColumn

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.orm.OrmTable

addUniqueConstraint, addUniqueConstraint, getCatalogTextRange, getNameTextRange, getSchemaTextRange, getUniqueConstraint, uniqueConstraints

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

catalogIsResolved, isResolved, isSpecifiedInResource, moveUniqueConstraint, removeUniqueConstraint, removeUniqueConstraint, schemaIsResolved, setSpecifiedCatalog, setSpecifiedName, setSpecifiedSchema, validatesAgainstDatabase

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

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

getValidationTextRange, validate

Method Detail

joinColumns

java.util.ListIterator<OrmJoinColumn> joinColumns()

Description copied from interface: ReadOnlyReferenceTable

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

Specified by:

joinColumns in interface ReadOnlyReferenceTable

Specified by:

joinColumns in interface ReferenceTable

specifiedJoinColumns

java.util.ListIterator<OrmJoinColumn> specifiedJoinColumns()

Description copied from interface: ReadOnlyReferenceTable

Return the reference table's specified join columns.

Specified by:

specifiedJoinColumns in interface ReadOnlyReferenceTable

Specified by:

specifiedJoinColumns in interface ReferenceTable

getSpecifiedJoinColumn

OrmJoinColumn getSpecifiedJoinColumn(int index)

Description copied from interface: ReadOnlyReferenceTable

Return the specified join column at the specified index.

Specified by:

getSpecifiedJoinColumn in interface ReadOnlyReferenceTable

Specified by:

getSpecifiedJoinColumn in interface ReferenceTable

addSpecifiedJoinColumn

OrmJoinColumn addSpecifiedJoinColumn()

Description copied from interface: ReferenceTable

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

Specified by:

addSpecifiedJoinColumn in interface ReferenceTable

addSpecifiedJoinColumn

OrmJoinColumn addSpecifiedJoinColumn(int index)

Description copied from interface: ReferenceTable

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

Specified by:

addSpecifiedJoinColumn in interface ReferenceTable

getDefaultJoinColumn

OrmJoinColumn 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

Specified by:

getDefaultJoinColumn in interface ReferenceTable