Top Description Fields Constructors Methods
org.hibernate.boot.jaxb.mapping

public Class JaxbNamedQuery

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Annotations
@XmlAccessorType:FIELD
@XmlType
name:named-query
namespace:http://www.hibernate.org/xsd/orm/mapping
propOrder:description, query, lockMode, hint, comment, timeout, flushMode, cacheable, cacheMode, cacheRegion, fetchSize, readOnly, queryParam
Imports
java.io.Serializable, java.util.ArrayList, .List, jakarta.persistence.LockModeType, jakarta.xml.bind.annotation.XmlAccessType, .XmlAccessorType, .XmlAttribute, .XmlElement, .XmlSchemaType, .XmlType, jakarta.xml.bind.annotation.adapters.XmlJavaTypeAdapter, org.hibernate.CacheMode, .FlushMode
@Target({TYPE}) @Retention(RUNTIME) public @interface NamedQuery { String name(); String query(); LockModeType lockMode() default NONE; QueryHint[] hints() default {}; }

Java class for named-query complex type.

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

<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://www.hibernate.org/xsd/orm/mapping}lock-mode-type" minOccurs="0"/>
        <element name="hint" type="{http://www.hibernate.org/xsd/orm/mapping}query-hint" maxOccurs="unbounded" minOccurs="0"/>
        <group ref="{http://www.hibernate.org/xsd/orm/mapping}hbm-common-named-query-elements"/>
      </sequence>
      <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
    </restriction>
  </complexContent>
</complexType>

Field Summary

Modifier and TypeField and Description
protected Boolean
cacheable

protected CacheMode
cacheMode

protected String
cacheRegion

protected String
comment

protected String
description

protected Integer
fetchSize

protected FlushMode
flushMode

protected List<JaxbQueryHint>
hint

protected LockModeType
lockMode

protected String
name

protected String
query

protected List<JaxbQueryParamType>
queryParam

protected Boolean
readOnly

protected Integer
timeout

Constructor Summary

AccessConstructor and Description
public
JaxbNamedQuery()

Method Summary

Modifier and TypeMethod and Description
public CacheMode

Returns:

possible object is String
getCacheMode()

Gets the value of the cacheMode property.

public String

Returns:

possible object is String
getCacheRegion()

Gets the value of the cacheRegion property.

public String

Returns:

possible object is String
getComment()

Gets the value of the comment property.

public String

Returns:

possible object is String
getDescription()

Gets the value of the description property.

public Integer

Returns:

possible object is Integer
getFetchSize()

Gets the value of the fetchSize property.

public FlushMode

Returns:

possible object is String
getFlushMode()

Gets the value of the flushMode property.

public List<JaxbQueryHint>

Returns:

The value of the hint property.
getHint()

Gets the value of the hint property.

public LockModeType

Returns:

possible object is String
getLockMode()

Gets the value of the lockMode property.

public String

Returns:

possible object is String
getName()

Gets the value of the name property.

public String

Returns:

possible object is String
getQuery()

Gets the value of the query property.

public List<JaxbQueryParamType>

Returns:

The value of the queryParam property.
getQueryParam()

Gets the value of the queryParam property.

public Integer

Returns:

possible object is Integer
getTimeout()

Gets the value of the timeout property.

public Boolean

Returns:

possible object is Boolean
isCacheable()

Gets the value of the cacheable property.

public Boolean

Returns:

possible object is Boolean
isReadOnly()

Gets the value of the readOnly property.

public void
setCacheable(Boolean
allowed object is Boolean
value)

Sets the value of the cacheable property.

public void
setCacheMode(CacheMode
allowed object is String
value)

Sets the value of the cacheMode property.

public void
setCacheRegion(String
allowed object is String
value)

Sets the value of the cacheRegion property.

public void
setComment(String
allowed object is String
value)

Sets the value of the comment property.

public void
setDescription(String
allowed object is String
value)

Sets the value of the description property.

public void
setFetchSize(Integer
allowed object is Integer
value)

Sets the value of the fetchSize property.

public void
setFlushMode(FlushMode
allowed object is String
value)

Sets the value of the flushMode property.

public void
setLockMode(LockModeType
allowed object is String
value)

Sets the value of the lockMode property.

public void
setName(String
allowed object is String
value)

Sets the value of the name property.

public void
setQuery(String
allowed object is String
value)

Sets the value of the query property.

public void
setReadOnly(Boolean
allowed object is Boolean
value)

Sets the value of the readOnly property.

public void
setTimeout(Integer
allowed object is Integer
value)

Sets the value of the timeout property.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

cacheableback to summary
protected Boolean cacheable
Annotations
@XmlElement
namespace:http://www.hibernate.org/xsd/orm/mapping
cacheModeback to summary
protected CacheMode cacheMode
Annotations
@XmlElement
name:cache-mode
namespace:http://www.hibernate.org/xsd/orm/mapping
type:String
@XmlJavaTypeAdapter:Adapter16
@XmlSchemaType
name:token
cacheRegionback to summary
protected String cacheRegion
Annotations
@XmlElement
name:cache-region
namespace:http://www.hibernate.org/xsd/orm/mapping
commentback to summary
protected String comment
Annotations
@XmlElement
namespace:http://www.hibernate.org/xsd/orm/mapping
descriptionback to summary
protected String description
Annotations
@XmlElement
namespace:http://www.hibernate.org/xsd/orm/mapping
fetchSizeback to summary
protected Integer fetchSize
Annotations
@XmlElement
name:fetch-size
namespace:http://www.hibernate.org/xsd/orm/mapping
flushModeback to summary
protected FlushMode flushMode
Annotations
@XmlElement
name:flush-mode
namespace:http://www.hibernate.org/xsd/orm/mapping
type:String
@XmlJavaTypeAdapter:Adapter19
@XmlSchemaType
name:token
hintback to summary
protected List<JaxbQueryHint> hint
Annotations
@XmlElement
namespace:http://www.hibernate.org/xsd/orm/mapping
lockModeback to summary
protected LockModeType lockMode
Annotations
@XmlElement
name:lock-mode
namespace:http://www.hibernate.org/xsd/orm/mapping
type:String
@XmlJavaTypeAdapter:Adapter12
@XmlSchemaType
name:token
nameback to summary
protected String name
Annotations
@XmlAttribute
name:name
required:true
queryback to summary
protected String query
Annotations
@XmlElement
namespace:http://www.hibernate.org/xsd/orm/mapping
required:true
queryParamback to summary
protected List<JaxbQueryParamType> queryParam
Annotations
@XmlElement
name:query-param
namespace:http://www.hibernate.org/xsd/orm/mapping
readOnlyback to summary
protected Boolean readOnly
Annotations
@XmlElement
name:read-only
namespace:http://www.hibernate.org/xsd/orm/mapping
timeoutback to summary
protected Integer timeout
Annotations
@XmlElement
namespace:http://www.hibernate.org/xsd/orm/mapping

Constructor Detail

JaxbNamedQueryback to summary
public JaxbNamedQuery()

Method Detail

getCacheModeback to summary
public CacheMode getCacheMode()

Gets the value of the cacheMode property.

Returns:CacheMode

possible object is String

getCacheRegionback to summary
public String getCacheRegion()

Gets the value of the cacheRegion property.

Returns:String

possible object is String

getCommentback to summary
public String getComment()

Gets the value of the comment property.

Returns:String

possible object is String

getDescriptionback to summary
public String getDescription()

Gets the value of the description property.

Returns:String

possible object is String

getFetchSizeback to summary
public Integer getFetchSize()

Gets the value of the fetchSize property.

Returns:Integer

possible object is Integer

getFlushModeback to summary
public FlushMode getFlushMode()

Gets the value of the flushMode property.

Returns:FlushMode

possible object is String

getHintback to summary
public List<JaxbQueryHint> 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 Jakarta XML Binding 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 JaxbQueryHint

Returns:List<JaxbQueryHint>

The value of the hint property.

getLockModeback to summary
public LockModeType getLockMode()

Gets the value of the lockMode property.

Returns:LockModeType

possible object is String

getNameback to summary
public String getName()

Gets the value of the name property.

Returns:String

possible object is String

getQueryback to summary
public String getQuery()

Gets the value of the query property.

Returns:String

possible object is String

getQueryParamback to summary
public List<JaxbQueryParamType> getQueryParam()

Gets the value of the queryParam 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 Jakarta XML Binding object. This is why there is not a set method for the queryParam property.

For example, to add a new item, do as follows: 

   getQueryParam().add(newItem);

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

Returns:List<JaxbQueryParamType>

The value of the queryParam property.

getTimeoutback to summary
public Integer getTimeout()

Gets the value of the timeout property.

Returns:Integer

possible object is Integer

isCacheableback to summary
public Boolean isCacheable()

Gets the value of the cacheable property.

Returns:Boolean

possible object is Boolean

isReadOnlyback to summary
public Boolean isReadOnly()

Gets the value of the readOnly property.

Returns:Boolean

possible object is Boolean

setCacheableback to summary
public void setCacheable(Boolean value)

Sets the value of the cacheable property.

Parameters
value:Boolean

allowed object is Boolean

setCacheModeback to summary
public void setCacheMode(CacheMode value)

Sets the value of the cacheMode property.

Parameters
value:CacheMode

allowed object is String

setCacheRegionback to summary
public void setCacheRegion(String value)

Sets the value of the cacheRegion property.

Parameters
value:String

allowed object is String

setCommentback to summary
public void setComment(String value)

Sets the value of the comment property.

Parameters
value:String

allowed object is String

setDescriptionback to summary
public void setDescription(String value)

Sets the value of the description property.

Parameters
value:String

allowed object is String

setFetchSizeback to summary
public void setFetchSize(Integer value)

Sets the value of the fetchSize property.

Parameters
value:Integer

allowed object is Integer

setFlushModeback to summary
public void setFlushMode(FlushMode value)

Sets the value of the flushMode property.

Parameters
value:FlushMode

allowed object is String

setLockModeback to summary
public void setLockMode(LockModeType value)

Sets the value of the lockMode property.

Parameters
value:LockModeType

allowed object is String

setNameback to summary
public void setName(String value)

Sets the value of the name property.

Parameters
value:String

allowed object is String

setQueryback to summary
public void setQuery(String value)

Sets the value of the query property.

Parameters
value:String

allowed object is String

setReadOnlyback to summary
public void setReadOnly(Boolean value)

Sets the value of the readOnly property.

Parameters
value:Boolean

allowed object is Boolean

setTimeoutback to summary
public void setTimeout(Integer value)

Sets the value of the timeout property.

Parameters
value:Integer

allowed object is Integer