org.apache.openejb.jee.jpa

Class NamedNativeQuery

java.lang.Object

org.apache.openejb.jee.jpa.NamedNativeQuery

public class NamedNativeQuery
extends Object

Target({TYPE}) @Retention(RUNTIME) public @interface NamedNativeQuery { String name(); String query(); QueryHint[] hints() default {}; Class resultClass() default void.class; String resultSetMapping() default ""; //named SqlResultSetMapping }

Java class for named-native-query complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="named-native-query">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="description" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="query" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="hint" type="{http://java.sun.com/xml/ns/persistence/orm}query-hint" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="result-class" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="result-set-mapping" type="{http://www.w3.org/2001/XMLSchema}string" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description
protected List<QueryHint>	hint
protected String	name
protected String	query
protected String	resultClass
protected String	resultSetMapping

Constructor Summary

Constructors

Constructor and Description
NamedNativeQuery()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Gets the value of the description property.
List<QueryHint>	getHint() Gets the value of the hint property.
String	getName() Gets the value of the name property.
String	getQuery() Gets the value of the query property.
String	getResultClass() Gets the value of the resultClass property.
String	getResultSetMapping() Gets the value of the resultSetMapping property.
void	setDescription(String value) Sets the value of the description property.
void	setName(String value) Sets the value of the name property.
void	setQuery(String value) Sets the value of the query property.
void	setResultClass(String value) Sets the value of the resultClass property.
void	setResultSetMapping(String value) Sets the value of the resultSetMapping property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

description

protected String description

query

protected String query

hint

protected List<QueryHint> hint

name

protected String name

resultClass

protected String resultClass

resultSetMapping

protected String resultSetMapping

Constructor Detail

NamedNativeQuery

public NamedNativeQuery()

Method Detail

getDescription

public String getDescription()

Gets the value of the description property.

Returns:

possible object is String

setDescription

public void setDescription(String value)

Sets the value of the description property.

Parameters:

value - allowed object is String

getQuery

public String getQuery()

Gets the value of the query property.

Returns:

possible object is String

setQuery

public void setQuery(String value)

Sets the value of the query property.

Parameters:

value - allowed object is String

getHint

public List<QueryHint> getHint()

Gets the value of the hint property. This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the hint property. For example, to add a new item, do as follows:

    getHint().add(newItem);
 

Objects of the following type(s) are allowed in the list QueryHint

getName

public String getName()

Gets the value of the name property.

Returns:

possible object is String

setName

public void setName(String value)

Sets the value of the name property.

Parameters:

value - allowed object is String

getResultClass

public String getResultClass()

Gets the value of the resultClass property.

Returns:

possible object is String

setResultClass

public void setResultClass(String value)

Sets the value of the resultClass property.

Parameters:

value - allowed object is String

getResultSetMapping

public String getResultSetMapping()

Gets the value of the resultSetMapping property.

Returns:

possible object is String

setResultSetMapping

public void setResultSetMapping(String value)

Sets the value of the resultSetMapping property.

Parameters:

value - allowed object is String