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

All Superinterfaces:
BaseColumnAnnotation, JavaResourceNode, Model, NamedColumnAnnotation
All Known Subinterfaces:
NestableJoinColumn

public interface JoinColumnAnnotation
extends BaseColumnAnnotation

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 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 javax.persistence.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 postition touches the referencedColumnName element.
 void setReferencedColumnName(java.lang.String referencedColumnName)
          Corresponds to the referencedColumnName element of the javax.persistence.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, nameTouches, setColumnDefinition, 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

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 javax.persistence.JoinColumn annotation. Returns null if the referencedColumnName valuePair does not exist in the annotation


setReferencedColumnName

void setReferencedColumnName(java.lang.String referencedColumnName)
Corresponds to the referencedColumnName element of the javax.persistence.JoinColumn annotation. Set to null to remove the referencedColumnName valuePait from the Annotation


getReferencedColumnNameTextRange

TextRange getReferencedColumnNameTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot)
Return the TextRange for the referencedColumnName element. If the referencedColumnName 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 postition touches the referencedColumnName element. Return false if the referencedColumnName element does not exist.