org.hibernate.annotations

Annotation Type NamedQuery

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

Extends NamedQuery with Hibernate features

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	name
java.lang.String	query

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	cacheable
CacheModeType	cacheMode
java.lang.String	cacheRegion
java.lang.String	comment
int	fetchSize
FlushModeType	flushMode
boolean	readOnly
int	timeout

Element Detail

name

public abstract java.lang.String name

Returns:

returns the name of this NamedQuery

query

public abstract java.lang.String query

Returns:

returns the query string for this NamedQuery

flushMode

public abstract FlushModeType flushMode

Returns:

returns the flush mode for this query

Default:

org.hibernate.annotations.FlushModeType.PERSISTENCE_CONTEXT

cacheable

public abstract boolean cacheable

Returns:

returns whether this query is cacheable or not

Default:

false

cacheRegion

public abstract java.lang.String cacheRegion

Returns:

returns the the cache region to use

Default:

""

fetchSize

public abstract int fetchSize

Returns:

returns the number of rows fetched by the JDBC Driver per database round-trip

Default:

-1

timeout

public abstract int timeout

Returns:

return the query timeout in seconds

Default:

-1

comment

public abstract java.lang.String comment

Returns:

returns the comment added to the SQL query (useful for the DBA)

Default:

""

cacheMode

public abstract CacheModeType cacheMode

Returns:

returns the cache mode used for this query

Default:

org.hibernate.annotations.CacheModeType.NORMAL

readOnly

public abstract boolean readOnly

Returns:

returns whether the results are fetched in read-only mode or not. Default is false

Default:

false