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

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable, IResourcePart, JoinTable, JpaContextNode, JpaNode, Model, Table, XmlContextNode

public interface OrmJoinTable
extends JoinTable, XmlContextNode

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.

Field Summary

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

DEFAULT_INVERSE_JOIN_COLUMN, DEFAULT_JOIN_COLUMN, SPECIFIED_INVERSE_JOIN_COLUMNS_LIST, 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 inverse join column to the join table return the object representing it.
OrmJoinColumn	addSpecifiedJoinColumn(int index) Add a specified join column to the join table return the object representing it.
OrmUniqueConstraint	addUniqueConstraint(int index)
OrmJoinColumn	getDefaultInverseJoinColumn() Return the default inverse join column or null.
OrmJoinColumn	getDefaultJoinColumn() Return the default join column or null.
OrmRelationshipMapping	getParent() Return the JPA node's parent.
void	initialize(XmlRelationshipMapping relationshipMapping)
void	initializeFrom(JoinTable oldJoinTable)
java.util.ListIterator<OrmJoinColumn>	inverseJoinColumns() Return a list iterator of the inverse join columns whether specified or default.
boolean	isSpecified()
java.util.ListIterator<OrmJoinColumn>	joinColumns() Return a list iterator of the join columns whether specified or default.
java.util.ListIterator<OrmJoinColumn>	specifiedInverseJoinColumns() Return a list iterator of the specified inverse join columns.
java.util.ListIterator<OrmJoinColumn>	specifiedJoinColumns() Return a list iterator of the specified join columns.
java.util.ListIterator<OrmUniqueConstraint>	uniqueConstraints()
void	update() Update the OrmJoinTable context model object to match the XmlRelationshipMapping resource model object.

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

containsSpecifiedInverseJoinColumns, containsSpecifiedJoinColumns, inverseJoinColumnsSize, joinColumnsSize, moveSpecifiedInverseJoinColumn, moveSpecifiedJoinColumn, removeSpecifiedInverseJoinColumn, removeSpecifiedInverseJoinColumn, removeSpecifiedJoinColumn, removeSpecifiedJoinColumn, specifiedInverseJoinColumnsSize, 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, moveUniqueConstraint, removeUniqueConstraint, removeUniqueConstraint, setSpecifiedCatalog, setSpecifiedName, setSpecifiedSchema, uniqueConstraintsSize

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

getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit

Methods inherited from interface org.eclipse.jpt.core.JpaNode

getJpaProject

Methods inherited from interface org.eclipse.jpt.utility.model.Model

addCollectionChangeListener, addCollectionChangeListener, addListChangeListener, addListChangeListener, addPropertyChangeListener, addPropertyChangeListener, addStateChangeListener, addTreeChangeListener, addTreeChangeListener, removeCollectionChangeListener, removeCollectionChangeListener, removeListChangeListener, removeListChangeListener, removePropertyChangeListener, removePropertyChangeListener, removeStateChangeListener, removeTreeChangeListener, 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

getEResource, getValidationTextRange, validate

Method Detail

isSpecified

boolean isSpecified()

initialize

void initialize(XmlRelationshipMapping relationshipMapping)

update

void update()

Update the OrmJoinTable context model object to match the XmlRelationshipMapping resource model object. see JpaProject.update()

initializeFrom

void initializeFrom(JoinTable oldJoinTable)

getParent

OrmRelationshipMapping 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

joinColumns

java.util.ListIterator<OrmJoinColumn> joinColumns()

Description copied from interface: JoinTable

Return a list iterator of the join columns whether specified or default. This will not be null.

Specified by:

joinColumns in interface JoinTable

getDefaultJoinColumn

OrmJoinColumn getDefaultJoinColumn()

Description copied from interface: JoinTable

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 JoinTable

specifiedJoinColumns

java.util.ListIterator<OrmJoinColumn> specifiedJoinColumns()

Description copied from interface: JoinTable

Return a list iterator of the specified join columns. This will not be null.

Specified by:

specifiedJoinColumns in interface JoinTable

addSpecifiedJoinColumn

OrmJoinColumn addSpecifiedJoinColumn(int index)

Description copied from interface: JoinTable

Add a specified join column to the join table return the object representing it.

Specified by:

addSpecifiedJoinColumn in interface JoinTable

inverseJoinColumns

java.util.ListIterator<OrmJoinColumn> inverseJoinColumns()

Description copied from interface: JoinTable

Return a list iterator of the inverse join columns whether specified or default. This will not be null.

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 a list iterator of the specified inverse join columns. This will not be null.

Specified by:

specifiedInverseJoinColumns 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 object representing it.

Specified by:

addSpecifiedInverseJoinColumn in interface JoinTable

uniqueConstraints

java.util.ListIterator<OrmUniqueConstraint> uniqueConstraints()

Specified by:

uniqueConstraints in interface Table

addUniqueConstraint

OrmUniqueConstraint addUniqueConstraint(int index)

Specified by:

addUniqueConstraint in interface Table