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

All Superinterfaces:

Annotation, BaseColumnAnnotation, JavaResourceNode, Model, NamedColumnAnnotation

All Known Subinterfaces:

JoinColumnAnnotation, MapKeyJoinColumn2_0Annotation, NestableJoinColumnAnnotation, NestableMapKeyJoinColumnAnnotation

public interface BaseJoinColumnAnnotation
extends BaseColumnAnnotation

Common protocol among 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.3

Version:

2.3

Nested Class Summary

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

JavaResourceNode.Root

Field Summary

static java.lang.String

REFERENCED_COLUMN_NAME_PROPERTY

Fields inherited from interface org.eclipse.jpt.core.resource.java.BaseColumnAnnotation

INSERTABLE_PROPERTY, NULLABLE_PROPERTY, TABLE_PROPERTY, UNIQUE_PROPERTY, UPDATABLE_PROPERTY

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

COLUMN_DEFINITION_PROPERTY, NAME_PROPERTY

Method Summary

java.lang.String	getReferencedColumnName() Corresponds to the 'referencedColumnName' element of the JoinColumn annotation.
TextRange	getReferencedColumnNameTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'referencedColumnName' element.
boolean	referencedColumnNameTouches(int pos, org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return whether the specified position touches the 'referencedColumnName' element.
void	setReferencedColumnName(java.lang.String referencedColumnName) Corresponds to the 'referencedColumnName' element of the JoinColumn annotation.

Methods inherited from interface org.eclipse.jpt.core.resource.java.BaseColumnAnnotation

getInsertable, getInsertableTextRange, getNullable, getNullableTextRange, getTable, getTableTextRange, getUnique, getUniqueTextRange, getUpdatable, getUpdatableTextRange, setInsertable, setNullable, setTable, setUnique, setUpdatable, tableTouches

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

getColumnDefinition, getColumnDefinitionTextRange, getName, getNameTextRange, isSpecified, nameTouches, setColumnDefinition, setName

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

getAnnotationName, getAstAnnotation, newAnnotation, removeAnnotation

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

getFile, getJavaResourceCompilationUnit, getRoot, getTextRange, initialize, synchronizeWith

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

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

Field Detail

REFERENCED_COLUMN_NAME_PROPERTY

static final java.lang.String REFERENCED_COLUMN_NAME_PROPERTY

See Also:

Constant Field Values

Method Detail

getReferencedColumnName

java.lang.String getReferencedColumnName()

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

setReferencedColumnName

void setReferencedColumnName(java.lang.String referencedColumnName)

Corresponds to the 'referencedColumnName' element of the JoinColumn annotation. Set to null to remove the element.

getReferencedColumnNameTextRange

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

Return the TextRange for the 'referencedColumnName' element. If element does not exist return the TextRange for the JoinColumn annotation.

referencedColumnNameTouches

boolean referencedColumnNameTouches(int pos,
                                    org.eclipse.jdt.core.dom.CompilationUnit astRoot)

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