com.mysema.query.sql

Class AbstractSQLQuery<Q extends AbstractSQLQuery<Q>>

java.lang.Object

com.mysema.query.support.QueryBase<Q>

com.mysema.query.support.ProjectableQuery<Q>

com.mysema.query.sql.ProjectableSQLQuery<Q>

com.mysema.query.sql.AbstractSQLQuery<Q>

Type Parameters:

Q - concrete subtype

All Implemented Interfaces:

FilteredClause<Q>, Projectable, Query<Q>, SimpleQuery<Q>, SQLCommonQuery<Q>

Direct Known Subclasses:

MySQLQuery, OracleQuery, PostgresQuery, SQLQuery, SQLServerQuery, TeradataQuery

public abstract class AbstractSQLQuery<Q extends AbstractSQLQuery<Q>>
extends ProjectableSQLQuery<Q>

AbstractSQLQuery is the base type for SQL query implementations

Author:

tiwe

Field Summary

Fields

Modifier and Type	Field and Description
protected SQLListeners	listeners
protected boolean	useLiterals

Fields inherited from class com.mysema.query.sql.ProjectableSQLQuery

configuration, firstUnionSubQuery, union, unionAll

Fields inherited from class com.mysema.query.support.QueryBase

MDC_PARAMETERS, MDC_QUERY, queryMixin

Constructor Summary

Constructors

Constructor and Description
AbstractSQLQuery(Connection conn, Configuration configuration)
AbstractSQLQuery(Connection conn, Configuration configuration, QueryMetadata metadata)

Method Summary

Modifier and Type	Method and Description
void	addListener(SQLListener listener)
protected void	cleanupMDC()
Q	clone()
abstract Q	clone(Connection connection)
protected void	clone(Q query)
long	count() return the amount of matched rows
protected SQLSerializer	createSerializer()
protected void	endContext(SQLListenerContext context) Called to end a SQL listener context
Q	forUpdate() If you use forUpdate() with a backend that uses page or row locks, rows examined by the query are write-locked until the end of the current transaction.
protected Configuration	getConfiguration()
ResultSet	getResults(Expression<?>... exprs) Get the results as an JDBC result set
<RT> com.mysema.commons.lang.CloseableIterator<RT>	iterate(Expression<RT> expr) iterate over the results for the given projection
<RT> List<RT>	list(Expression<RT> expr) list the results for the given projection An empty list is returned for no results.
<RT> SearchResults<RT>	listResults(Expression<RT> expr) list the results for the given projection
protected void	logQuery(String queryString, Collection<Object> parameters)
protected void	onException(SQLListenerContextImpl context, Exception e) Called to make the call back to listeners when an exception happens
protected void	setParameters(PreparedStatement stmt, List<?> objects, List<Path<?>> constantPaths, Map<ParamExpression<?>,?> params)
void	setStatementOptions(StatementOptions statementOptions)
void	setUseLiterals(boolean useLiterals)
protected SQLListenerContextImpl	startContext(Connection connection, QueryMetadata metadata) Called to create and start a new SQL Listener context
<RT> RT	uniqueResult(Expression<RT> expr) return a unique result for the given projection or null if no result is found

Methods inherited from class com.mysema.query.sql.ProjectableSQLQuery

addFlag, addFlag, addFlag, addFlag, addJoinFlag, addJoinFlag, exists, from, from, from, fullJoin, fullJoin, fullJoin, fullJoin, getMetadata, getSQL, innerJoin, innerJoin, innerJoin, innerJoin, iterate, join, join, join, join, leftJoin, leftJoin, leftJoin, leftJoin, list, listResults, on, on, rightJoin, rightJoin, rightJoin, rightJoin, serialize, toString, union, union, union, union, unionAll, unionAll, unionAll, unionAll, uniqueResult, with, with, with, withRecursive, withRecursive, withRecursive

Methods inherited from class com.mysema.query.support.ProjectableQuery

map, notExists, singleResult, singleResult, transform, uniqueResult

Methods inherited from class com.mysema.query.support.QueryBase

distinct, equals, groupBy, groupBy, hashCode, having, having, limit, offset, orderBy, orderBy, restrict, set, where, where

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.mysema.query.Query

groupBy, having

Methods inherited from interface com.mysema.query.SimpleQuery

distinct, limit, offset, orderBy, restrict, set

Methods inherited from interface com.mysema.query.FilteredClause

where

Field Detail

listeners

protected SQLListeners listeners

useLiterals

protected boolean useLiterals

Constructor Detail

AbstractSQLQuery

public AbstractSQLQuery(@Nullable
                        Connection conn,
                        Configuration configuration)

AbstractSQLQuery

public AbstractSQLQuery(@Nullable
                        Connection conn,
                        Configuration configuration,
                        QueryMetadata metadata)

Method Detail

addListener

public void addListener(SQLListener listener)

Parameters:

listener -

count

public long count()

Description copied from interface: Projectable

return the amount of matched rows

Specified by:

count in interface Projectable

Overrides:

count in class ProjectableSQLQuery<Q extends AbstractSQLQuery<Q>>

forUpdate

public Q forUpdate()

If you use forUpdate() with a backend that uses page or row locks, rows examined by the query are write-locked until the end of the current transaction. Not supported for SQLite and CUBRID

Returns:

createSerializer

protected SQLSerializer createSerializer()

Specified by:

createSerializer in class ProjectableSQLQuery<Q extends AbstractSQLQuery<Q>>

startContext

protected SQLListenerContextImpl startContext(Connection connection,
                                              QueryMetadata metadata)

Called to create and start a new SQL Listener context

Parameters:

connection - the database connection

metadata - the meta data for that context

Returns:

the newly started context

onException

protected void onException(SQLListenerContextImpl context,
                           Exception e)

Called to make the call back to listeners when an exception happens

Parameters:

context - the current context in play

e - the exception

endContext

protected void endContext(SQLListenerContext context)

Called to end a SQL listener context

Parameters:

context - the listener context to end

getResults

public ResultSet getResults(Expression<?>... exprs)

Get the results as an JDBC result set

Parameters:

exprs - the expression arguments to retrieve

Returns:

getConfiguration

protected Configuration getConfiguration()

iterate

public <RT> com.mysema.commons.lang.CloseableIterator<RT> iterate(Expression<RT> expr)

Description copied from interface: Projectable

iterate over the results for the given projection

Type Parameters:

RT - generic type of the Iterator

Returns:

an Iterator over the projection

list

public <RT> List<RT> list(Expression<RT> expr)

Description copied from interface: Projectable

list the results for the given projection An empty list is returned for no results.

Specified by:

list in interface Projectable

Overrides:

list in class ProjectableQuery<Q extends AbstractSQLQuery<Q>>

Type Parameters:

RT - generic type of the List

Returns:

a List over the projection

listResults

public <RT> SearchResults<RT> listResults(Expression<RT> expr)

Description copied from interface: Projectable

list the results for the given projection

Returns:

setParameters

protected void setParameters(PreparedStatement stmt,
                             List<?> objects,
                             List<Path<?>> constantPaths,
                             Map<ParamExpression<?>,?> params)

uniqueResult

public <RT> RT uniqueResult(Expression<RT> expr)

Description copied from interface: Projectable

return a unique result for the given projection or null if no result is found

There is some ambiguity for missing results and null valued results, for disambiguation use the list or iterate methods instead.

Specified by:

uniqueResult in interface Projectable

Overrides:

uniqueResult in class ProjectableSQLQuery<Q extends AbstractSQLQuery<Q>>

Type Parameters:

RT - return type

Returns:

the result or null for an empty result

logQuery

protected void logQuery(String queryString,
                        Collection<Object> parameters)

cleanupMDC

protected void cleanupMDC()

setUseLiterals

public void setUseLiterals(boolean useLiterals)

clone

protected void clone(Q query)

Overrides:

clone in class ProjectableSQLQuery<Q extends AbstractSQLQuery<Q>>

clone

public Q clone()

Specified by:

clone in class ProjectableSQLQuery<Q extends AbstractSQLQuery<Q>>

clone

public abstract Q clone(Connection connection)

setStatementOptions

public void setStatementOptions(StatementOptions statementOptions)