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

All Superinterfaces:

Annotation, JavaResourceModel, Model, NestableAnnotation, QueryAnnotation

All Known Subinterfaces:

NamedQueryAnnotation2_0

public interface NamedQueryAnnotation
extends QueryAnnotation

Corresponds to the JPA annotation javax.persistence.NamedQuery

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

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	QUERY_PROPERTY

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

HINTS_LIST, NAME_PROPERTY

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

FILE_TRANSFORMER

Method Summary

String	getQuery() Corresponds to the 'query' element of the *Query annotation.
List<TextRange>	getQueryTextRanges() Return the TextRange for the 'query' element.
void	setQuery(String query) Corresponds to the 'query' element of the *Query annotation.

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

addHint, getHints, getHintsSize, getName, getNameTextRange, hintAt, moveHint, removeHint, setName

Methods inherited from interface org.eclipse.jpt.common.core.resource.java.NestableAnnotation

moveAnnotation

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

QUERY_PROPERTY

static final String QUERY_PROPERTY

See Also:

Constant Field Values

Method Detail

getQuery

String getQuery()

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

setQuery

void setQuery(String query)

Corresponds to the 'query' element of the *Query annotation. Set to null to remove the element.

getQueryTextRanges

List<TextRange> getQueryTextRanges()

Return the TextRange for the 'query' element. If element does not exist return the TextRange for the *Query annotation.