org.eclipse.jpt.jpa.core.resource.java
Interface TableGeneratorAnnotation

All Superinterfaces:

Annotation, DbGeneratorAnnotation, GeneratorAnnotation, JavaResourceNode, Model

public interface TableGeneratorAnnotation
extends DbGeneratorAnnotation

Corresponds to the JPA annotation javax.persistence.TableGenerator

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.common.core.resource.java.JavaResourceNode

JavaResourceNode.FileTransformer, JavaResourceNode.Root

Field Summary

static String	ANNOTATION_NAME
static String	CATALOG_PROPERTY
static String	PK_COLUMN_NAME_PROPERTY
static String	PK_COLUMN_VALUE_PROPERTY
static String	SCHEMA_PROPERTY
static String	TABLE_PROPERTY
static String	UNIQUE_CONSTRAINTS_LIST
static String	VALUE_COLUMN_NAME_PROPERTY

Fields inherited from interface org.eclipse.jpt.jpa.core.resource.java.DbGeneratorAnnotation

ALLOCATION_SIZE_PROPERTY, INITIAL_VALUE_PROPERTY

Fields inherited from interface org.eclipse.jpt.jpa.core.resource.java.GeneratorAnnotation

NAME_PROPERTY

Fields inherited from interface org.eclipse.jpt.common.core.resource.java.JavaResourceNode

FILE_TRANSFORMER

Method Summary

UniqueConstraintAnnotation	addUniqueConstraint(int index) Corresponds to the 'uniqueConstraints' element of the TableGenerator annotation.
boolean	catalogTouches(int pos) Return whether the specified position touches the 'catalog' element.
String	getCatalog() Corresponds to the 'catalog' element of the TableGenerator annotation.
TextRange	getCatalogTextRange() Return the TextRange for the 'catalog' element.
String	getPkColumnName() Corresponds to the 'pkColumnName' element of the TableGenerator annotation.
TextRange	getPkColumnNameTextRange() Return the TextRange for the 'pkColumnName' element.
String	getPkColumnValue() Corresponds to the 'pkColumnValue' element of the TableGenerator annotation.
TextRange	getPkColumnValueTextRange() Return the TextRange for the 'pkColumnValue' element.
String	getSchema() Corresponds to the 'schema' element of the TableGenerator annotation.
TextRange	getSchemaTextRange() Return the TextRange for the 'schema' element.
String	getTable() Corresponds to the 'table' element of the TableGenerator annotation.
TextRange	getTableTextRange() Return the TextRange for the 'table' element.
org.eclipse.jpt.common.utility.iterable.ListIterable<UniqueConstraintAnnotation>	getUniqueConstraints() Corresponds to the 'uniqueConstraints' element of the TableGenerator annotation.
int	getUniqueConstraintsSize() Corresponds to the 'uniqueConstraints' element of the TableGenerator annotation.
String	getValueColumnName() Corresponds to the 'valueColumnName' element of the TableGenerator annotation.
TextRange	getValueColumnNameTextRange() Return the TextRange for the 'valueColumnName' element.
void	moveUniqueConstraint(int targetIndex, int sourceIndex) Corresponds to the 'uniqueConstraints' element of the TableGenerator annotation.
boolean	pkColumnNameTouches(int pos) Return whether the specified position touches the 'pkColumnName' element.
boolean	pkColumnValueTouches(int pos) Return whether the specified position touches the 'pkColumnValue' element.
void	removeUniqueConstraint(int index) Corresponds to the 'uniqueConstraints' element of the TableGenerator annotation.
boolean	schemaTouches(int pos) Return whether the specified position touches the 'schema' element.
void	setCatalog(String catalog) Corresponds to the 'catalog' element of the TableGenerator annotation.
void	setPkColumnName(String pkColumnName) Corresponds to the 'pkColumnName' element of the TableGenerator annotation.
void	setPkColumnValue(String pkColumnValue) Corresponds to the 'pkColumnValue' element of the TableGenerator annotation.
void	setSchema(String schema) Corresponds to the 'schema' element of the TableGenerator annotation.
void	setTable(String table) Corresponds to the 'table' element of the TableGenerator annotation.
void	setValueColumnName(String valueColumnName) Corresponds to the 'valueColumnName' element of the TableGenerator annotation.
boolean	tableTouches(int pos) Return whether the specified position touches the 'table' element.
UniqueConstraintAnnotation	uniqueConstraintAt(int index) Corresponds to the 'uniqueConstraints' element of the TableGenerator annotation.
boolean	valueColumnNameTouches(int pos) Return whether the specified position touches the 'valueColumnName' element.

Methods inherited from interface org.eclipse.jpt.jpa.core.resource.java.DbGeneratorAnnotation

getAllocationSize, getAllocationSizeTextRange, getInitialValue, getInitialValueTextRange, setAllocationSize, setInitialValue

Methods inherited from interface org.eclipse.jpt.jpa.core.resource.java.GeneratorAnnotation

getName, getNameTextRange, setName

Methods inherited from interface org.eclipse.jpt.common.core.resource.java.Annotation

getAnnotationName, getAstAnnotation, initialize, initialize, isUnset, newAnnotation, removeAnnotation, synchronizeWith, synchronizeWith

Methods inherited from interface org.eclipse.jpt.common.core.resource.java.JavaResourceNode

getFile, getJavaResourceCompilationUnit, getParent, getRoot, getTextRange

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

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

Field Detail

ANNOTATION_NAME

static final String ANNOTATION_NAME

See Also:

Constant Field Values

TABLE_PROPERTY

static final String TABLE_PROPERTY

See Also:

Constant Field Values

SCHEMA_PROPERTY

static final String SCHEMA_PROPERTY

See Also:

Constant Field Values

CATALOG_PROPERTY

static final String CATALOG_PROPERTY

See Also:

Constant Field Values

PK_COLUMN_NAME_PROPERTY

static final String PK_COLUMN_NAME_PROPERTY

See Also:

Constant Field Values

VALUE_COLUMN_NAME_PROPERTY

static final String VALUE_COLUMN_NAME_PROPERTY

See Also:

Constant Field Values

PK_COLUMN_VALUE_PROPERTY

static final String 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

getTable

String getTable()

Corresponds to the 'table' element of the TableGenerator annotation. Return null if the element does not exist in Java.

setTable

void setTable(String table)

Corresponds to the 'table' element of the TableGenerator annotation. Set to null to remove the element.

getTableTextRange

TextRange getTableTextRange()

Return the TextRange for the 'table' element. If the element does not exist return the TextRange for the TableGenerator annotation.

tableTouches

boolean tableTouches(int pos)

Return whether the specified position touches the 'table' element. Return false if the element does not exist.

getSchema

String getSchema()

Corresponds to the 'schema' element of the TableGenerator annotation. Return null if the element does not exist in Java.

setSchema

void setSchema(String schema)

Corresponds to the 'schema' element of the TableGenerator annotation. Set to null to remove the element.

getSchemaTextRange

TextRange getSchemaTextRange()

Return the TextRange for the 'schema' element. If the element does not exist return the TextRange for the TableGenerator annotation.

schemaTouches

boolean schemaTouches(int pos)

Return whether the specified position touches the 'schema' element. Return false if the element does not exist.

getCatalog

String getCatalog()

Corresponds to the 'catalog' element of the TableGenerator annotation. Return null if the element does not exist in Java.

setCatalog

void setCatalog(String catalog)

Corresponds to the 'catalog' element of the TableGenerator annotation. Set to null to remove the element.

getCatalogTextRange

TextRange getCatalogTextRange()

Return the TextRange for the 'catalog' element. If the element does not exist return the TextRange for the TableGenerator annotation.

catalogTouches

boolean catalogTouches(int pos)

Return whether the specified position touches the 'catalog' element. Return false if the element does not exist.

getPkColumnName

String getPkColumnName()

Corresponds to the 'pkColumnName' element of the TableGenerator annotation. Return null if the element does not exist in Java.

setPkColumnName

void setPkColumnName(String pkColumnName)

Corresponds to the 'pkColumnName' element of the TableGenerator annotation. Set to null to remove the element.

getPkColumnNameTextRange

TextRange getPkColumnNameTextRange()

Return the TextRange for the 'pkColumnName' element. If the element does not exist return the TextRange for the TableGenerator annotation.

pkColumnNameTouches

boolean pkColumnNameTouches(int pos)

Return whether the specified position touches the 'pkColumnName' element. Return false if the element does not exist.

getValueColumnName

String getValueColumnName()

Corresponds to the 'valueColumnName' element of the TableGenerator annotation. Return null if the element does not exist in Java.

setValueColumnName

void setValueColumnName(String valueColumnName)

Corresponds to the 'valueColumnName' element of the TableGenerator annotation. Set to null to remove the element.

getValueColumnNameTextRange

TextRange getValueColumnNameTextRange()

Return the TextRange for the 'valueColumnName' element. If the element does not exist return the TextRange for the TableGenerator annotation.

valueColumnNameTouches

boolean valueColumnNameTouches(int pos)

Return whether the specified position touches the 'valueColumnName' element. Return false if the element does not exist.

getPkColumnValue

String getPkColumnValue()

Corresponds to the 'pkColumnValue' element of the TableGenerator annotation. Return null if the element does not exist in Java.

setPkColumnValue

void setPkColumnValue(String pkColumnValue)

Corresponds to the 'pkColumnValue' element of the TableGenerator annotation. Set to null to remove the element.

getPkColumnValueTextRange

TextRange getPkColumnValueTextRange()

Return the TextRange for the 'pkColumnValue' element. If the element does not exist return the TextRange for the TableGenerator annotation.

pkColumnValueTouches

boolean pkColumnValueTouches(int pos)

Return whether the specified position touches the 'pkColumnValue' element. Return false if the element does not exist.

getUniqueConstraints

org.eclipse.jpt.common.utility.iterable.ListIterable<UniqueConstraintAnnotation> getUniqueConstraints()

Corresponds to the 'uniqueConstraints' element of the TableGenerator annotation. Return null if the element does not exist in Java.

getUniqueConstraintsSize

int getUniqueConstraintsSize()

Corresponds to the 'uniqueConstraints' element of the TableGenerator annotation.

uniqueConstraintAt

UniqueConstraintAnnotation uniqueConstraintAt(int index)

Corresponds to the 'uniqueConstraints' element of the TableGenerator annotation.

addUniqueConstraint

UniqueConstraintAnnotation addUniqueConstraint(int index)

Corresponds to the 'uniqueConstraints' element of the TableGenerator annotation.

moveUniqueConstraint

void moveUniqueConstraint(int targetIndex,
                          int sourceIndex)

Corresponds to the 'uniqueConstraints' element of the TableGenerator annotation.

removeUniqueConstraint

void removeUniqueConstraint(int index)

Corresponds to the 'uniqueConstraints' element of the TableGenerator annotation.