org.eclipse.jpt.jpa.core.context
Interface TableGenerator

All Superinterfaces:

Generator, org.eclipse.core.runtime.IAdaptable, IResourcePart, JpaContextNode, JpaNamedContextNode<Generator>, JpaNode, Model

All Known Subinterfaces:

JavaTableGenerator, OrmTableGenerator

public interface TableGenerator
extends Generator

table 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.

Since:

2.0

Version:

2.2

Field Summary

static java.lang.String	DEFAULT_CATALOG_PROPERTY
static int	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.jpa.core.context.Generator

DEFAULT_ALLOCATION_SIZE, DEFAULT_ALLOCATION_SIZE_PROPERTY, DEFAULT_INITIAL_VALUE_PROPERTY, PRECEDENCE_TYPE_LIST, SPECIFIED_ALLOCATION_SIZE_PROPERTY, SPECIFIED_INITIAL_VALUE_PROPERTY

Fields inherited from interface org.eclipse.jpt.jpa.core.context.JpaNamedContextNode

NAME_PROPERTY

Method Summary

UniqueConstraint	addUniqueConstraint()
UniqueConstraint	addUniqueConstraint(int index)
java.lang.String	getCatalog() Return the specified catalog if present, otherwise return the default catalog.
Table	getDbTable() Return the generator's database table.
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() Return the specified primary key colum name if present, otherwise return the default primary key colum name.
java.lang.String	getPkColumnValue() Return the specified primary key colum value if present, otherwise return the default primary key colum value.
java.lang.String	getSchema() Return the specified schema if present, otherwise return the default schema.
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() Return the specified table if present, otherwise return the default table.
<T extends UniqueConstraint> java.lang.Iterable<T>	getUniqueConstraints()
int	getUniqueConstraintsSize()
java.lang.String	getValueColumnName() Return the specified value colum name if present, otherwise return the default value colum name.
void	moveUniqueConstraint(int targetIndex, int sourceIndex)
void	removeUniqueConstraint(int index)
void	removeUniqueConstraint(UniqueConstraint uniqueConstraint)
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)

Methods inherited from interface org.eclipse.jpt.jpa.core.context.Generator

getAllocationSize, getDbCatalog, getDbSchema, getDbSchemaContainer, getDefaultAllocationSize, getDefaultInitialValue, getInitialValue, getSpecifiedAllocationSize, getSpecifiedInitialValue, setSpecifiedAllocationSize, setSpecifiedInitialValue

Methods inherited from interface org.eclipse.jpt.jpa.core.context.JpaNamedContextNode

duplicates, getName, overrides, setName

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

getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, getResourceType, synchronizeWithResourceModel, update

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

getJpaProject, getParent, stateChanged

Methods inherited from interface org.eclipse.jpt.common.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.common.core.IResourcePart

getResource

Field Detail

DEFAULT_INITIAL_VALUE

static final int DEFAULT_INITIAL_VALUE

See Also:

Constant Field Values

SPECIFIED_TABLE_PROPERTY

static final java.lang.String SPECIFIED_TABLE_PROPERTY

See Also:

Constant Field Values

DEFAULT_TABLE_PROPERTY

static final java.lang.String DEFAULT_TABLE_PROPERTY

See Also:

Constant Field Values

SPECIFIED_SCHEMA_PROPERTY

static final java.lang.String SPECIFIED_SCHEMA_PROPERTY

See Also:

Constant Field Values

DEFAULT_SCHEMA_PROPERTY

static final java.lang.String DEFAULT_SCHEMA_PROPERTY

See Also:

Constant Field Values

SPECIFIED_CATALOG_PROPERTY

static final java.lang.String SPECIFIED_CATALOG_PROPERTY

See Also:

Constant Field Values

DEFAULT_CATALOG_PROPERTY

static final java.lang.String DEFAULT_CATALOG_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_PK_COLUMN_NAME_PROPERTY

static final java.lang.String DEFAULT_PK_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_VALUE_COLUMN_NAME_PROPERTY

static final java.lang.String DEFAULT_VALUE_COLUMN_NAME_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

DEFAULT_PK_COLUMN_VALUE_PROPERTY

static final java.lang.String DEFAULT_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()

Return the specified table if present, otherwise return the default table.

getSpecifiedTable

java.lang.String getSpecifiedTable()

setSpecifiedTable

void setSpecifiedTable(java.lang.String value)

getDefaultTable

java.lang.String getDefaultTable()

getSchema

java.lang.String getSchema()

Return the specified schema if present, otherwise return the default schema.

getSpecifiedSchema

java.lang.String getSpecifiedSchema()

setSpecifiedSchema

void setSpecifiedSchema(java.lang.String value)

getDefaultSchema

java.lang.String getDefaultSchema()

getCatalog

java.lang.String getCatalog()

Return the specified catalog if present, otherwise return the default catalog.

getSpecifiedCatalog

java.lang.String getSpecifiedCatalog()

setSpecifiedCatalog

void setSpecifiedCatalog(java.lang.String value)

getDefaultCatalog

java.lang.String getDefaultCatalog()

getPkColumnName

java.lang.String getPkColumnName()

Return the specified primary key colum name if present, otherwise return the default primary key colum name.

getSpecifiedPkColumnName

java.lang.String getSpecifiedPkColumnName()

setSpecifiedPkColumnName

void setSpecifiedPkColumnName(java.lang.String value)

getDefaultPkColumnName

java.lang.String getDefaultPkColumnName()

getValueColumnName

java.lang.String getValueColumnName()

Return the specified value colum name if present, otherwise return the default value colum name.

getSpecifiedValueColumnName

java.lang.String getSpecifiedValueColumnName()

setSpecifiedValueColumnName

void setSpecifiedValueColumnName(java.lang.String value)

getDefaultValueColumnName

java.lang.String getDefaultValueColumnName()

getPkColumnValue

java.lang.String getPkColumnValue()

Return the specified primary key colum value if present, otherwise return the default primary key colum value.

getSpecifiedPkColumnValue

java.lang.String getSpecifiedPkColumnValue()

setSpecifiedPkColumnValue

void setSpecifiedPkColumnValue(java.lang.String value)

getDefaultPkColumnValue

java.lang.String getDefaultPkColumnValue()

getUniqueConstraints

<T extends UniqueConstraint> java.lang.Iterable<T> getUniqueConstraints()

getUniqueConstraintsSize

int getUniqueConstraintsSize()

addUniqueConstraint

UniqueConstraint addUniqueConstraint()

addUniqueConstraint

UniqueConstraint addUniqueConstraint(int index)

removeUniqueConstraint

void removeUniqueConstraint(int index)

removeUniqueConstraint

void removeUniqueConstraint(UniqueConstraint uniqueConstraint)

moveUniqueConstraint

void moveUniqueConstraint(int targetIndex,
                          int sourceIndex)

getDbTable

Table getDbTable()

Return the generator's database table. Return null if the generator's table (name) is invalid.