net.aditsu.depeche

Class BaseQuery

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<Record>

net.aditsu.depeche.BaseQuery

All Implemented Interfaces:

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

Direct Known Subclasses:

LocalQuery, RSetQuery, SQLQuery

public abstract class BaseQuery
extends AbstractList<Record>
implements IQuery

Base query skeleton, using lazy evaluation and result caching for SELECT

Author:

aditsu

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BaseQuery()

Method Summary

Methods

Modifier and Type	Method and Description
void	clearData() Clears the cached results, so the SELECT query will run again when needed
Record	get(int index)
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)
abstract BaseQuery	select() Runs this query as a SELECT (and caches the results)
int	size()

Methods inherited from class java.util.AbstractList

add, add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, set, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

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

Constructor Detail

BaseQuery

public BaseQuery()

Method Detail

select

public abstract BaseQuery select()

Description copied from interface: IQuery

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

Specified by:

select in interface IQuery

Returns:

this query

hasRun

public boolean hasRun()

Description copied from interface: IQuery

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

Specified by:

hasRun in interface IQuery

get

public Record get(int index)

Specified by:

get in interface List<Record>

Specified by:

get in class AbstractList<Record>

size

public int size()

Specified by:

size in interface Collection<Record>

Specified by:

size in interface List<Record>

Specified by:

size in class AbstractCollection<Record>

clearData

public void clearData()

Description copied from interface: IQuery

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

Specified by:

clearData in interface IQuery

getColumnInfo

public ColumnInfo getColumnInfo()

Description copied from interface: IQuery

Returns the column information for this SELECT query's results

Specified by:

getColumnInfo in interface IQuery

getOneRecord

public Record getOneRecord()

Description copied from interface: IQuery

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

Specified by:

getOneRecord in interface IQuery

getRecord

public Record getRecord()

Description copied from interface: IQuery

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

Specified by:

getRecord in interface IQuery

getColumn

public List<Serializable> getColumn(int x)

Description copied from interface: IQuery

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

Specified by:

getColumn in interface IQuery

getColumn

public List<Serializable> getColumn(String name)

Description copied from interface: IQuery

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

Specified by:

getColumn in interface IQuery

getColumn

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

Description copied from interface: IQuery

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

Specified by:

getColumn in interface IQuery

getColumn

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

Description copied from interface: IQuery

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

Specified by:

getColumn in interface IQuery

getLocalQuery

public LocalQuery getLocalQuery()

Description copied from interface: IQuery

Returns a LocalQuery that uses the records selected by this query

Specified by:

getLocalQuery in interface IQuery