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

All Superinterfaces:

Annotation, JavaResourceNode, Model, QueryAnnotation

All Known Subinterfaces:

NestableNamedNativeQueryAnnotation

public interface NamedNativeQueryAnnotation
extends QueryAnnotation

Corresponds to the JPA annotation javax.persistence.NamedNativeQuery

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	RESULT_CLASS_PROPERTY
static java.lang.String	RESULT_SET_MAPPING_PROPERTY

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

HINTS_LIST, NAME_PROPERTY, QUERY_PROPERTY

Method Summary

java.lang.String	getFullyQualifiedResultClassName() Return the named native query's fully-qualified result class name as resolved by the AST's bindings.
java.lang.String	getResultClass() Corresponds to the 'resultClass' element of the NamedNativeQuery annotation.
TextRange	getResultClassTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'resultClass' element.
java.lang.String	getResultSetMapping() Corresponds to the 'resultSetMapping' element of the NamedNativeQuery annotation.
TextRange	getResultSetMappingTextRange(org.eclipse.jdt.core.dom.CompilationUnit astRoot) Return the TextRange for the 'resultSetMapping' element.
void	setResultClass(java.lang.String resultClass) Corresponds to the 'resultClass' element of the NamedNativeQuery annotation.
void	setResultSetMapping(java.lang.String resultSetMapping) Corresponds to the 'resultSetMapping' element of the NamedNativeQuery annotation.

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

addHint, getName, getNameTextRange, getQuery, getQueryTextRange, hintAt, hints, hintsSize, indexOfHint, moveHint, removeHint, setName, setQuery

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

RESULT_CLASS_PROPERTY

static final java.lang.String RESULT_CLASS_PROPERTY

See Also:

Constant Field Values

RESULT_SET_MAPPING_PROPERTY

static final java.lang.String RESULT_SET_MAPPING_PROPERTY

See Also:

Constant Field Values

Method Detail

getResultClass

java.lang.String getResultClass()

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

setResultClass

void setResultClass(java.lang.String resultClass)

Corresponds to the 'resultClass' element of the NamedNativeQuery annotation. Set to null to remove the element.

getResultClassTextRange

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

Return the TextRange for the 'resultClass' element. If element does not exist return the TextRange for the NamedNativeQuery annotation.

getFullyQualifiedResultClassName

java.lang.String getFullyQualifiedResultClassName()

Return the named native query's fully-qualified result class name as resolved by the AST's bindings.

     @NamedNativeQuery(resultClass=Employee.class)
 

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

getResultSetMapping

java.lang.String getResultSetMapping()

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

setResultSetMapping

void setResultSetMapping(java.lang.String resultSetMapping)

Corresponds to the 'resultSetMapping' element of the NamedNativeQuery annotation. Set to null to remove the element.

getResultSetMappingTextRange

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

Return the TextRange for the 'resultSetMapping' element. If element does not exist return the TextRange for the NamedNativeQuery annotation.