org.eclipse.jpt.core.context
Interface TableGenerator

All Superinterfaces:
Generator, org.eclipse.core.runtime.IAdaptable, JpaContextNode, JpaNode, Model
All Known Subinterfaces:
JavaTableGenerator, OrmTableGenerator

public interface TableGenerator
extends Generator

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_CATALOG_PROPERTY
           
static java.lang.Integer DEFAULT_INITIAL_VALUE
           
static java.lang.String DEFAULT_PK_COLUMN_NAME_PROPERTY
           
static java.lang.String DEFAULT_PK_COLUMN_VALUE_PROPERTY
           
static java.lang.String DEFAULT_SCHEMA_PROPERTY
           
static java.lang.String DEFAULT_TABLE_PROPERTY
           
static java.lang.String DEFAULT_VALUE_COLUMN_NAME_PROPERTY
           
static java.lang.String SPECIFIED_CATALOG_PROPERTY
           
static java.lang.String SPECIFIED_PK_COLUMN_NAME_PROPERTY
           
static java.lang.String SPECIFIED_PK_COLUMN_VALUE_PROPERTY
           
static java.lang.String SPECIFIED_SCHEMA_PROPERTY
           
static java.lang.String SPECIFIED_TABLE_PROPERTY
           
static java.lang.String SPECIFIED_VALUE_COLUMN_NAME_PROPERTY
           
static java.lang.String UNIQUE_CONSTRAINTS_LIST
           
 
Fields inherited from interface org.eclipse.jpt.core.context.Generator
DEFAULT_ALLOCATION_SIZE, DEFAULT_ALLOCATION_SIZE_PROPERTY, DEFAULT_INITIAL_VALUE_PROPERTY, NAME_PROPERTY, SPECIFIED_ALLOCATION_SIZE_PROPERTY, SPECIFIED_INITIAL_VALUE_PROPERTY
 
Method Summary
 UniqueConstraint addUniqueConstraint(int index)
          Add a unique constraint to the table and return the object representing it.
 java.lang.String getCatalog()
           
 Schema getDbSchema()
          Return a db Schema object with the specified/default schema name.
 Table getDbTable()
          Return a db Table object with the specified/default table name.
 java.lang.String getDefaultCatalog()
           
 java.lang.String getDefaultPkColumnName()
           
 java.lang.String getDefaultPkColumnValue()
           
 java.lang.String getDefaultSchema()
           
 java.lang.String getDefaultTable()
           
 java.lang.String getDefaultValueColumnName()
           
 java.lang.String getPkColumnName()
           
 java.lang.String getPkColumnValue()
           
 java.lang.String getSchema()
           
 java.lang.String getSpecifiedCatalog()
           
 java.lang.String getSpecifiedPkColumnName()
           
 java.lang.String getSpecifiedPkColumnValue()
           
 java.lang.String getSpecifiedSchema()
           
 java.lang.String getSpecifiedTable()
           
 java.lang.String getSpecifiedValueColumnName()
           
 java.lang.String getTable()
           
 java.lang.String getValueColumnName()
           
 void moveUniqueConstraint(int targetIndex, int sourceIndex)
          Move the unique constraint from the source index to the target index.
 void removeUniqueConstraint(int index)
          Remove unique constraint at the given index from the Table
 void removeUniqueConstraint(UniqueConstraint uniqueConstraint)
          Remove the unique constraint from the Table
 void setSpecifiedCatalog(java.lang.String value)
           
 void setSpecifiedPkColumnName(java.lang.String value)
           
 void setSpecifiedPkColumnValue(java.lang.String value)
           
 void setSpecifiedSchema(java.lang.String value)
           
 void setSpecifiedTable(java.lang.String value)
           
 void setSpecifiedValueColumnName(java.lang.String value)
           
<T extends UniqueConstraint>
java.util.ListIterator<T>
uniqueConstraints()
          Return a list iterator of the unique constraints.
 int uniqueConstraintsSize()
          Return the number of unique constraints.
 
Methods inherited from interface org.eclipse.jpt.core.context.Generator
getAllocationSize, getDefaultAllocationSize, getDefaultInitialValue, getInitialValue, getName, getSpecifiedAllocationSize, getSpecifiedInitialValue, isVirtual, overrides, setName, setSpecifiedAllocationSize, setSpecifiedInitialValue
 
Methods inherited from interface org.eclipse.jpt.core.context.JpaContextNode
getEntityMappings, getOrmPersistentType, getPersistenceUnit
 
Methods inherited from interface org.eclipse.jpt.core.JpaNode
getJpaProject, getParent, 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

DEFAULT_INITIAL_VALUE

static final java.lang.Integer DEFAULT_INITIAL_VALUE

DEFAULT_TABLE_PROPERTY

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

SPECIFIED_TABLE_PROPERTY

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

DEFAULT_CATALOG_PROPERTY

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

SPECIFIED_CATALOG_PROPERTY

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

DEFAULT_SCHEMA_PROPERTY

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

SPECIFIED_SCHEMA_PROPERTY

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

DEFAULT_PK_COLUMN_NAME_PROPERTY

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

SPECIFIED_PK_COLUMN_NAME_PROPERTY

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

DEFAULT_VALUE_COLUMN_NAME_PROPERTY

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

SPECIFIED_VALUE_COLUMN_NAME_PROPERTY

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

DEFAULT_PK_COLUMN_VALUE_PROPERTY

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

SPECIFIED_PK_COLUMN_VALUE_PROPERTY

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

UNIQUE_CONSTRAINTS_LIST

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

getTable

java.lang.String getTable()

getDefaultTable

java.lang.String getDefaultTable()

getSpecifiedTable

java.lang.String getSpecifiedTable()

setSpecifiedTable

void setSpecifiedTable(java.lang.String value)

getCatalog

java.lang.String getCatalog()

getDefaultCatalog

java.lang.String getDefaultCatalog()

getSpecifiedCatalog

java.lang.String getSpecifiedCatalog()

setSpecifiedCatalog

void setSpecifiedCatalog(java.lang.String value)

getSchema

java.lang.String getSchema()

getDefaultSchema

java.lang.String getDefaultSchema()

getSpecifiedSchema

java.lang.String getSpecifiedSchema()

setSpecifiedSchema

void setSpecifiedSchema(java.lang.String value)

getPkColumnName

java.lang.String getPkColumnName()

getDefaultPkColumnName

java.lang.String getDefaultPkColumnName()

getSpecifiedPkColumnName

java.lang.String getSpecifiedPkColumnName()

setSpecifiedPkColumnName

void setSpecifiedPkColumnName(java.lang.String value)

getValueColumnName

java.lang.String getValueColumnName()

getDefaultValueColumnName

java.lang.String getDefaultValueColumnName()

getSpecifiedValueColumnName

java.lang.String getSpecifiedValueColumnName()

setSpecifiedValueColumnName

void setSpecifiedValueColumnName(java.lang.String value)

getPkColumnValue

java.lang.String getPkColumnValue()

getDefaultPkColumnValue

java.lang.String getDefaultPkColumnValue()

getSpecifiedPkColumnValue

java.lang.String getSpecifiedPkColumnValue()

setSpecifiedPkColumnValue

void setSpecifiedPkColumnValue(java.lang.String value)

uniqueConstraints

<T extends UniqueConstraint> java.util.ListIterator<T> uniqueConstraints()
Return a list iterator of the unique constraints. This will not be null.


uniqueConstraintsSize

int uniqueConstraintsSize()
Return the number of unique constraints.


addUniqueConstraint

UniqueConstraint addUniqueConstraint(int index)
Add a unique constraint to the table and return the object representing it.


removeUniqueConstraint

void removeUniqueConstraint(int index)
Remove unique constraint at the given index from the Table


removeUniqueConstraint

void removeUniqueConstraint(UniqueConstraint uniqueConstraint)
Remove the unique constraint from the Table


moveUniqueConstraint

void moveUniqueConstraint(int targetIndex,
                          int sourceIndex)
Move the unique constraint from the source index to the target index.


getDbSchema

Schema getDbSchema()
Return a db Schema object with the specified/default schema name. This can return null if no Schema exists on the database with that name.


getDbTable

Table getDbTable()
Return a db Table object with the specified/default table name. This can return null if no Table exists on the database with that name.