net.aditsu.depeche

Interface IQuery

All Superinterfaces:

Collection<Record>, Iterable<Record>, List<Record>, Serializable

All Known Subinterfaces:

DynamicQuery

All Known Implementing Classes:

BaseQuery, LocalQuery, Query, RawQuery, RSetQuery, SQLQuery

public interface IQuery
extends List<Record>, Serializable

Base query interface

Author:

aditsu

Method Summary

Methods

Modifier and Type	Method and Description
void	clearData() Clears the cached results, so the SELECT query will run again when needed
List<Serializable>	getColumn(int x) Returns a lazy list of the values returned by this SELECT query in a given column
<T extends Serializable> List<T>	getColumn(int x, Class<T> cl) Returns a lazy list of the values returned by this SELECT query in a given column, using a class to cast the values to the correct type
List<Serializable>	getColumn(String name) Returns a list of the values returned by this SELECT query in a given column
<T extends Serializable> List<T>	getColumn(String name, Class<T> cl) Returns a list of the values returned by this SELECT query in a given column, using a class to cast the values to the correct type
ColumnInfo	getColumnInfo() Returns the column information for this SELECT query's results
LocalQuery	getLocalQuery() Returns a LocalQuery that uses the records selected by this query
Record	getOneRecord() Runs this query as a SELECT (if needed) and returns a single record; it throws an exception if the number of results is not 1
Record	getRecord() Runs this query as a SELECT (if needed) and returns a single record, or null if there are no results; it throws an exception if there are multiple results
boolean	hasRun() Returns true if this query was already executed as a SELECT (and the results cached)
IQuery	select() Runs this query as a SELECT (and caches the results)

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Method Detail

select

IQuery select()

Runs this query as a SELECT (and caches the results)

Returns:

this query

hasRun

boolean hasRun()

Returns true if this query was already executed as a SELECT (and the results cached)

clearData

void clearData()

Clears the cached results, so the SELECT query will run again when needed

getColumnInfo

ColumnInfo getColumnInfo()

Returns the column information for this SELECT query's results

getOneRecord

Record getOneRecord()

Runs this query as a SELECT (if needed) and returns a single record; it throws an exception if the number of results is not 1

getRecord

Record getRecord()

Runs this query as a SELECT (if needed) and returns a single record, or null if there are no results; it throws an exception if there are multiple results

getColumn

List<Serializable> getColumn(int x)

Returns a lazy list of the values returned by this SELECT query in a given column

getColumn

List<Serializable> getColumn(String name)

Returns a list of the values returned by this SELECT query in a given column

getColumn

<T extends Serializable> List<T> getColumn(int x,
                                         Class<T> cl)

Returns a lazy list of the values returned by this SELECT query in a given column, using a class to cast the values to the correct type

getColumn

<T extends Serializable> List<T> getColumn(String name,
                                         Class<T> cl)

Returns a list of the values returned by this SELECT query in a given column, using a class to cast the values to the correct type

getLocalQuery

LocalQuery getLocalQuery()

Returns a LocalQuery that uses the records selected by this query