org.eclipse.jpt.jpa.core.jpa2.resource.java
Interface ElementCollectionAnnotation2_0

All Superinterfaces:

Annotation, JavaResourceModel, Model

public interface ElementCollectionAnnotation2_0
extends Annotation

Corresponds to the JPA 2.0 annotation javax.persistence.ElementCollection

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

Nested Class Summary

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

JavaResourceModel.FileTransformer, JavaResourceModel.Root

Field Summary

static String	ANNOTATION_NAME
static String	FETCH_PROPERTY
static String	TARGET_CLASS_PROPERTY

Fields inherited from interface org.eclipse.jpt.common.core.resource.java.JavaResourceModel

FILE_TRANSFORMER

Method Summary

FetchType	getFetch() Corresponds to the 'fetch' element of the element collection annotation.
TextRange	getFetchTextRange() Return the TextRange for the 'fetch' element.
String	getFullyQualifiedTargetClassName() Return the fully-qualified target class name as resolved by the AST's bindings.
String	getTargetClass() Corresponds to the 'targetClass' element of the element collection annotation.
TextRange	getTargetClassTextRange() Return the TextRange for the 'targetClass' element.
void	setFetch(FetchType fetch) Corresponds to the 'fetch' element of the element collection annotation.
void	setTargetClass(String targetClass) Corresponds to the 'targetClass' element of the element collection 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.JavaResourceModel

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

ANNOTATION_NAME

static final String ANNOTATION_NAME

See Also:

Constant Field Values

TARGET_CLASS_PROPERTY

static final String TARGET_CLASS_PROPERTY

See Also:

Constant Field Values

FETCH_PROPERTY

static final String FETCH_PROPERTY

See Also:

Constant Field Values

Method Detail

getTargetClass

String getTargetClass()

Corresponds to the 'targetClass' element of the element collection annotation. Return null if the element does not exist in Java. Return the portion of the value preceding ".class".

     @ElementCollection(targetClass=Employee.class)
 

will return "Employee"

setTargetClass

void setTargetClass(String targetClass)

Corresponds to the 'targetClass' element of the element collection annotation. Set to null to remove the element.

getTargetClassTextRange

TextRange getTargetClassTextRange()

Return the TextRange for the 'targetClass' element. If the element does not exist return the TextRange for the element collection annotation.

getFullyQualifiedTargetClassName

String getFullyQualifiedTargetClassName()

Return the fully-qualified target class name as resolved by the AST's bindings.

     @ElementCollection(targetClass=Employee.class)
 

will return "model.Employee" if there is an import for model.Employee.

getFetch

FetchType getFetch()

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

setFetch

void setFetch(FetchType fetch)

Corresponds to the 'fetch' element of the element collection annotation. Set to null to remove the element.

getFetchTextRange

TextRange getFetchTextRange()

Return the TextRange for the 'fetch' element. If the element does not exist return the TextRange for the element collection annotation.