org.hibernate.annotations
Annotation Type NamedQuery


@Target(value={TYPE,PACKAGE})
@Retention(value=RUNTIME)
public @interface NamedQuery

Extends NamedQuery with Hibernate features

Author:
Carlos Gonz´┐Żlez-Cadenas

Required Element Summary
 String name
          the name of the NamedQuery
 String query
          the Query String for the NamedQuery
 
Optional Element Summary
 boolean cacheable
          mark the query as cacheable or not
 CacheModeType cacheMode
          the cache mode used for this query
 String cacheRegion
          the cache region to use
 String comment
          comment added to the SQL query, useful for the DBA
 int fetchSize
          the number of rows fetched by the JDBC Driver per roundtrip
 FlushModeType flushMode
          the flush mode for the query
 boolean readOnly
          marks whether the results are fetched in read-only mode or not
 int timeout
          the query timeout in seconds
 

Element Detail

name

public abstract String name
the name of the NamedQuery


query

public abstract String query
the Query String for the NamedQuery

flushMode

public abstract FlushModeType flushMode
the flush mode for the query

Default:
org.hibernate.annotations.FlushModeType.PERSISTENCE_CONTEXT

cacheable

public abstract boolean cacheable
mark the query as cacheable or not

Default:
false

cacheRegion

public abstract String cacheRegion
the cache region to use

Default:
""

fetchSize

public abstract int fetchSize
the number of rows fetched by the JDBC Driver per roundtrip

Default:
-1

timeout

public abstract int timeout
the query timeout in seconds

Default:
-1

comment

public abstract String comment
comment added to the SQL query, useful for the DBA

Default:
""

cacheMode

public abstract CacheModeType cacheMode
the cache mode used for this query

Default:
org.hibernate.annotations.CacheModeType.NORMAL

readOnly

public abstract boolean readOnly
marks whether the results are fetched in read-only mode or not

Default:
false


Copyright © 2001-2010 Red Hat, Inc. All Rights Reserved.