org.hibernate.jpamodelgen.xml.jaxb

Class NamedQuery

java.lang.Object

org.hibernate.jpamodelgen.xml.jaxb.NamedQuery

public class NamedQuery
extends Object

@Target({TYPE}) @Retention(RUNTIME) public @interface NamedQuery { String name(); String query(); LockModeType lockMode() default NONE; QueryHint[] hints() default {}; }

<p>Java class for named-query complex type.

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

<pre> <complexType name="named-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="lock-mode" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}lock-mode-type" minOccurs="0"/> <element name="hint" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}query-hint" maxOccurs="unbounded" minOccurs="0"/> </sequence> <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" /> </restriction> </complexContent> </complexType> </pre>

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description
protected List<QueryHint>	hint
protected LockModeType	lockMode
protected String	name
protected String	query

Constructor Summary

Constructors

Constructor and Description
NamedQuery()

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.
LockModeType	getLockMode() Gets the value of the lockMode property.
String	getName() Gets the value of the name property.
String	getQuery() Gets the value of the query property.
void	setDescription(String value) Sets the value of the description property.
void	setLockMode(LockModeType value) Sets the value of the lockMode property.
void	setName(String value) Sets the value of the name property.
void	setQuery(String value) Sets the value of the query 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

lockMode

protected LockModeType lockMode

hint

protected List<QueryHint> hint

name

protected String name

Constructor Detail

NamedQuery

public NamedQuery()

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

getLockMode

public LockModeType getLockMode()

Gets the value of the lockMode property.

Returns:

possible object is LockModeType

setLockMode

public void setLockMode(LockModeType value)

Sets the value of the lockMode property.

Parameters:

value - allowed object is LockModeType

getHint

public List<QueryHint> getHint()

Gets the value of the hint property.

<p> 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 <CODE>set</CODE> method for the hint property.

<p> For example, to add a new item, do as follows: <pre> getHint().add(newItem); </pre>

<p> 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