com.github.quintans.ezSQL.dml

Class Query

java.lang.Object

com.github.quintans.ezSQL.dml.DmlBase

com.github.quintans.ezSQL.dml.Query

public class Query
extends DmlBase

Nested Class Summary

Nested classes/interfaces inherited from class com.github.quintans.ezSQL.dml.DmlBase

DmlBase.PathCondition

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIRST_RESULT
static String	LAST_RESULT

Fields inherited from class com.github.quintans.ezSQL.dml.DmlBase

cachedAssociation, condition, db, discriminatorConditions, JOIN_PREFIX, joinBag, joins, lastFkAlias, lastJoin, parameters, path, PREFIX, rawSql, simpleJdbc, table, tableAlias

Constructor Summary

Constructors

Constructor and Description
Query(AbstractDb db, Table table)
Query(Query subquery)

Method Summary

Modifier and Type	Method and Description
void	alias(String alias)
Query	all()
Query	as(String alias) Defines the alias of the last column, or if none was defined, defines the table alias;
Query	asc() Define a direção ASCENDENTE da ordem a aplicar na ultima ordem definida
Query	asc(boolean dir) Define a direção da ordem a aplicar na ultima ordem definida
Query	asc(Column<?> column)
Query	asc(Column<?> column, String alias)
Query	asc(String column)
Query	ascBy(Column<?> column)
Query	column(Object... cols)
void	copy(Query other)
Query	count()
Query	count(Object... expr)
Query	desc() Define a direção DESCENDENTE da ordem a aplicar na ultima ordem definida
Query	desc(Column<?> column)
Query	desc(Column<?> column, String alias)
Query	desc(String column)
Query	descBy(Column<?> column)
Query	distinct()
Query	exclude(Column<?>... columns) includes all column from the table from the last association but the ones declared in this method.
Query	fetch() This will trigger a result that can be dumped in a tree object using current association path to build the tree result. If no columns where included in this path, it will includes all the columns of all the tables referred by the association path.
String	getAlias()
List<Function>	getColumns()
int[]	getGroupBy()
List<Group>	getGroupByFunction()
Condition	getHaving()
int	getLimit()
List<Order>	getOrders()
int	getSkip()
RawSql	getSql() SQL String.
Query	getSubquery()
List<Union>	getUnions()
Query	groupBy(Column<?>... cols)
Query	groupBy(int... pos)
Query	groupBy(String... aliases)
Query	groupByUntil(int untilPos)
Query	having(Condition... having) Adds a Having clause to the query.
Query	include(Object... columns) Includes any kind of column (table column or function) referring to the table targeted by the last association.
Query	inner(Association... associations) includes the associations as inner joins to the current path.
Query	innerFetch(Association... associations) Executa um INNER join com as tabelas definidas pelas foreign keys. TODAS as colunas das tabelas intermédias são incluidas no select bem como TODAS as colunas da tabela no fim das associações.
Query	innerJoin(Association... associations) The same as inner(...).join()
boolean	isDistinct()
boolean	isFlat()
Query	join() This will NOT trigger a result that can be dumped in a tree object. Any included column, will be considered as belonging to the root object.
Query	limit(int maxResults)
<T> List<T>	list(Class<T> klass) Executes a query and transform the results to the bean type passed as parameter, matching the alias with bean property name.
<T> List<T>	list(Class<T> klass, boolean reuse) Executes a query and transform the results to the bean type, matching the alias with bean property name.
<T> List<T>	list(IQueryRowTransformer<T> transformer)
<T> List<T>	list(IRowTransformer<T> rowMapper) Executes a query and transform the results according to the transformer
List<Object[]>	listRaw(Class<?>... clazzes)
<T> List<T>	listRaw(Class<T> clazz) Retrives a collection of objects of simple type (not beans).
Query	on(Condition... condition) Restriction to apply to the previous association
Query	order(Column<?> column) Order by a column belonging to the driving table If you want to order by a column from the table targeted by the last association, use orderBy
Query	order(Column<?> column, Association... associations) Order by column belonging to another table.
Query	order(Column<?> column, String alias)
Query	order(String column)
Query	orderBy(Column<?> column) Define a coluna a ordenar.
Query	outer(Association... associations) includes the associations as outer joins to the current path
Query	outerFetch(Association... associations) Executa um OUTER join com as tabelas definidas pelas foreign keys. TODAS as colunas das tabelas intermédias são incluidas no select bem como a TODAS as colunas da tabela no fim das associações.
Query	outerJoin(Association... associations) The same as outer(...).join()
void	run(IProcessor processor) Every row will be processed by the only method of the supplied object. The Object type for each column is obtained from the types of the method parameters. The processed rows are not collected, so any returning object is discarded.
void	runFirst(IProcessor processor)
void	runOne(IProcessor processor)
<T> T	select(Class<T> klass)
<T> T	select(Class<T> klass, boolean reuse)
<T> T	select(IRowTransformer<T> rowMapper)
Query	skip(int firstResult)
Function	subQuery()
Query	union(Query query)
Query	unionAll(Query query)
<T> T	unique(Class<T> klass)
<T> T	unique(IRowTransformer<T> rowMapper) Executes a query and transform the results according to the transformer. If more than one result is returned an Exception will occur.
BigDecimal	uniqueBigDecimal()
Boolean	uniqueBoolean()
Double	uniqueDouble()
Float	uniqueFloat()
Integer	uniqueInteger()
Long	uniqueLong()
Object[]	uniqueRaw(Class<?>... clazzes)
<T> T	uniqueRaw(Class<T> clazz)
String	uniqueString()
Query	where(Condition... restrictions)
Query	where(Condition restriction)
Query	where(List<Condition> restrictions)

Methods inherited from class com.github.quintans.ezSQL.dml.DmlBase

addJoin, applyInclude, applyOn, applyWhere, callerName, connection, debug, debugSQL, debugTime, deepestCommonPath, driver, dumpParameters, getAliasForAssociation, getCondition, getDb, getJoins, getParameter, getParameters, getSimpleJdbc, getTable, getTableAlias, joinTo, nextRawIndex, replaceRaw, setParameter, setParameter, setTableAlias

Methods inherited from class java.lang.Object

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

Field Detail

FIRST_RESULT

public static final String FIRST_RESULT

See Also:

Constant Field Values

LAST_RESULT

public static final String LAST_RESULT

See Also:

Constant Field Values

Constructor Detail

Query

public Query(AbstractDb db,
             Table table)

Query

public Query(Query subquery)

Method Detail

getAlias

public String getAlias()

isFlat

public boolean isFlat()

alias

public void alias(String alias)

copy

public void copy(Query other)

getSkip

public int getSkip()

skip

public Query skip(int firstResult)

getLimit

public int getLimit()

limit

public Query limit(int maxResults)

getSubquery

public Query getSubquery()

distinct

public Query distinct()

isDistinct

public boolean isDistinct()

all

public Query all()

column

public Query column(Object... cols)

count

public Query count()

count

public Query count(Object... expr)

as

public Query as(String alias)

Defines the alias of the last column, or if none was defined, defines the table alias;

Parameters:

alias - The Alias

Returns:

The query

getColumns

public List<Function> getColumns()

where

public Query where(Condition restriction)

Overrides:

where in class DmlBase

where

public Query where(Condition... restrictions)

Overrides:

where in class DmlBase

where

public Query where(List<Condition> restrictions)

Overrides:

where in class DmlBase

order

public Query order(Column<?> column)

Order by a column belonging to the driving table
If you want to order by a column from the table targeted by the last association, use orderBy

Parameters:

column -

Returns:

asc

public Query asc(Column<?> column)

desc

public Query desc(Column<?> column)

order

public Query order(Column<?> column,
                   String alias)

asc

public Query asc(Column<?> column,
                 String alias)

desc

public Query desc(Column<?> column,
                  String alias)

order

public Query order(Column<?> column,
                   Association... associations)

Order by column belonging to another table. This might come in handy when the order cannot be declared in the same order as the joins.

Parameters:

column - a coluna de ordenação

associations - associações para chegar à tabela que contem a coluna de ordenação

Returns:

devolve a query

orderBy

public Query orderBy(Column<?> column)

Define a coluna a ordenar. A coluna pertence à última associação definida,
ou se não houver nenhuma associação, a coluna pertencente à tabela

Parameters:

column -

Returns:

ascBy

public Query ascBy(Column<?> column)

descBy

public Query descBy(Column<?> column)

order

public Query order(String column)

asc

public Query asc(String column)

desc

public Query desc(String column)

asc

public Query asc()

Define a direção ASCENDENTE da ordem a aplicar na ultima ordem definida

Returns:

this

asc

public Query asc(boolean dir)

Define a direção da ordem a aplicar na ultima ordem definida

Parameters:

dir -

Returns:

this

desc

public Query desc()

Define a direção DESCENDENTE da ordem a aplicar na ultima ordem definida

Returns:

getOrders

public List<Order> getOrders()

inner

public Query inner(Association... associations)

includes the associations as inner joins to the current path.

Parameters:

associations -

Returns:

outer

public Query outer(Association... associations)

includes the associations as outer joins to the current path

Parameters:

associations -

Returns:

fetch

public Query fetch()

This will trigger a result that can be dumped in a tree object using current association path to build the tree result.
If no columns where included in this path, it will includes all the columns of all the tables referred by the association path.

Returns:

join

public Query join()

This will NOT trigger a result that can be dumped in a tree object.
Any included column, will be considered as belonging to the root object.

Returns:

innerJoin

public Query innerJoin(Association... associations)

The same as inner(...).join()

Parameters:

associations -

Returns:

outerJoin

public Query outerJoin(Association... associations)

The same as outer(...).join()

Parameters:

associations -

Returns:

include

public Query include(Object... columns)

Includes any kind of column (table column or function) referring to the table targeted by the last association.

Parameters:

columns - or functions

Returns:

exclude

public Query exclude(Column<?>... columns)

includes all column from the table from the last association but the ones declared in this method.

Parameters:

columns -

Returns:

outerFetch

public Query outerFetch(Association... associations)

Executa um OUTER join com as tabelas definidas pelas foreign keys.
TODAS as colunas das tabelas intermédias são incluidas no select bem como a TODAS as colunas da tabela no fim das associações.

Parameters:

associations - as foreign keys que definem uma navegação

Returns:

innerFetch

public Query innerFetch(Association... associations)

Executa um INNER join com as tabelas definidas pelas foreign keys.
TODAS as colunas das tabelas intermédias são incluidas no select bem como TODAS as colunas da tabela no fim das associações.

Parameters:

associations - as foreign keys que definem uma navegação

Returns:

on

public Query on(Condition... condition)

Restriction to apply to the previous association

Parameters:

condition - Restriction

Returns:

union

public Query union(Query query)

unionAll

public Query unionAll(Query query)

getUnions

public List<Union> getUnions()

groupByUntil

public Query groupByUntil(int untilPos)

groupBy

public Query groupBy(int... pos)

getGroupBy

public int[] getGroupBy()

getGroupByFunction

public List<Group> getGroupByFunction()

groupBy

public Query groupBy(Column<?>... cols)

groupBy

public Query groupBy(String... aliases)

getHaving

public Condition getHaving()

having

public Query having(Condition... having)

Adds a Having clause to the query. The tokens are not processed. You will have to explicitly set all table alias.

Parameters:

having -

Returns:

this

run

public void run(IProcessor processor)

Every row will be processed by the only method of the supplied object.
The Object type for each column is obtained from the types of the method parameters.
The processed rows are not collected, so any returning object is discarded.

Parameters:

processor - A processor object that must have one declared method and this method must at least one parameter.

runOne

public void runOne(IProcessor processor)

runFirst

public void runFirst(IProcessor processor)

listRaw

public List<Object[]> listRaw(Class<?>... clazzes)

uniqueRaw

public Object[] uniqueRaw(Class<?>... clazzes)

listRaw

public <T> List<T> listRaw(Class<T> clazz)

Retrives a collection of objects of simple type (not beans). Ex: Boolean, String, enum, ...

Parameters:

clazz - class of the object to return

Returns:

uniqueRaw

public <T> T uniqueRaw(Class<T> clazz)

uniqueBoolean

public Boolean uniqueBoolean()

uniqueInteger

public Integer uniqueInteger()

uniqueLong

public Long uniqueLong()

uniqueFloat

public Float uniqueFloat()

uniqueDouble

public Double uniqueDouble()

uniqueString

public String uniqueString()

uniqueBigDecimal

public BigDecimal uniqueBigDecimal()

list

public <T> List<T> list(Class<T> klass,
                        boolean reuse)

Executes a query and transform the results to the bean type,
matching the alias with bean property name.

Type Parameters:

T - the bean type

Parameters:

klass - The bean type

reuse - Indicates if for the same entity, a new bean should be created, or reused a previous instanciated one.

Returns:

A collection of beans

list

public <T> List<T> list(Class<T> klass)

Executes a query and transform the results to the bean type passed as parameter,
matching the alias with bean property name. If no alias is supplied, it is used the column alias.

Parameters:

klass -

Returns:

list

public <T> List<T> list(IQueryRowTransformer<T> transformer)

list

public <T> List<T> list(IRowTransformer<T> rowMapper)

Executes a query and transform the results according to the transformer

Type Parameters:

T - the bean type

Parameters:

rowMapper - The row transformer

Returns:

A collection of transformed results

unique

public <T> T unique(IRowTransformer<T> rowMapper)

Executes a query and transform the results according to the transformer.
If more than one result is returned an Exception will occur.

Type Parameters:

T - the bean type

Parameters:

rowMapper - The row transformer

Returns:

A collection of transformed results

unique

public <T> T unique(Class<T> klass)

select

public <T> T select(Class<T> klass)

select

public <T> T select(Class<T> klass,
                    boolean reuse)

select

public <T> T select(IRowTransformer<T> rowMapper)

getSql

public RawSql getSql()

SQL String. It is cached for multiple access

Specified by:

getSql in class DmlBase

subQuery

public Function subQuery()