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

All Superinterfaces:
JavaResourceNode, Model
All Known Subinterfaces:
JoinTableAnnotation, NestableSecondaryTable, SecondaryTableAnnotation

public interface TableAnnotation
extends JavaResourceNode

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 NAME_PROPERTY
           
static java.lang.String SCHEMA_PROPERTY
           
static java.lang.String UNIQUE_CONSTRAINTS_LIST
           
 
Method Summary
 UniqueConstraintAnnotation addUniqueConstraint(int index)
           
 boolean catalogTouches(int pos, org.eclipse.jdt.core.dom.CompilationUnit astRoot)
          Return whether the specified postition touches the catalog element.
 java.lang.String getCatalog()
           
 TextRange getCatalogTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
          Return the TextRange for the catalog element.
 java.lang.String getName()
           
 TextRange getNameTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
          Return the TextRange for the name element.
 java.lang.String getSchema()
           
 TextRange getSchemaTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
          Return the TextRange for the schema element.
 int indexOfUniqueConstraint(UniqueConstraintAnnotation uniqueConstraint)
           
 void moveUniqueConstraint(int targetIndex, int sourceIndex)
           
 boolean nameTouches(int pos, org.eclipse.jdt.core.dom.CompilationUnit astRoot)
          Return whether the specified postition touches the name element.
 void removeUniqueConstraint(int index)
           
 boolean schemaTouches(int pos, org.eclipse.jdt.core.dom.CompilationUnit astRoot)
          Return whether the specified postition touches the schema element.
 void setCatalog(java.lang.String catalog)
           
 void setName(java.lang.String name)
           
 void setSchema(java.lang.String schema)
           
 UniqueConstraintAnnotation uniqueConstraintAt(int index)
           
 java.util.ListIterator<UniqueConstraintAnnotation> uniqueConstraints()
           
 int uniqueConstraintsSize()
           
 
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

NAME_PROPERTY

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

UNIQUE_CONSTRAINTS_LIST

static final java.lang.String UNIQUE_CONSTRAINTS_LIST
See Also:
Constant Field Values
Method Detail

getName

java.lang.String getName()

setName

void setName(java.lang.String name)

getCatalog

java.lang.String getCatalog()

setCatalog

void setCatalog(java.lang.String catalog)

getSchema

java.lang.String getSchema()

setSchema

void setSchema(java.lang.String schema)

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)

getNameTextRange

TextRange getNameTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return the TextRange for the name element. If the name element does not exist return the TextRange for the *Table 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 *Table 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 *Table annotation.


nameTouches

boolean nameTouches(int pos,
                    org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return whether the specified postition touches the name element. Return false if the name element does not exist.


schemaTouches

boolean schemaTouches(int pos,
                      org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return whether the specified postition touches the schema element. Return false if the name element does not exist.


catalogTouches

boolean catalogTouches(int pos,
                       org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return whether the specified postition touches the catalog element. Return false if the name element does not exist.