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

All Superinterfaces:

DbGenerator, Generator, IAdaptable, JpaContextModel, JpaModel, JpaNamedContextModel, JptResourceTypeReference, Model

All Known Subinterfaces:

JavaTableGenerator, OrmTableGenerator

public interface TableGenerator
extends DbGenerator

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

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.context.JpaNamedContextModel

JpaNamedContextModel.NameTransformer

Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.JpaModel

JpaModel.JpaVersionIsCompatibleWith

Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

JptResourceTypeReference.ResourceTypeIsKindOf, JptResourceTypeReference.ResourceTypeTransformer

Field Summary

static String	DEFAULT_CATALOG_PROPERTY
static int	DEFAULT_INITIAL_VALUE
static String	DEFAULT_PK_COLUMN_NAME_PROPERTY
static String	DEFAULT_PK_COLUMN_VALUE_PROPERTY
static String	DEFAULT_SCHEMA_PROPERTY
static String	DEFAULT_TABLE_NAME_PROPERTY
static String	DEFAULT_VALUE_COLUMN_NAME_PROPERTY
static String	SPECIFIED_CATALOG_PROPERTY
static String	SPECIFIED_PK_COLUMN_NAME_PROPERTY
static String	SPECIFIED_PK_COLUMN_VALUE_PROPERTY
static String	SPECIFIED_SCHEMA_PROPERTY
static String	SPECIFIED_TABLE_NAME_PROPERTY
static String	SPECIFIED_VALUE_COLUMN_NAME_PROPERTY
static String	UNIQUE_CONSTRAINTS_LIST

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

DEFAULT_ALLOCATION_SIZE, DEFAULT_ALLOCATION_SIZE_PROPERTY, DEFAULT_INITIAL_VALUE_PROPERTY, SPECIFIED_ALLOCATION_SIZE_PROPERTY, SPECIFIED_INITIAL_VALUE_PROPERTY

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

TYPES

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

NAME_PROPERTY, NAME_TRANSFORMER

Fields inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

TRANSFORMER

Method Summary

SpecifiedUniqueConstraint	addUniqueConstraint()
SpecifiedUniqueConstraint	addUniqueConstraint(int index)
String	getCatalog() Return the specified catalog if present, otherwise return the default catalog.
Table	getDbTable() Return the generator's database table.
String	getDefaultCatalog()
String	getDefaultPkColumnName()
String	getDefaultPkColumnValue()
String	getDefaultSchema()
String	getDefaultTableName()
String	getDefaultValueColumnName()
String	getPkColumnName() Return the specified primary key colum name if present, otherwise return the default primary key colum name.
String	getPkColumnValue() Return the specified primary key colum value if present, otherwise return the default primary key colum value.
String	getSchema() Return the specified schema if present, otherwise return the default schema.
String	getSpecifiedCatalog()
String	getSpecifiedPkColumnName()
String	getSpecifiedPkColumnValue()
String	getSpecifiedSchema()
String	getSpecifiedTableName()
String	getSpecifiedValueColumnName()
String	getTableName() Return the specified table name if present, otherwise return the default table name.
SpecifiedUniqueConstraint	getUniqueConstraint(int index)
<T extends SpecifiedUniqueConstraint> Iterable<T>	getUniqueConstraints()
int	getUniqueConstraintsSize()
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(SpecifiedUniqueConstraint uniqueConstraint)
void	setSpecifiedCatalog(String value)
void	setSpecifiedPkColumnName(String value)
void	setSpecifiedPkColumnValue(String value)
void	setSpecifiedSchema(String value)
void	setSpecifiedTableName(String tableName)
void	setSpecifiedValueColumnName(String value)

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

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

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

getNameTextRange, getType, supportsValidationMessages

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

getName, isEquivalentTo, setName

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

getCompletionProposals, getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getParent, getPersistenceUnit, getValidationTextRange, synchronizeWithResourceModel, update, validate

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

getJpaPlatform, getJpaProject, getJpaProjectManager, getResource, stateChanged

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

addChangeListener, addCollectionChangeListener, addListChangeListener, addPropertyChangeListener, addStateChangeListener, removeChangeListener, removeCollectionChangeListener, removeListChangeListener, removePropertyChangeListener, removeStateChangeListener

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Methods inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

getResourceType

Field Detail

DEFAULT_INITIAL_VALUE

static final int DEFAULT_INITIAL_VALUE

See Also:

Constant Field Values

SPECIFIED_TABLE_NAME_PROPERTY

static final String SPECIFIED_TABLE_NAME_PROPERTY

See Also:

Constant Field Values

DEFAULT_TABLE_NAME_PROPERTY

static final String DEFAULT_TABLE_NAME_PROPERTY

See Also:

Constant Field Values

SPECIFIED_SCHEMA_PROPERTY

static final String SPECIFIED_SCHEMA_PROPERTY

See Also:

Constant Field Values

DEFAULT_SCHEMA_PROPERTY

static final String DEFAULT_SCHEMA_PROPERTY

See Also:

Constant Field Values

SPECIFIED_CATALOG_PROPERTY

static final String SPECIFIED_CATALOG_PROPERTY

See Also:

Constant Field Values

DEFAULT_CATALOG_PROPERTY

static final String DEFAULT_CATALOG_PROPERTY

See Also:

Constant Field Values

SPECIFIED_PK_COLUMN_NAME_PROPERTY

static final String SPECIFIED_PK_COLUMN_NAME_PROPERTY

See Also:

Constant Field Values

DEFAULT_PK_COLUMN_NAME_PROPERTY

static final String DEFAULT_PK_COLUMN_NAME_PROPERTY

See Also:

Constant Field Values

SPECIFIED_VALUE_COLUMN_NAME_PROPERTY

static final String SPECIFIED_VALUE_COLUMN_NAME_PROPERTY

See Also:

Constant Field Values

DEFAULT_VALUE_COLUMN_NAME_PROPERTY

static final String DEFAULT_VALUE_COLUMN_NAME_PROPERTY

See Also:

Constant Field Values

SPECIFIED_PK_COLUMN_VALUE_PROPERTY

static final String SPECIFIED_PK_COLUMN_VALUE_PROPERTY

See Also:

Constant Field Values

DEFAULT_PK_COLUMN_VALUE_PROPERTY

static final String DEFAULT_PK_COLUMN_VALUE_PROPERTY

See Also:

Constant Field Values

UNIQUE_CONSTRAINTS_LIST

static final String UNIQUE_CONSTRAINTS_LIST

See Also:

Constant Field Values

Method Detail

getTableName

String getTableName()

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

getSpecifiedTableName

String getSpecifiedTableName()

setSpecifiedTableName

void setSpecifiedTableName(String tableName)

getDefaultTableName

String getDefaultTableName()

getSchema

String getSchema()

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

getSpecifiedSchema

String getSpecifiedSchema()

setSpecifiedSchema

void setSpecifiedSchema(String value)

getDefaultSchema

String getDefaultSchema()

getCatalog

String getCatalog()

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

getSpecifiedCatalog

String getSpecifiedCatalog()

setSpecifiedCatalog

void setSpecifiedCatalog(String value)

getDefaultCatalog

String getDefaultCatalog()

getPkColumnName

String getPkColumnName()

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

getSpecifiedPkColumnName

String getSpecifiedPkColumnName()

setSpecifiedPkColumnName

void setSpecifiedPkColumnName(String value)

getDefaultPkColumnName

String getDefaultPkColumnName()

getValueColumnName

String getValueColumnName()

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

getSpecifiedValueColumnName

String getSpecifiedValueColumnName()

setSpecifiedValueColumnName

void setSpecifiedValueColumnName(String value)

getDefaultValueColumnName

String getDefaultValueColumnName()

getPkColumnValue

String getPkColumnValue()

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

getSpecifiedPkColumnValue

String getSpecifiedPkColumnValue()

setSpecifiedPkColumnValue

void setSpecifiedPkColumnValue(String value)

getDefaultPkColumnValue

String getDefaultPkColumnValue()

getUniqueConstraints

<T extends SpecifiedUniqueConstraint> Iterable<T> getUniqueConstraints()

getUniqueConstraintsSize

int getUniqueConstraintsSize()

getUniqueConstraint

SpecifiedUniqueConstraint getUniqueConstraint(int index)

addUniqueConstraint

SpecifiedUniqueConstraint addUniqueConstraint()

addUniqueConstraint

SpecifiedUniqueConstraint addUniqueConstraint(int index)

removeUniqueConstraint

void removeUniqueConstraint(int index)

removeUniqueConstraint

void removeUniqueConstraint(SpecifiedUniqueConstraint 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.