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

All Superinterfaces:

Annotation, JavaResourceNode, Model

All Known Subinterfaces:

CollectionTable2_0Annotation, JoinTableAnnotation, ReferenceTableAnnotation, SecondaryTableAnnotation, TableAnnotation

public interface BaseTableAnnotation
extends Annotation

Corresponds to the JPA annotations:

• javax.persistence.Table
• javax.persistence.JoinTable
• javax.persistence.SecondaryTable
• javax.persistence.CollectionTable

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.2

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	CATALOG_PROPERTY
static String	NAME_PROPERTY
static String	SCHEMA_PROPERTY
static String	UNIQUE_CONSTRAINTS_LIST

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 *Table annotation.
boolean	catalogTouches(int pos) Return whether the specified position touches the 'catalog' element.
boolean	catalogValidationTouches(int pos)
String	getCatalog() Corresponds to the 'catalog' element of the *Table annotation.
TextRange	getCatalogTextRange() Return the TextRange for the 'catalog' element.
TextRange	getCatalogValidationTextRange()
String	getName() Corresponds to the 'name' element of the *Table annotation.
TextRange	getNameTextRange() Return the TextRange for the 'name' element.
TextRange	getNameValidationTextRange()
String	getSchema() Corresponds to the 'schema' element of the *Table annotation.
TextRange	getSchemaTextRange() Return the TextRange for the 'schema' element.
TextRange	getSchemaValidationTextRange()
org.eclipse.jpt.common.utility.iterable.ListIterable<UniqueConstraintAnnotation>	getUniqueConstraints() Corresponds to the 'uniqueConstraints' element of the *Table annotation.
int	getUniqueConstraintsSize() Corresponds to the 'uniqueConstraints' element of the *Table annotation.
boolean	isSpecified() Return whether the annotation exists in Java.
void	moveUniqueConstraint(int targetIndex, int sourceIndex) Corresponds to the 'uniqueConstraints' element of the *Table annotation.
boolean	nameTouches(int pos) Return whether the specified position touches the 'name' element.
boolean	nameValidationTouches(int pos)
void	removeUniqueConstraint(int index) Corresponds to the 'uniqueConstraints' element of the *Table annotation.
boolean	schemaTouches(int pos) Return whether the specified position touches the 'schema' element.
boolean	schemaValidationTouches(int pos)
void	setCatalog(String catalog) Corresponds to the 'catalog' element of the *Table annotation.
void	setName(String name) Corresponds to the 'name' element of the *Table annotation.
void	setSchema(String schema) Corresponds to the 'schema' element of the *Table annotation.
UniqueConstraintAnnotation	uniqueConstraintAt(int index) Corresponds to the 'uniqueConstraints' element of the *Table annotation.

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

NAME_PROPERTY

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

UNIQUE_CONSTRAINTS_LIST

static final String UNIQUE_CONSTRAINTS_LIST

See Also:

Constant Field Values

Method Detail

isSpecified

boolean isSpecified()

Return whether the annotation exists in Java.

getName

String getName()

Corresponds to the 'name' element of the *Table annotation. Return null if the element does not exist in Java.

setName

void setName(String name)

Corresponds to the 'name' element of the *Table annotation. Set to null to remove the element.

getNameTextRange

TextRange getNameTextRange()

Return the TextRange for the 'name' element. If the element does not exist return the TextRange for the *Table annotation.

nameTouches

boolean nameTouches(int pos)

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

getNameValidationTextRange

TextRange getNameValidationTextRange()

nameValidationTouches

boolean nameValidationTouches(int pos)

getSchema

String getSchema()

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

setSchema

void setSchema(String schema)

Corresponds to the 'schema' element of the *Table 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 *Table annotation.

schemaTouches

boolean schemaTouches(int pos)

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

getSchemaValidationTextRange

TextRange getSchemaValidationTextRange()

schemaValidationTouches

boolean schemaValidationTouches(int pos)

getCatalog

String getCatalog()

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

setCatalog

void setCatalog(String catalog)

Corresponds to the 'catalog' element of the *Table 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 *Table annotation.

catalogTouches

boolean catalogTouches(int pos)

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

getCatalogValidationTextRange

TextRange getCatalogValidationTextRange()

catalogValidationTouches

boolean catalogValidationTouches(int pos)

getUniqueConstraints

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

Corresponds to the 'uniqueConstraints' element of the *Table annotation. Return an empty iterator if the element does not exist in Java.

getUniqueConstraintsSize

int getUniqueConstraintsSize()

Corresponds to the 'uniqueConstraints' element of the *Table annotation.

uniqueConstraintAt

UniqueConstraintAnnotation uniqueConstraintAt(int index)

Corresponds to the 'uniqueConstraints' element of the *Table annotation.

addUniqueConstraint

UniqueConstraintAnnotation addUniqueConstraint(int index)

Corresponds to the 'uniqueConstraints' element of the *Table annotation.

moveUniqueConstraint

void moveUniqueConstraint(int targetIndex,
                          int sourceIndex)

Corresponds to the 'uniqueConstraints' element of the *Table annotation.

removeUniqueConstraint

void removeUniqueConstraint(int index)

Corresponds to the 'uniqueConstraints' element of the *Table annotation.