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

All Superinterfaces:

Annotation, JavaResourceNode, Model, NamedColumnAnnotation

All Known Subinterfaces:

NestablePrimaryKeyJoinColumnAnnotation

public interface PrimaryKeyJoinColumnAnnotation
extends NamedColumnAnnotation

Corresponds to the JPA annotation javax.persistence.PrimaryKeyJoinColumn

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	ANNOTATION_NAME
static java.lang.String	REFERENCED_COLUMN_NAME_PROPERTY

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

COLUMN_DEFINITION_PROPERTY, NAME_PROPERTY

Method Summary

java.lang.String	getReferencedColumnName() Corresponds to the 'referencedColumnName' element of the PrimaryKeyJoinColumn 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 PrimaryKeyJoinColumn annotation.

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

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 PrimaryKeyJoinColumn 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 PrimaryKeyJoinColumn annotation. Set the to null to remove the element.

getReferencedColumnNameTextRange

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

Return the TextRange for the 'referencedColumnName' element. If the element does not exist return the TextRange for the PrimaryKeyJoinColumn 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.