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

All Superinterfaces:

Annotation, JavaResourceNode, Model, NamedColumnAnnotation

All Known Subinterfaces:

BaseJoinColumnAnnotation, ColumnAnnotation, CompleteColumnAnnotation, JoinColumnAnnotation, MapKeyColumn2_0Annotation, MapKeyJoinColumn2_0Annotation, NestableJoinColumnAnnotation, NestableMapKeyJoinColumnAnnotation

public interface BaseColumnAnnotation
extends NamedColumnAnnotation

Corresponds to the JPA annotations:

• javax.persistence.Column
• javax.persistence.MapKeyColumn
• javax.persistence.JoinColumn
• javax.persistence.MapKeyJoinColumn

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

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	INSERTABLE_PROPERTY
static java.lang.String	NULLABLE_PROPERTY
static java.lang.String	TABLE_PROPERTY
static java.lang.String	UNIQUE_PROPERTY
static java.lang.String	UPDATABLE_PROPERTY

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

COLUMN_DEFINITION_PROPERTY, NAME_PROPERTY

Method Summary

java.lang.Boolean	getInsertable() Corresponds to the 'insertable' element of the *Column annotation.
TextRange	getInsertableTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'insertable' element.
java.lang.Boolean	getNullable() Corresponds to the 'nullable' element of the *Column annotation.
TextRange	getNullableTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'nullable' element.
java.lang.String	getTable() Corresponds to the 'table' element of the *Column annotation.
TextRange	getTableTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'table' element.
java.lang.Boolean	getUnique() Corresponds to the 'unique' element of the *Column annotation.
TextRange	getUniqueTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'unique' element.
java.lang.Boolean	getUpdatable() Corresponds to the 'updatable' element of the *Column annotation.
TextRange	getUpdatableTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'updatable' element.
void	setInsertable(java.lang.Boolean insertable) Corresponds to the 'insertable' element of the *Column annotation.
void	setNullable(java.lang.Boolean nullable) Corresponds to the 'nullable' element of the *Column annotation.
void	setTable(java.lang.String table) Corresponds to the 'table' element of the *Column annotation.
void	setUnique(java.lang.Boolean unique) Corresponds to the 'unique' element of the *Column annotation.
void	setUpdatable(java.lang.Boolean updatable) Corresponds to the 'updatable' element of the *Column annotation.
boolean	tableTouches(int pos, org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return whether the specified position touches the 'table' element.

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

getColumnDefinition, getColumnDefinitionTextRange, getName, getNameTextRange, isSpecified, nameTouches, setColumnDefinition, 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

UNIQUE_PROPERTY

static final java.lang.String UNIQUE_PROPERTY

See Also:

Constant Field Values

NULLABLE_PROPERTY

static final java.lang.String NULLABLE_PROPERTY

See Also:

Constant Field Values

INSERTABLE_PROPERTY

static final java.lang.String INSERTABLE_PROPERTY

See Also:

Constant Field Values

UPDATABLE_PROPERTY

static final java.lang.String UPDATABLE_PROPERTY

See Also:

Constant Field Values

TABLE_PROPERTY

static final java.lang.String TABLE_PROPERTY

See Also:

Constant Field Values

Method Detail

getUnique

java.lang.Boolean getUnique()

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

setUnique

void setUnique(java.lang.Boolean unique)

Corresponds to the 'unique' element of the *Column annotation. Set to null to remove the element.

getUniqueTextRange

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

Return the TextRange for the 'unique' element. If the element does not exist return the TextRange for the *Column annotation.

getNullable

java.lang.Boolean getNullable()

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

setNullable

void setNullable(java.lang.Boolean nullable)

Corresponds to the 'nullable' element of the *Column annotation. Set to null to remove the element.

getNullableTextRange

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

Return the TextRange for the 'nullable' element. If the element does not exist return the TextRange for the *Column annotation.

getInsertable

java.lang.Boolean getInsertable()

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

setInsertable

void setInsertable(java.lang.Boolean insertable)

Corresponds to the 'insertable' element of the *Column annotation. Set to null to remove the element.

getInsertableTextRange

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

Return the TextRange for the 'insertable' element. If the element does not exist return the TextRange for the *Column annotation.

getUpdatable

java.lang.Boolean getUpdatable()

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

setUpdatable

void setUpdatable(java.lang.Boolean updatable)

Corresponds to the 'updatable' element of the *Column annotation. Set to null to remove the element.

getUpdatableTextRange

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

Return the TextRange for the 'updatable' element. If the element does not exist return the TextRange for the *Column annotation.

getTable

java.lang.String getTable()

Corresponds to the 'table' element of the *Column 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 *Column 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 *Column 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.