org.eclipse.jpt.core.context
Interface SecondaryTable

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

public interface SecondaryTable
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_PRIMARY_KEY_JOIN_COLUMN
           
static java.lang.String SPECIFIED_PRIMARY_KEY_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
 PrimaryKeyJoinColumn addSpecifiedPrimaryKeyJoinColumn(int index)
          Add a specified primary key join column to the secondary table return the object representing it.
 PrimaryKeyJoinColumn getDefaultPrimaryKeyJoinColumn()
          Return the default primary key join column or null.
 Entity getParent()
          Return the JPA node's parent.
 boolean isVirtual()
          Return true if the secondary table exists as specified on the owning object, or false if the secondary table is a result of defaults calculation
 void moveSpecifiedPrimaryKeyJoinColumn(int targetIndex, int sourceIndex)
          Move the specified primary key join column from the source index to the target index.
<T extends PrimaryKeyJoinColumn>
java.util.ListIterator<T>
primaryKeyJoinColumns()
          Return a list iterator of the primary key join columns whether specified or default.
 int primaryKeyJoinColumnsSize()
          Return the number of primary key join columns, both specified and default.
 void removeSpecifiedPrimaryKeyJoinColumn(int index)
          Remove the specified primary key join column from the secondary table.
 void removeSpecifiedPrimaryKeyJoinColumn(PrimaryKeyJoinColumn pkJoinColumn)
          Remove the specified primary key join column at the index from the secondary table.
<T extends PrimaryKeyJoinColumn>
java.util.ListIterator<T>
specifiedPrimaryKeyJoinColumns()
          Return a list iterator of the specified primary key join columns.
 int specifiedPrimaryKeyJoinColumnsSize()
          Return the number of specified primary key 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_PRIMARY_KEY_JOIN_COLUMNS_LIST

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

DEFAULT_PRIMARY_KEY_JOIN_COLUMN

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

getParent

Entity 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

primaryKeyJoinColumns

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


primaryKeyJoinColumnsSize

int primaryKeyJoinColumnsSize()
Return the number of primary key join columns, both specified and default.


specifiedPrimaryKeyJoinColumns

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


specifiedPrimaryKeyJoinColumnsSize

int specifiedPrimaryKeyJoinColumnsSize()
Return the number of specified primary key join columns.


getDefaultPrimaryKeyJoinColumn

PrimaryKeyJoinColumn getDefaultPrimaryKeyJoinColumn()
Return the default primary key join column or null. A default primary key join column only exists if there are no specified primary key join columns.


addSpecifiedPrimaryKeyJoinColumn

PrimaryKeyJoinColumn addSpecifiedPrimaryKeyJoinColumn(int index)
Add a specified primary key join column to the secondary table return the object representing it.


removeSpecifiedPrimaryKeyJoinColumn

void removeSpecifiedPrimaryKeyJoinColumn(int index)
Remove the specified primary key join column from the secondary table.


removeSpecifiedPrimaryKeyJoinColumn

void removeSpecifiedPrimaryKeyJoinColumn(PrimaryKeyJoinColumn pkJoinColumn)
Remove the specified primary key join column at the index from the secondary table.


moveSpecifiedPrimaryKeyJoinColumn

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


isVirtual

boolean isVirtual()
Return true if the secondary table exists as specified on the owning object, or false if the secondary table is a result of defaults calculation