org.eclipse.jpt.core.context
Interface JoinTable

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable, JpaContextNode, JpaNode, Model, Table
All Known Subinterfaces:
JavaJoinTable, OrmJoinTable

public interface JoinTable
extends 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.


Field Summary
static java.lang.String DEFAULT_INVERSE_JOIN_COLUMN
           
static java.lang.String DEFAULT_JOIN_COLUMN
           
static java.lang.String SPECIFIED_INVERSE_JOIN_COLUMNS_LIST
           
static java.lang.String 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
 JoinColumn addSpecifiedInverseJoinColumn(int index)
          Add a specified inverse join column to the join table return the object representing it.
 JoinColumn addSpecifiedJoinColumn(int index)
          Add a specified join column to the join table return the object representing it.
 boolean containsSpecifiedInverseJoinColumns()
           
 boolean containsSpecifiedJoinColumns()
           
 JoinColumn getDefaultInverseJoinColumn()
          Return the default inverse join column or null.
 JoinColumn getDefaultJoinColumn()
          Return the default join column or null.
 RelationshipMapping getParent()
          Return the JPA node's parent.
<T extends JoinColumn>
java.util.ListIterator<T>
inverseJoinColumns()
          Return a list iterator of the inverse join columns whether specified or default.
 int inverseJoinColumnsSize()
          Return the number of inverse join columns, both specified and default.
<T extends JoinColumn>
java.util.ListIterator<T>
joinColumns()
          Return a list iterator of the join columns whether specified or default.
 int joinColumnsSize()
          Return the number of join columns, both specified and default.
 void moveSpecifiedInverseJoinColumn(int targetIndex, int sourceIndex)
          Move the specified inverse join column from the source index to the target index.
 void moveSpecifiedJoinColumn(int targetIndex, int sourceIndex)
          Move the specified join column from the source index to the target index.
 void removeSpecifiedInverseJoinColumn(int index)
          Remove the specified inverse join column from the join table.
 void removeSpecifiedInverseJoinColumn(JoinColumn joinColumn)
          Remove the specified inverse join column at the index from the join table.
 void removeSpecifiedJoinColumn(int index)
          Remove the specified join column from the join table.
 void removeSpecifiedJoinColumn(JoinColumn joinColumn)
          Remove the specified join column at the index from the join table.
<T extends JoinColumn>
java.util.ListIterator<T>
specifiedInverseJoinColumns()
          Return a list iterator of the specified inverse join columns.
 int specifiedInverseJoinColumnsSize()
          Return the number of specified inverse join columns.
<T extends JoinColumn>
java.util.ListIterator<T>
specifiedJoinColumns()
          Return a list iterator of the specified join columns.
 int specifiedJoinColumnsSize()
          Return the number of specified join columns.
 
Methods inherited from interface org.eclipse.jpt.core.context.Table
addUniqueConstraint, connectionProfileIsActive, getCatalog, getDbSchema, getDbTable, getDefaultCatalog, getDefaultName, getDefaultSchema, getName, getSchema, getSpecifiedCatalog, getSpecifiedName, getSpecifiedSchema, hasResolvedSchema, isResolved, moveUniqueConstraint, removeUniqueConstraint, removeUniqueConstraint, setSpecifiedCatalog, setSpecifiedName, setSpecifiedSchema, uniqueConstraints, uniqueConstraintsSize
 
Methods inherited from interface org.eclipse.jpt.core.context.JpaContextNode
getEntityMappings, getOrmPersistentType, getPersistenceUnit
 
Methods inherited from interface org.eclipse.jpt.core.JpaNode
getJpaProject, getResource
 
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
 

Field Detail

SPECIFIED_JOIN_COLUMNS_LIST

static final java.lang.String SPECIFIED_JOIN_COLUMNS_LIST
See Also:
Constant Field Values

DEFAULT_JOIN_COLUMN

static final java.lang.String DEFAULT_JOIN_COLUMN
See Also:
Constant Field Values

SPECIFIED_INVERSE_JOIN_COLUMNS_LIST

static final java.lang.String SPECIFIED_INVERSE_JOIN_COLUMNS_LIST
See Also:
Constant Field Values

DEFAULT_INVERSE_JOIN_COLUMN

static final java.lang.String DEFAULT_INVERSE_JOIN_COLUMN
See Also:
Constant Field Values
Method Detail

getParent

RelationshipMapping 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 JpaNode

joinColumns

<T extends JoinColumn> java.util.ListIterator<T> joinColumns()
Return a list iterator of the join columns whether specified or default. This will not be null.


joinColumnsSize

int joinColumnsSize()
Return the number of join columns, both specified and default.


specifiedJoinColumns

<T extends JoinColumn> java.util.ListIterator<T> specifiedJoinColumns()
Return a list iterator of the specified join columns. This will not be null.


specifiedJoinColumnsSize

int specifiedJoinColumnsSize()
Return the number of specified join columns.


getDefaultJoinColumn

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


addSpecifiedJoinColumn

JoinColumn addSpecifiedJoinColumn(int index)
Add a specified join column to the join table return the object representing it.


removeSpecifiedJoinColumn

void removeSpecifiedJoinColumn(int index)
Remove the specified join column from the join table.


removeSpecifiedJoinColumn

void removeSpecifiedJoinColumn(JoinColumn joinColumn)
Remove the specified join column at the index from the join table.


moveSpecifiedJoinColumn

void moveSpecifiedJoinColumn(int targetIndex,
                             int sourceIndex)
Move the specified join column from the source index to the target index.


containsSpecifiedJoinColumns

boolean containsSpecifiedJoinColumns()

inverseJoinColumns

<T extends JoinColumn> java.util.ListIterator<T> inverseJoinColumns()
Return a list iterator of the inverse join columns whether specified or default. This will not be null.


inverseJoinColumnsSize

int inverseJoinColumnsSize()
Return the number of inverse join columns, both specified and default.


specifiedInverseJoinColumns

<T extends JoinColumn> java.util.ListIterator<T> specifiedInverseJoinColumns()
Return a list iterator of the specified inverse join columns. This will not be null.


specifiedInverseJoinColumnsSize

int specifiedInverseJoinColumnsSize()
Return the number of specified inverse join columns.


getDefaultInverseJoinColumn

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


addSpecifiedInverseJoinColumn

JoinColumn addSpecifiedInverseJoinColumn(int index)
Add a specified inverse join column to the join table return the object representing it.


removeSpecifiedInverseJoinColumn

void removeSpecifiedInverseJoinColumn(int index)
Remove the specified inverse join column from the join table.


removeSpecifiedInverseJoinColumn

void removeSpecifiedInverseJoinColumn(JoinColumn joinColumn)
Remove the specified inverse join column at the index from the join table.


moveSpecifiedInverseJoinColumn

void moveSpecifiedInverseJoinColumn(int targetIndex,
                                    int sourceIndex)
Move the specified inverse join column from the source index to the target index.


containsSpecifiedInverseJoinColumns

boolean containsSpecifiedInverseJoinColumns()