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

All Superinterfaces:

Annotation, GeneratorAnnotation, JavaResourceNode, Model

public interface TableGeneratorAnnotation
extends GeneratorAnnotation

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

Version:

2.1

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.resource.java.JavaResourceNode

JavaResourceNode.Root

Field Summary

static java.lang.String	ANNOTATION_NAME
static java.lang.String	CATALOG_PROPERTY
static java.lang.String	PK_COLUMN_NAME_PROPERTY
static java.lang.String	PK_COLUMN_VALUE_PROPERTY
static java.lang.String	SCHEMA_PROPERTY
static java.lang.String	TABLE_PROPERTY
static java.lang.String	UNIQUE_CONSTRAINTS_LIST
static java.lang.String	VALUE_COLUMN_NAME_PROPERTY

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

ALLOCATION_SIZE_PROPERTY, INITIAL_VALUE_PROPERTY, NAME_PROPERTY

Method Summary

UniqueConstraintAnnotation	addUniqueConstraint(int index) Corresponds to the 'uniqueConstraints' element of the TableGenerator annotation.
boolean	catalogTouches(int pos, org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return whether the specified position touches the 'catalog' element.
java.lang.String	getCatalog() Corresponds to the 'catalog' element of the TableGenerator annotation.
TextRange	getCatalogTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'catalog' element.
java.lang.String	getPkColumnName() Corresponds to the 'pkColumnName' element of the TableGenerator annotation.
TextRange	getPkColumnNameTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'pkColumnName' element.
java.lang.String	getPkColumnValue() Corresponds to the 'pkColumnValue' element of the TableGenerator annotation.
TextRange	getPkColumnValueTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'pkColumnValue' element.
java.lang.String	getSchema() Corresponds to the 'schema' element of the TableGenerator annotation.
TextRange	getSchemaTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'schema' element.
java.lang.String	getTable() Corresponds to the 'table' element of the TableGenerator annotation.
TextRange	getTableTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'table' element.
java.lang.String	getValueColumnName() Corresponds to the 'valueColumnName' element of the TableGenerator annotation.
TextRange	getValueColumnNameTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'valueColumnName' element.
int	indexOfUniqueConstraint(UniqueConstraintAnnotation uniqueConstraint) Corresponds to the 'uniqueConstraints' element of the TableGenerator annotation.
void	moveUniqueConstraint(int targetIndex, int sourceIndex) Corresponds to the 'uniqueConstraints' element of the TableGenerator annotation.
boolean	pkColumnNameTouches(int pos, org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return whether the specified position touches the 'pkColumnName' element.
boolean	pkColumnValueTouches(int pos, org.eclipse.jdt.core.dom.CompilationUnit astRoot) 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, org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return whether the specified position touches the 'schema' element.
void	setCatalog(java.lang.String catalog) Corresponds to the 'catalog' element of the TableGenerator annotation.
void	setPkColumnName(java.lang.String pkColumnName) Corresponds to the 'pkColumnName' element of the TableGenerator annotation.
void	setPkColumnValue(java.lang.String pkColumnValue) Corresponds to the 'pkColumnValue' element of the TableGenerator annotation.
void	setSchema(java.lang.String schema) Corresponds to the 'schema' element of the TableGenerator annotation.
void	setTable(java.lang.String table) Corresponds to the 'table' element of the TableGenerator annotation.
void	setValueColumnName(java.lang.String valueColumnName) Corresponds to the 'valueColumnName' element of the TableGenerator annotation.
boolean	tableTouches(int pos, org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return whether the specified position touches the 'table' element.
UniqueConstraintAnnotation	uniqueConstraintAt(int index) Corresponds to the 'uniqueConstraints' element of the TableGenerator annotation.
java.util.ListIterator<UniqueConstraintAnnotation>	uniqueConstraints() Corresponds to the 'uniqueConstraints' element of the TableGenerator annotation.
int	uniqueConstraintsSize() Corresponds to the 'uniqueConstraints' element of the TableGenerator annotation.
boolean	valueColumnNameTouches(int pos, org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return whether the specified position touches the 'valueColumnName' element.

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

getAllocationSize, getAllocationSizeTextRange, getInitialValue, getInitialValueTextRange, getName, getNameTextRange, setAllocationSize, setInitialValue, setName

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

getAnnotationName, getAstAnnotation, isUnset, newAnnotation, removeAnnotation, restoreFrom, storeOn

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

getFile, getJavaResourceCompilationUnit, getParent, getRoot, getTextRange, initialize, synchronizeWith

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

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

Field Detail

ANNOTATION_NAME

static final java.lang.String ANNOTATION_NAME

See Also:

Constant Field Values

TABLE_PROPERTY

static final java.lang.String TABLE_PROPERTY

See Also:

Constant Field Values

SCHEMA_PROPERTY

static final java.lang.String SCHEMA_PROPERTY

See Also:

Constant Field Values

CATALOG_PROPERTY

static final java.lang.String CATALOG_PROPERTY

See Also:

Constant Field Values

PK_COLUMN_NAME_PROPERTY

static final java.lang.String PK_COLUMN_NAME_PROPERTY

See Also:

Constant Field Values

VALUE_COLUMN_NAME_PROPERTY

static final java.lang.String VALUE_COLUMN_NAME_PROPERTY

See Also:

Constant Field Values

PK_COLUMN_VALUE_PROPERTY

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

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

setTable

void setTable(java.lang.String table)

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

getTableTextRange

TextRange getTableTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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,
                     org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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

getSchema

java.lang.String getSchema()

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

setSchema

void setSchema(java.lang.String schema)

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

getSchemaTextRange

TextRange getSchemaTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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,
                      org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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

getCatalog

java.lang.String getCatalog()

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

setCatalog

void setCatalog(java.lang.String catalog)

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

getCatalogTextRange

TextRange getCatalogTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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,
                       org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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

getPkColumnName

java.lang.String getPkColumnName()

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

setPkColumnName

void setPkColumnName(java.lang.String pkColumnName)

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

getPkColumnNameTextRange

TextRange getPkColumnNameTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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,
                            org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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

getValueColumnName

java.lang.String getValueColumnName()

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

setValueColumnName

void setValueColumnName(java.lang.String valueColumnName)

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

getValueColumnNameTextRange

TextRange getValueColumnNameTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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,
                               org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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

getPkColumnValue

java.lang.String getPkColumnValue()

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

setPkColumnValue

void setPkColumnValue(java.lang.String pkColumnValue)

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

getPkColumnValueTextRange

TextRange getPkColumnValueTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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,
                             org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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

uniqueConstraints

java.util.ListIterator<UniqueConstraintAnnotation> uniqueConstraints()

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

uniqueConstraintsSize

int uniqueConstraintsSize()

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

uniqueConstraintAt

UniqueConstraintAnnotation uniqueConstraintAt(int index)

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

indexOfUniqueConstraint

int indexOfUniqueConstraint(UniqueConstraintAnnotation uniqueConstraint)

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.