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

All Superinterfaces:
GeneratorAnnotation, JavaResourceNode, Model

public interface TableGeneratorAnnotation
extends GeneratorAnnotation

Corresponds to the javax.persistence.TableGenerator annotation 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 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.core.resource.java.GeneratorAnnotation
ALLOCATION_SIZE_PROPERTY, INITIAL_VALUE_PROPERTY, NAME_PROPERTY
 
Method Summary
 UniqueConstraintAnnotation addUniqueConstraint(int index)
           
 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)
           
 void moveUniqueConstraint(int targetIndex, int sourceIndex)
           
 void removeUniqueConstraint(int index)
           
 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.
 UniqueConstraintAnnotation uniqueConstraintAt(int index)
           
 java.util.ListIterator<UniqueConstraintAnnotation> uniqueConstraints()
           
 int uniqueConstraintsSize()
           
 
Methods inherited from interface org.eclipse.jpt.core.resource.java.GeneratorAnnotation
getAllocationSize, getAllocationSizeTextRange, getInitialValue, getInitialValueTextRange, getName, getNameTextRange, setAllocationSize, setInitialValue, setName
 
Methods inherited from interface org.eclipse.jpt.core.resource.java.JavaResourceNode
getJpaCompilationUnit, getResourceModel, getTextRange, initialize, updateFromJava
 
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
 

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

CATALOG_PROPERTY

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

SCHEMA_PROPERTY

static final java.lang.String SCHEMA_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. Returns null if the table element does not exist in java. If no other memberValuePairs exist the TableGenerator annotation will be removed as well.


setTable

void setTable(java.lang.String table)
Corresponds to the table element of the TableGenerator annotation. Set to null to remove the table element. If no other memberValuePairs exist the TableGenerator annotation will be removed as well.


getCatalog

java.lang.String getCatalog()
Corresponds to the catalog element of the TableGenerator annotation. Returns null if the catalog element does not exist in java. If no other memberValuePairs exist the TableGenerator annotation will be removed as well.


setCatalog

void setCatalog(java.lang.String catalog)
Corresponds to the catalog element of the TableGenerator annotation. Set to null to remove the catalog element. If no other memberValuePairs exist the TableGenerator annotation will be removed as well.


getSchema

java.lang.String getSchema()
Corresponds to the schema element of the TableGenerator annotation. Returns null if the schema element does not exist in java. If no other memberValuePairs exist the TableGenerator annotation will be removed as well.


setSchema

void setSchema(java.lang.String schema)
Corresponds to the schema element of the TableGenerator annotation. Set to null to remove the schema element. If no other memberValuePairs exist the TableGenerator annotation will be removed as well.


getPkColumnName

java.lang.String getPkColumnName()
Corresponds to the pkColumnName element of the TableGenerator annotation. Returns null if the pkColumnName element does not exist in java. If no other memberValuePairs exist the TableGenerator annotation will be removed as well.


setPkColumnName

void setPkColumnName(java.lang.String pkColumnName)
Corresponds to the pkColumnName element of the TableGenerator annotation. Set to null to remove the pkColumnName element. If no other memberValuePairs exist the TableGenerator annotation will be removed as well.


getValueColumnName

java.lang.String getValueColumnName()
Corresponds to the valueColumnName element of the TableGenerator annotation. Returns null if the valueColumnName element does not exist in java. If no other memberValuePairs exist the TableGenerator annotation will be removed as well.


setValueColumnName

void setValueColumnName(java.lang.String valueColumnName)
Corresponds to the valueColumnName element of the TableGenerator annotation. Set to null to remove the valueColumnName element. If no other memberValuePairs exist the TableGenerator annotation will be removed as well.


getPkColumnValue

java.lang.String getPkColumnValue()
Corresponds to the pkColumnValue element of the TableGenerator annotation. Returns null if the pkColumnValue element does not exist in java. If no other memberValuePairs exist the TableGenerator annotation will be removed as well.


setPkColumnValue

void setPkColumnValue(java.lang.String pkColumnValue)
Corresponds to the pkColumnValue element of the TableGenerator annotation. Set to null to remove the pkColumnValue element. If no other memberValuePairs exist the TableGenerator annotation will be removed as well.


uniqueConstraints

java.util.ListIterator<UniqueConstraintAnnotation> uniqueConstraints()

uniqueConstraintAt

UniqueConstraintAnnotation uniqueConstraintAt(int index)

indexOfUniqueConstraint

int indexOfUniqueConstraint(UniqueConstraintAnnotation uniqueConstraint)

uniqueConstraintsSize

int uniqueConstraintsSize()

addUniqueConstraint

UniqueConstraintAnnotation addUniqueConstraint(int index)

removeUniqueConstraint

void removeUniqueConstraint(int index)

moveUniqueConstraint

void moveUniqueConstraint(int targetIndex,
                          int sourceIndex)

getTableTextRange

TextRange getTableTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return the TextRange for the table element. If the table element does not exist return the TextRange for the TableGenerator annotation.


getCatalogTextRange

TextRange getCatalogTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return the TextRange for the catalog element. If the catalog element does not exist return the TextRange for the TableGenerator annotation.


getSchemaTextRange

TextRange getSchemaTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return the TextRange for the schema element. If the schema element does not exist return the TextRange for the TableGenerator annotation.


getPkColumnNameTextRange

TextRange getPkColumnNameTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return the TextRange for the pkColumnName element. If the pkColumnName element does not exist return the TextRange for the TableGenerator annotation.


getValueColumnNameTextRange

TextRange getValueColumnNameTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return the TextRange for the valueColumnName element. If the valueColumnName element does not exist return the TextRange for the TableGenerator annotation.


getPkColumnValueTextRange

TextRange getPkColumnValueTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return the TextRange for the pkColumnValue element. If the pkColumnValue element does not exist return the TextRange for the TableGenerator annotation.