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

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable, IResourcePart, JoinTable, JpaContextNode, JpaNode, Model, OrmReferenceTable, 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

Field Summary

Fields inherited from interface org.eclipse.jpt.core.context.JoinTable

DEFAULT_INVERSE_JOIN_COLUMN, SPECIFIED_INVERSE_JOIN_COLUMNS_LIST

Fields inherited from interface org.eclipse.jpt.core.context.ReferenceTable

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

Fields inherited from interface org.eclipse.jpt.core.context.ReferenceTable

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

OrmJoinColumn	addSpecifiedInverseJoinColumn(int index) Add a specified join column to the join table.
OrmJoinColumn	addSpecifiedJoinColumn(int index) Add a specified join column to the join table.
OrmUniqueConstraint	addUniqueConstraint(int index)
OrmJoinColumn	getDefaultInverseJoinColumn() Return the default inverse join column or null.
OrmJoinColumn	getDefaultJoinColumn() Return the default join column or null.
void	initializeFrom(JoinTable oldJoinTable)
java.util.ListIterator<OrmJoinColumn>	inverseJoinColumns() Return the join table's inverse join columns, whether specified or default.
java.util.ListIterator<OrmJoinColumn>	joinColumns() Return the join table's join columns, whether specified or default.
java.util.ListIterator<OrmJoinColumn>	specifiedInverseJoinColumns() Return the specified inverse join columns.
java.util.ListIterator<OrmJoinColumn>	specifiedJoinColumns() Return the specified join columns.
java.util.ListIterator<OrmUniqueConstraint>	uniqueConstraints()
void	update()

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

clearSpecifiedInverseJoinColumns, convertDefaultToSpecifiedInverseJoinColumn, getParent, getRelationshipMapping, hasSpecifiedInverseJoinColumns, inverseJoinColumnsSize, moveSpecifiedInverseJoinColumn, removeSpecifiedInverseJoinColumn, removeSpecifiedInverseJoinColumn, specifiedInverseJoinColumnsSize

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

clearSpecifiedJoinColumns, convertDefaultToSpecifiedJoinColumn, getPersistentAttribute, hasSpecifiedJoinColumns, joinColumnsSize, moveSpecifiedJoinColumn, removeSpecifiedJoinColumn, removeSpecifiedJoinColumn, specifiedJoinColumnsSize

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

getCatalog, getDbCatalog, getDbSchema, getDbSchemaContainer, getDbTable, getDefaultCatalog, getDefaultName, getDefaultSchema, getName, getSchema, getSpecifiedCatalog, getSpecifiedName, getSpecifiedSchema, hasResolvedCatalog, hasResolvedSchema, isResolved, isResourceSpecified, moveUniqueConstraint, removeUniqueConstraint, removeUniqueConstraint, setSpecifiedCatalog, setSpecifiedName, setSpecifiedSchema, 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

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

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

clearSpecifiedJoinColumns, convertDefaultToSpecifiedJoinColumn, getPersistentAttribute, hasSpecifiedJoinColumns, joinColumnsSize, moveSpecifiedJoinColumn, removeSpecifiedJoinColumn, removeSpecifiedJoinColumn, specifiedJoinColumnsSize

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

getCatalog, getDbCatalog, getDbSchema, getDbSchemaContainer, getDbTable, getDefaultCatalog, getDefaultName, getDefaultSchema, getName, getSchema, getSpecifiedCatalog, getSpecifiedName, getSpecifiedSchema, hasResolvedCatalog, hasResolvedSchema, isResolved, isResourceSpecified, moveUniqueConstraint, removeUniqueConstraint, removeUniqueConstraint, setSpecifiedCatalog, setSpecifiedName, setSpecifiedSchema, 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

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

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

getValidationTextRange, validate

Method Detail

update

void update()

initializeFrom

void initializeFrom(JoinTable oldJoinTable)

joinColumns

java.util.ListIterator<OrmJoinColumn> joinColumns()

Description copied from interface: ReferenceTable

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

Specified by:

joinColumns in interface OrmReferenceTable

Specified by:

joinColumns in interface ReferenceTable

getDefaultJoinColumn

OrmJoinColumn getDefaultJoinColumn()

Description copied from interface: ReferenceTable

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 OrmReferenceTable

Specified by:

getDefaultJoinColumn in interface ReferenceTable

specifiedJoinColumns

java.util.ListIterator<OrmJoinColumn> specifiedJoinColumns()

Description copied from interface: ReferenceTable

Return the specified join columns.

Specified by:

specifiedJoinColumns in interface OrmReferenceTable

Specified by:

specifiedJoinColumns in interface ReferenceTable

addSpecifiedJoinColumn

OrmJoinColumn addSpecifiedJoinColumn(int index)

Description copied from interface: ReferenceTable

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

Specified by:

addSpecifiedJoinColumn in interface OrmReferenceTable

Specified by:

addSpecifiedJoinColumn in interface ReferenceTable

inverseJoinColumns

java.util.ListIterator<OrmJoinColumn> inverseJoinColumns()

Description copied from interface: JoinTable

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

Specified by:

inverseJoinColumns in interface JoinTable

getDefaultInverseJoinColumn

OrmJoinColumn getDefaultInverseJoinColumn()

Description copied from interface: JoinTable

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

specifiedInverseJoinColumns

java.util.ListIterator<OrmJoinColumn> specifiedInverseJoinColumns()

Description copied from interface: JoinTable

Return the specified inverse join columns.

Specified by:

specifiedInverseJoinColumns in interface JoinTable

addSpecifiedInverseJoinColumn

OrmJoinColumn addSpecifiedInverseJoinColumn(int index)

Description copied from interface: JoinTable

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

Specified by:

addSpecifiedInverseJoinColumn in interface JoinTable

uniqueConstraints

java.util.ListIterator<OrmUniqueConstraint> uniqueConstraints()

Specified by:

uniqueConstraints in interface OrmReferenceTable

Specified by:

uniqueConstraints in interface Table

addUniqueConstraint

OrmUniqueConstraint addUniqueConstraint(int index)

Specified by:

addUniqueConstraint in interface OrmReferenceTable

Specified by:

addUniqueConstraint in interface Table