com.avaje.ebeaninternal.server.querydefn

Class DefaultRelationalQuery

java.lang.Object

com.avaje.ebeaninternal.server.querydefn.DefaultRelationalQuery

All Implemented Interfaces:

SqlQuery, SpiSqlQuery, Serializable

public class DefaultRelationalQuery
extends Object
implements SpiSqlQuery

Default implementation of SQuery - SQL Query.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultRelationalQuery(EbeanServer server, String query) Additional supply a query detail object.

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Cancel the query if support by the underlying database and driver.
SqlFutureList	findFutureList() Execute find list SQL query in a background thread.
List<SqlRow>	findList() Execute the query returning a list.
Map<?,SqlRow>	findMap() Execute the query returning a map.
Set<SqlRow>	findSet() Execute the query returning a set.
SqlRow	findUnique() Execute the query returning a single row or null.
int	getBackgroundFetchAfter() Return the number of rows after which background fetching occurs.
BindParams	getBindParams() Return the named or positioned parameters.
int	getBufferFetchSizeHint() Return the hint for Statement.setFetchSize().
int	getFirstRow() Return the first row to fetch.
SqlQueryListener	getListener() Return the findListener is one has been set.
String	getMapKey() Return the key property for maps.
int	getMaxRows() Return the maximum number of rows to fetch.
String	getQuery() return the query.
int	getTimeout() Return the query timeout.
boolean	isCancelled() Return true if the query has been cancelled.
boolean	isFutureFetch() Return true if this is a future fetch type query.
DefaultRelationalQuery	setBackgroundFetchAfter(int backgroundFetchAfter) Set the index after which fetching continues in a background thread.
DefaultRelationalQuery	setBufferFetchSizeHint(int bufferFetchSizeHint) A hint which for JDBC translates to the Statement.fetchSize().
DefaultRelationalQuery	setFirstRow(int firstRow) Set the index of the first row of the results to return.
void	setFutureFetch(boolean futureFetch) Set to true if this is a future fetch type query.
DefaultRelationalQuery	setListener(SqlQueryListener queryListener) Set a listener.
DefaultRelationalQuery	setMapKey(String mapKey) Set the column to use to determine the keys for a Map.
DefaultRelationalQuery	setMaxRows(int maxRows) Set the maximum number of query results to return.
DefaultRelationalQuery	setParameter(int position, Object value) The same as bind for positioned parameters.
DefaultRelationalQuery	setParameter(String paramName, Object value) The same as bind for named parameters.
void	setPreparedStatement(PreparedStatement pstmt) Set the PreparedStatement for the purposes of supporting cancel.
DefaultRelationalQuery	setQuery(String query)
DefaultRelationalQuery	setTimeout(int secs) Set a timeout on this query.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultRelationalQuery

public DefaultRelationalQuery(EbeanServer server,
                      String query)

Additional supply a query detail object.

Method Detail

setQuery

public DefaultRelationalQuery setQuery(String query)

findList

public List<SqlRow> findList()

Description copied from interface: SqlQuery

Execute the query returning a list.

Specified by:

findList in interface SqlQuery

findSet

public Set<SqlRow> findSet()

Description copied from interface: SqlQuery

Execute the query returning a set.

Specified by:

findSet in interface SqlQuery

findMap

public Map<?,SqlRow> findMap()

Description copied from interface: SqlQuery

Execute the query returning a map.

Specified by:

findMap in interface SqlQuery

findUnique

public SqlRow findUnique()

Description copied from interface: SqlQuery

Execute the query returning a single row or null.

If this query finds 2 or more rows then it will throw a PersistenceException.

Specified by:

findUnique in interface SqlQuery

findFutureList

public SqlFutureList findFutureList()

Description copied from interface: SqlQuery

Execute find list SQL query in a background thread.

This returns a Future object which can be used to cancel, check the execution status (isDone etc) and get the value (with or without a timeout).

Specified by:

findFutureList in interface SqlQuery

Returns:

a Future object for the list result of the query

setParameter

public DefaultRelationalQuery setParameter(int position,
                                  Object value)

Description copied from interface: SqlQuery

The same as bind for positioned parameters.

Specified by:

setParameter in interface SqlQuery

setParameter

public DefaultRelationalQuery setParameter(String paramName,
                                  Object value)

Description copied from interface: SqlQuery

The same as bind for named parameters.

Specified by:

setParameter in interface SqlQuery

getListener

public SqlQueryListener getListener()

Return the findListener is one has been set.

Specified by:

getListener in interface SpiSqlQuery

setListener

public DefaultRelationalQuery setListener(SqlQueryListener queryListener)

Set a listener. This is designed for large fetches where lots are rows are to be processed and instead of returning all the rows they are processed one at a time.

Note that the returning List Set or Map will be empty.

Specified by:

setListener in interface SqlQuery

toString

public String toString()

Overrides:

toString in class Object

getFirstRow

public int getFirstRow()

Description copied from interface: SpiSqlQuery

Return the first row to fetch.

Specified by:

getFirstRow in interface SpiSqlQuery

setFirstRow

public DefaultRelationalQuery setFirstRow(int firstRow)

Description copied from interface: SqlQuery

Set the index of the first row of the results to return.

Specified by:

setFirstRow in interface SqlQuery

getMaxRows

public int getMaxRows()

Description copied from interface: SpiSqlQuery

Return the maximum number of rows to fetch.

Specified by:

getMaxRows in interface SpiSqlQuery

setMaxRows

public DefaultRelationalQuery setMaxRows(int maxRows)

Description copied from interface: SqlQuery

Set the maximum number of query results to return.

Specified by:

setMaxRows in interface SqlQuery

getMapKey

public String getMapKey()

Description copied from interface: SpiSqlQuery

Return the key property for maps.

Specified by:

getMapKey in interface SpiSqlQuery

setMapKey

public DefaultRelationalQuery setMapKey(String mapKey)

Description copied from interface: SqlQuery

Set the column to use to determine the keys for a Map.

Specified by:

setMapKey in interface SqlQuery

getBackgroundFetchAfter

public int getBackgroundFetchAfter()

Description copied from interface: SpiSqlQuery

Return the number of rows after which background fetching occurs.

Specified by:

getBackgroundFetchAfter in interface SpiSqlQuery

setBackgroundFetchAfter

public DefaultRelationalQuery setBackgroundFetchAfter(int backgroundFetchAfter)

Description copied from interface: SqlQuery

Set the index after which fetching continues in a background thread.

Specified by:

setBackgroundFetchAfter in interface SqlQuery

getTimeout

public int getTimeout()

Description copied from interface: SpiSqlQuery

Return the query timeout.

Specified by:

getTimeout in interface SpiSqlQuery

setTimeout

public DefaultRelationalQuery setTimeout(int secs)

Description copied from interface: SqlQuery

Set a timeout on this query.

This will typically result in a call to setQueryTimeout() on a preparedStatement. If the timeout occurs an exception will be thrown - this will be a SQLException wrapped up in a PersistenceException.

Specified by:

setTimeout in interface SqlQuery

Parameters:

secs - the query timeout limit in seconds. Zero means there is no limit.

getBindParams

public BindParams getBindParams()

Description copied from interface: SpiSqlQuery

Return the named or positioned parameters.

Specified by:

getBindParams in interface SpiSqlQuery

setBufferFetchSizeHint

public DefaultRelationalQuery setBufferFetchSizeHint(int bufferFetchSizeHint)

Description copied from interface: SqlQuery

A hint which for JDBC translates to the Statement.fetchSize().

Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed for ResultSet.

Specified by:

setBufferFetchSizeHint in interface SqlQuery

getBufferFetchSizeHint

public int getBufferFetchSizeHint()

Description copied from interface: SpiSqlQuery

Return the hint for Statement.setFetchSize().

Specified by:

getBufferFetchSizeHint in interface SpiSqlQuery

getQuery

public String getQuery()

Description copied from interface: SpiSqlQuery

return the query.

Specified by:

getQuery in interface SpiSqlQuery

isFutureFetch

public boolean isFutureFetch()

Description copied from interface: SpiSqlQuery

Return true if this is a future fetch type query.

Specified by:

isFutureFetch in interface SpiSqlQuery

setFutureFetch

public void setFutureFetch(boolean futureFetch)

Description copied from interface: SpiSqlQuery

Set to true if this is a future fetch type query.

Specified by:

setFutureFetch in interface SpiSqlQuery

setPreparedStatement

public void setPreparedStatement(PreparedStatement pstmt)

Description copied from interface: SpiSqlQuery

Set the PreparedStatement for the purposes of supporting cancel.

Specified by:

setPreparedStatement in interface SpiSqlQuery

cancel

public void cancel()

Description copied from interface: SqlQuery

Cancel the query if support by the underlying database and driver.

This must be called from a different thread to the one executing the query.

Specified by:

cancel in interface SqlQuery

isCancelled

public boolean isCancelled()

Description copied from interface: SpiSqlQuery

Return true if the query has been cancelled.

Specified by:

isCancelled in interface SpiSqlQuery