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

All Superinterfaces:

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

public interface OrmJoinTable
extends JoinTable, OrmReferenceTable

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

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.ReadOnlyJoinTable

DEFAULT_INVERSE_JOIN_COLUMN, SPECIFIED_INVERSE_JOIN_COLUMNS_LIST

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	addSpecifiedInverseJoinColumn() Add a specified inverse join column to the join table.
OrmJoinColumn	addSpecifiedInverseJoinColumn(int index) Add a specified inverse join column to the join table.
OrmJoinColumn	getDefaultInverseJoinColumn() Return the default inverse join column or null.
OrmJoinTableRelationshipStrategy	getParent() Return the JPA node's parent.
OrmJoinColumn	getSpecifiedInverseJoinColumn(int index) Return the specified inverse join column at the specified index.
java.util.ListIterator<OrmJoinColumn>	inverseJoinColumns() Return the join table's inverse join columns, whether specified or default.
java.util.ListIterator<OrmJoinColumn>	specifiedInverseJoinColumns() Return the specified inverse join columns.

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

clearSpecifiedInverseJoinColumns, convertDefaultToSpecifiedInverseJoinColumn, initializeFrom, initializeFromVirtual, moveSpecifiedInverseJoinColumn, removeSpecifiedInverseJoinColumn, removeSpecifiedInverseJoinColumn

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

getRelationshipMapping, hasSpecifiedInverseJoinColumns, inverseJoinColumnsSize, specifiedInverseJoinColumnsSize

Methods inherited from interface org.eclipse.jpt.jpa.core.context.orm.OrmReferenceTable

addSpecifiedJoinColumn, addSpecifiedJoinColumn, getDefaultJoinColumn, getSpecifiedJoinColumn, joinColumns, specifiedJoinColumns

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

getParent

OrmJoinTableRelationshipStrategy 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 JoinTable

Specified by:

getParent in interface JpaNode

Specified by:

getParent in interface ReadOnlyJoinTable

inverseJoinColumns

java.util.ListIterator<OrmJoinColumn> inverseJoinColumns()

Description copied from interface: ReadOnlyJoinTable

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

Specified by:

inverseJoinColumns in interface JoinTable

Specified by:

inverseJoinColumns in interface ReadOnlyJoinTable

specifiedInverseJoinColumns

java.util.ListIterator<OrmJoinColumn> specifiedInverseJoinColumns()

Description copied from interface: ReadOnlyJoinTable

Return the specified inverse join columns.

Specified by:

specifiedInverseJoinColumns in interface JoinTable

Specified by:

specifiedInverseJoinColumns in interface ReadOnlyJoinTable

getSpecifiedInverseJoinColumn

OrmJoinColumn getSpecifiedInverseJoinColumn(int index)

Description copied from interface: ReadOnlyJoinTable

Return the specified inverse join column at the specified index.

Specified by:

getSpecifiedInverseJoinColumn in interface JoinTable

Specified by:

getSpecifiedInverseJoinColumn in interface ReadOnlyJoinTable

addSpecifiedInverseJoinColumn

OrmJoinColumn addSpecifiedInverseJoinColumn()

Description copied from interface: JoinTable

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

Specified by:

addSpecifiedInverseJoinColumn in interface JoinTable

addSpecifiedInverseJoinColumn

OrmJoinColumn addSpecifiedInverseJoinColumn(int index)

Description copied from interface: JoinTable

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

Specified by:

addSpecifiedInverseJoinColumn in interface JoinTable

getDefaultInverseJoinColumn

OrmJoinColumn getDefaultInverseJoinColumn()

Description copied from interface: ReadOnlyJoinTable

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

Specified by:

getDefaultInverseJoinColumn in interface JoinTable

Specified by:

getDefaultInverseJoinColumn in interface ReadOnlyJoinTable