org.eobjects.metamodel.query.builder
Interface SatisfiedQueryBuilder<B extends SatisfiedQueryBuilder<?>>

Type Parameters:

B -

All Known Subinterfaces:

ColumnSelectBuilder<B>, CountSelectBuilder<B>, FunctionSelectBuilder<B>, GroupedQueryBuilder, SatisfiedHavingBuilder, SatisfiedOrderByBuilder<B>, SatisfiedSelectBuilder<B>, SatisfiedWhereBuilder<B>

public interface SatisfiedQueryBuilder<B extends SatisfiedQueryBuilder<?>>

Represents a built query that is satisfied and ready for querying or further building.

Author:

Kasper Sørensen

Method Summary

CompiledQuery	compile()
DataSet	execute() Executes the built query.
Column	findColumn(String columnName) Finds a column by name within the already defined FROM items
SatisfiedQueryBuilder<B>	firstRow(int firstRow) Sets the first row of the query that is being built.
B	groupBy(Column... columns)
GroupedQueryBuilder	groupBy(Column column)
GroupedQueryBuilder	groupBy(String columnName)
SatisfiedQueryBuilder<B>	limit(int limit) Sets the limit (aka. max rows) of the query that is being built.
SatisfiedQueryBuilder<B>	maxRows(int maxRows) Sets the max rows (aka. limit) of the query that is being built.
SatisfiedQueryBuilder<B>	offset(int offset) Sets the offset (number of rows to skip) of the query that is being built.
SatisfiedOrderByBuilder<B>	orderBy(Column column)
SatisfiedOrderByBuilder<B>	orderBy(String columnName)
SatisfiedSelectBuilder<B>	select(Column... columns)
ColumnSelectBuilder<B>	select(Column column)
FunctionSelectBuilder<B>	select(FunctionType functionType, Column column)
ColumnSelectBuilder<B>	select(String columnName)
CountSelectBuilder<B>	selectCount()
Query	toQuery() Gets the built query as a Query object.
WhereBuilder<B>	where(Column column)
SatisfiedQueryBuilder<B>	where(FilterItem... filters)
SatisfiedQueryBuilder<B>	where(Iterable<FilterItem> filters)
WhereBuilder<B>	where(String columnName)

Method Detail

select

ColumnSelectBuilder<B> select(Column column)

select

SatisfiedSelectBuilder<B> select(Column... columns)

offset

SatisfiedQueryBuilder<B> offset(int offset)

Sets the offset (number of rows to skip) of the query that is being built. Note that this number is a 0-based variant of invoking firstRow(int).

Parameters:

offset - the number of rows to skip

Returns:

firstRow

SatisfiedQueryBuilder<B> firstRow(int firstRow)

Sets the first row of the query that is being built. Note that this is a 1-based variant of invoking limit(int).

Parameters:

firstRow -

Returns:

limit

SatisfiedQueryBuilder<B> limit(int limit)

Sets the limit (aka. max rows) of the query that is being built.

Parameters:

maxRows -

Returns:

maxRows

SatisfiedQueryBuilder<B> maxRows(int maxRows)

Sets the max rows (aka. limit) of the query that is being built.

Parameters:

maxRows -

Returns:

select

FunctionSelectBuilder<B> select(FunctionType functionType,
                                Column column)

selectCount

CountSelectBuilder<B> selectCount()

select

ColumnSelectBuilder<B> select(String columnName)

where

WhereBuilder<B> where(Column column)

where

WhereBuilder<B> where(String columnName)

where

SatisfiedQueryBuilder<B> where(FilterItem... filters)

where

SatisfiedQueryBuilder<B> where(Iterable<FilterItem> filters)

orderBy

SatisfiedOrderByBuilder<B> orderBy(String columnName)

orderBy

SatisfiedOrderByBuilder<B> orderBy(Column column)

groupBy

GroupedQueryBuilder groupBy(String columnName)

groupBy

GroupedQueryBuilder groupBy(Column column)

groupBy

B groupBy(Column... columns)

toQuery

Query toQuery()

Gets the built query as a Query object. Typically the returned query will be a clone of the built query to prevent conflicting mutations.

Returns:

a Query object representing the built query.

compile

CompiledQuery compile()

execute

DataSet execute()

Executes the built query. This call is similar to calling toQuery() and then DataContext.executeQuery(Query).

Returns:

the DataSet that is returned by executing the query.

findColumn

Column findColumn(String columnName)
                  throws IllegalArgumentException

Finds a column by name within the already defined FROM items

Parameters:

columnName -

Returns:

Throws:

IllegalArgumentException