org.datanucleus.store.rdbms.sql

Class SQLStatement

java.lang.Object

org.datanucleus.store.rdbms.sql.SQLStatement

public class SQLStatement
extends Object

Class providing an API for generating SQL statements. Caller should create the SQLStatement object and (optionally) call setClassLoaderResolver() to set any class loading restriction. Then the caller builds up the statement using the various methods, and accesses the SQL statement using getStatement(). Generated statement is of the form :-

 SELECT {expr}, {expr}, ...
 FROM {tblExpr} [joinInfo {tblExpr} ON ...] ...
 WHERE {boolExpr} [AND|OR] {boolExpr} ...
 GROUP BY {expr}, {expr}
 HAVING {boolExpr}
 ORDER BY {expr} [ASC|DESC], {expr} [ASC|DESC], ...
 

and also supports UNIONs between SQLStatements, and having sub-queries of other SQLStatements. Alternatively, for an UPDATE,

 UPDATE {tbl}
 SET {expr}={val}, {expr}={val}, ...
 WHERE {boolExpr} [AND|OR] {boolExpr} ...
 

The generated SQL is cached. Any use of a mutating method, changing the composition of the statement will clear the cached SQL, and it will be regenerated when

getStatement

is called next.

Table Groups

When tables are registered in the statement they are split into "table groups". A table group is, in simple terms, an object in the query. If a table has a super-table and a field of the object is selected that is in the super-table then the super-table is added to the table group. If there is a join to a related object then the table of this object will be put in a new table group. So the same datastore table can appear multiple times in the statement, each time for a different object.

Table Aliases

All methods that cause a new SQLTable to be created also allow specification of the table alias in the statement. Where the alias is not provided then we use a table "namer" (definable on the plugin-point "org.datanucleus.store.rdbms.sql_tablenamer"). The table namer can define names simply based on the table number, or based on table group and the number of tables in the group etc etc. To select a particular table "namer", set the extension "datanucleus.sqlTableNamingStrategy" to the key of the namer plugin. The default is "alpha-scheme" which bases table names on the group and number in that group. Note that this class is not intended to be thread-safe. It is used by a single ExecutionContext

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SQLStatement.SelectedItem

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	aggregated whether there is an aggregate expression present in the select
protected String	candidateClassName Name of class that this statement selects (optional, only typically for unioned statements).
protected org.datanucleus.ClassLoaderResolver	clr ClassLoader resolver to use.
protected boolean	distinct Whether the statement is distinct.
static String	EXTENSION_SQL_TABLE_NAMING_STRATEGY
protected Map<String,Object>	extensions Map of extensions for use in generating the SQL, keyed by the extension name.
protected List<SQLExpression>	groupingExpressions Expression(s) for the GROUP BY clause.
protected BooleanExpression	having Having clause.
protected List<SQLJoin>	joins List of joins for this statement.
protected SQLTableNamer	namer
protected boolean[]	orderingDirections Directions for any ORDER BY expressions (1 for each orderingExpressions entry).
protected SQLExpression[]	orderingExpressions Expressions for any ORDER BY clause.
protected org.datanucleus.query.NullOrderingType[]	orderNullDirectives Directives for null handling of any ORDER BY expressions (1 for each orderingExpressions entry).
protected SQLStatement	parent Parent statement, if this is a subquery.
protected SQLTable	primaryTable Primary table for this statement.
protected QueryGenerator	queryGenerator Context of any query generation.
protected long	rangeCount The number of records to be retrieved in any range restriction.
protected long	rangeOffset The offset for any range restriction.
protected RDBMSStoreManager	rdbmsMgr Manager for the RDBMS datastore.
protected boolean	requiresJoinReorder
protected List<SQLStatement.SelectedItem>	selectedItems List of select objects.
protected SQLText	sql Cached SQL statement, generated by getStatement().
protected Map<String,SQLTableGroup>	tableGroups Map of table groups keyed by the group name.
protected static Map<String,SQLTableNamer>	tableNamerByName Map of SQLTable naming instance keyed by the name of the naming scheme.
protected Map<String,SQLTable>	tables Map of tables referenced in this statement, keyed by their alias.
protected List<SQLStatement>	unions List of unioned SQLStatements (if any).
protected SQLExpression[]	updates Array of update expressions when the statement is an UPDATE.
protected BooleanExpression	where Where clause.

Constructor Summary

Constructors

Constructor and Description
SQLStatement(RDBMSStoreManager rdbmsMgr, Table table, DatastoreIdentifier alias, String tableGroupName) Constructor for an SQL statement.
SQLStatement(RDBMSStoreManager rdbmsMgr, Table table, DatastoreIdentifier alias, String tableGroupName, Map<String,Object> extensions) Constructor for an SQL statement.
SQLStatement(SQLStatement parentStmt, RDBMSStoreManager rdbmsMgr, Table table, DatastoreIdentifier alias, String tableGroupName) Constructor for an SQL statement that is a subquery of another statement.
SQLStatement(SQLStatement parentStmt, RDBMSStoreManager rdbmsMgr, Table table, DatastoreIdentifier alias, String tableGroupName, Map<String,Object> extensions) Constructor for an SQL statement that is a subquery of another statement.

Method Summary

Modifier and Type	Method and Description
void	addExtension(String key, Object value) Method to define an extension for this query statement allowing control over its behaviour in generating a query.
void	addGroupingExpression(SQLExpression expr) Method to add a grouping expression to the query.
protected void	addJoin(SQLJoin.JoinType joinType, SQLTable sourceTable, JavaTypeMapping sourceMapping, JavaTypeMapping sourceParentMapping, SQLTable targetTable, JavaTypeMapping targetMapping, JavaTypeMapping targetParentMapping, Object[] discrimValues) Internal method to form a join to the specified table using the provided mappings.
protected void	addOrderComponent(SQLText orderST, String orderString, SQLExpression orderExpr, boolean orderDirection, org.datanucleus.query.NullOrderingType orderNullDirective, DatastoreAdapter dba)
protected void	addOrderingColumnsToSelect() Convenience method to add any necessary columns to the SELECT that are needed by the ordering constraint.
boolean	allUnionsForSamePrimaryTable() Convenience accessor for whether all unions of this statement are for the same primary table.
SQLTable	crossJoin(Table target, String targetAlias, String tableGrpName) Method to form a right outer join to the specified table using the provided mappings.
protected SQLText	generateOrderingStatement() Convenience method to generate the ordering statement to add to the overall query statement.
String	getCandidateClassName()
org.datanucleus.ClassLoaderResolver	getClassLoaderResolver()
DatastoreAdapter	getDatastoreAdapter()
SQLText	getDeleteStatement() Accessor for the SQL DELETE statement.
protected BooleanExpression	getJoinConditionForJoin(SQLTable sourceTable, JavaTypeMapping sourceMapping, JavaTypeMapping sourceParentMapping, SQLTable targetTable, JavaTypeMapping targetMapping, JavaTypeMapping targetParentMapping, Object[] discrimValues) Convenience method to generate the join condition between source and target tables for the supplied mappings.
SQLJoin	getJoinForTable(SQLTable sqlTbl) Accessor for the type of join used for the specified table.
SQLJoin.JoinType	getJoinTypeForTable(SQLTable sqlTbl) Accessor for the type of join used for the specified table.
int	getNumberOfSelects() Accessor for the number of selected items in the SELECT clause.
int	getNumberOfTableGroups() Accessor for the number of table groups.
int	getNumberOfTables() Accessor for the number of tables defined for this statement.
int	getNumberOfUnions()
SQLStatement	getParentStatement()
SQLTable	getPrimaryTable() Accessor for the primary table of the statement.
QueryGenerator	getQueryGenerator()
RDBMSStoreManager	getRDBMSManager()
SQLText	getSelectStatement() Accessor for the SQL SELECT statement.
SQLExpressionFactory	getSQLExpressionFactory()
SQLTable	getTable(String alias) Accessor for the SQLTable object with the specified alias (if defined for this statement).
SQLTable	getTable(Table table, String groupName) Accessor for the SQLTable object for the specified table (if defined for this statement) in the specified table group.
SQLTable	getTableForDatastoreContainer(Table table) Convenience method to find a registered SQLTable that is for the specified table
SQLTableGroup	getTableGroup(String groupName) Accessor for the table group with this name.
protected SQLTableNamer	getTableNamer(String namingSchema) Method to return the namer for a particular schema.
List<SQLStatement>	getUnions() Accessor for the unioned statements.
SQLText	getUpdateStatement() Accessor for the SQL UPDATE statement.
Object	getValueForExtension(String key) Accessor for the value for an extension.
boolean	hasUpdates()
SQLTable	innerJoin(SQLTable sourceTable, JavaTypeMapping sourceMapping, JavaTypeMapping sourceParentMapping, Table target, String targetAlias, JavaTypeMapping targetMapping, JavaTypeMapping targetParentMapping, Object[] discrimValues, String tableGrpName) Method to form an inner join to the specified table using the provided mappings.
SQLTable	innerJoin(SQLTable sourceTable, JavaTypeMapping sourceMapping, Table target, String targetAlias, JavaTypeMapping targetMapping, Object[] discrimValues, String tableGrpName) Method to form an inner join to the specified table using the provided mappings.
protected void	invalidateStatement() Method to uncache the generated SQL (because some condition has changed).
boolean	isChildStatementOf(SQLStatement stmt) Convenience method to return if this statement is a child (inner) statement of the supplied statement.
boolean	isDistinct() Accessor for whether the statement restricts the results to distinct.
SQLTable	join(SQLJoin.JoinType joinType, SQLTable sourceTable, JavaTypeMapping sourceMapping, JavaTypeMapping sourceParentMapping, Table target, String targetAlias, JavaTypeMapping targetMapping, JavaTypeMapping targetParentMapping, Object[] discrimValues, String tableGrpName, boolean applyToUnions) Method to form a join to the specified table using the provided mappings.
SQLTable	join(SQLJoin.JoinType joinType, SQLTable sourceTable, JavaTypeMapping sourceMapping, Table target, String targetAlias, JavaTypeMapping targetMapping, Object[] discrimValues, String tableGrpName) Method to form a join to the specified table using the provided mappings, with the join also being applied to any UNIONed statements.
SQLTable	join(SQLJoin.JoinType joinType, SQLTable sourceTable, JavaTypeMapping sourceMapping, Table target, String targetAlias, JavaTypeMapping targetMapping, Object[] discrimValues, String tableGrpName, boolean applyToUnions) Method to form a join to the specified table using the provided mappings.
SQLTable	leftOuterJoin(SQLTable sourceTable, JavaTypeMapping sourceMapping, JavaTypeMapping sourceParentMapping, Table target, String targetAlias, JavaTypeMapping targetMapping, JavaTypeMapping targetParentMapping, Object[] discrimValues, String tableGrpName) Method to form a left outer join to the specified table using the provided mappings.
SQLTable	leftOuterJoin(SQLTable sourceTable, JavaTypeMapping sourceMapping, Table target, String targetAlias, JavaTypeMapping targetMapping, Object[] discrimValues, String tableGrpName) Method to form a left outer join to the specified table using the provided mappings.
void	log(org.datanucleus.util.NucleusLogger logger) Method to dump the statement to the supplied log (debug level).
String	removeCrossJoin(SQLTable targetSqlTbl) Method to remove a cross join for the specified table (if joined via cross join).
SQLTable	rightOuterJoin(SQLTable sourceTable, JavaTypeMapping sourceMapping, JavaTypeMapping sourceParentMapping, Table target, String targetAlias, JavaTypeMapping targetMapping, JavaTypeMapping targetParentMapping, Object[] discrimValues, String tableGrpName) Method to form a right outer join to the specified table using the provided mappings.
SQLTable	rightOuterJoin(SQLTable sourceTable, JavaTypeMapping sourceMapping, Table target, String targetAlias, JavaTypeMapping targetMapping, Object[] discrimValues, String tableGrpName) Method to form a right outer join to the specified table using the provided mappings.
int[]	select(SQLExpression expr, String alias) Select an expression.
int	select(SQLTable table, Column column, String alias) Add a select clause for the specified column.
int[]	select(SQLTable table, JavaTypeMapping mapping, String alias) Add a select clause for the specified field (via its mapping) and apply to unions.
int[]	select(SQLTable table, JavaTypeMapping mapping, String alias, boolean applyToUnions) Add a select clause for the specified field (via its mapping).
void	setCandidateClassName(String name)
void	setClassLoaderResolver(org.datanucleus.ClassLoaderResolver clr)
void	setDistinct(boolean distinct) Mutator for whether the query returns distinct results.
void	setHaving(BooleanExpression expr) Mutator for the "having" expression.
void	setOrdering(SQLExpression[] exprs, boolean[] descending) Mutator for the ordering criteria.
void	setOrdering(SQLExpression[] exprs, boolean[] descending, org.datanucleus.query.NullOrderingType[] nullOrders) Mutator for the ordering criteria.
void	setQueryGenerator(QueryGenerator gen)
void	setRange(long offset, long count) Method to add a range constraint on any SELECT.
void	setUpdates(SQLExpression[] exprs) Method to set the UPDATE clause of the statement.
void	union(SQLStatement stmt) Method to union this SQL statement with another SQL statement.
void	whereAnd(BooleanExpression expr, boolean applyToUnions) Method to add an AND condition to the WHERE clause.
void	whereOr(BooleanExpression expr, boolean applyToUnions) Method to add an OR condition to the WHERE clause.

Methods inherited from class java.lang.Object

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

Field Detail

EXTENSION_SQL_TABLE_NAMING_STRATEGY

public static final String EXTENSION_SQL_TABLE_NAMING_STRATEGY

See Also:

Constant Field Values

tableNamerByName

protected static final Map<String,SQLTableNamer> tableNamerByName

Map of SQLTable naming instance keyed by the name of the naming scheme.

sql

protected SQLText sql

Cached SQL statement, generated by getStatement().

rdbmsMgr

protected RDBMSStoreManager rdbmsMgr

Manager for the RDBMS datastore.

clr

protected org.datanucleus.ClassLoaderResolver clr

ClassLoader resolver to use. Used by sub-expressions. Defaults to the loader resolver for the store manager.

queryGenerator

protected QueryGenerator queryGenerator

Context of any query generation.

namer

protected SQLTableNamer namer

candidateClassName

protected String candidateClassName

Name of class that this statement selects (optional, only typically for unioned statements).

distinct

protected boolean distinct

Whether the statement is distinct.

extensions

protected Map<String,Object> extensions

Map of extensions for use in generating the SQL, keyed by the extension name.

parent

protected SQLStatement parent

Parent statement, if this is a subquery. Must be set at construction.

unions

protected List<SQLStatement> unions

List of unioned SQLStatements (if any).

selectedItems

protected List<SQLStatement.SelectedItem> selectedItems

List of select objects.

updates

protected SQLExpression[] updates

Array of update expressions when the statement is an UPDATE.

aggregated

protected boolean aggregated

whether there is an aggregate expression present in the select

primaryTable

protected SQLTable primaryTable

Primary table for this statement.

joins

protected List<SQLJoin> joins

List of joins for this statement.

requiresJoinReorder

protected boolean requiresJoinReorder

tables

protected Map<String,SQLTable> tables

Map of tables referenced in this statement, keyed by their alias.

tableGroups

protected Map<String,SQLTableGroup> tableGroups

Map of table groups keyed by the group name.

where

protected BooleanExpression where

Where clause.

groupingExpressions

protected List<SQLExpression> groupingExpressions

Expression(s) for the GROUP BY clause.

having

protected BooleanExpression having

Having clause.

orderingExpressions

protected SQLExpression[] orderingExpressions

Expressions for any ORDER BY clause.

orderingDirections

protected boolean[] orderingDirections

Directions for any ORDER BY expressions (1 for each orderingExpressions entry).

orderNullDirectives

protected org.datanucleus.query.NullOrderingType[] orderNullDirectives

Directives for null handling of any ORDER BY expressions (1 for each orderingExpressions entry).

rangeOffset

protected long rangeOffset

The offset for any range restriction.

rangeCount

protected long rangeCount

The number of records to be retrieved in any range restriction.

Constructor Detail

SQLStatement

public SQLStatement(RDBMSStoreManager rdbmsMgr,
                    Table table,
                    DatastoreIdentifier alias,
                    String tableGroupName)

Constructor for an SQL statement.

Parameters:

rdbmsMgr - The datastore manager

table - The primary table

alias - Alias for this table

tableGroupName - Name of candidate table-group (if any). Uses "Group0" if not provided

SQLStatement

public SQLStatement(RDBMSStoreManager rdbmsMgr,
                    Table table,
                    DatastoreIdentifier alias,
                    String tableGroupName,
                    Map<String,Object> extensions)

Constructor for an SQL statement.

Parameters:

rdbmsMgr - The datastore manager

table - The primary table

alias - Alias for this table

tableGroupName - Name of candidate table-group (if any). Uses "Group0" if not provided

extensions - Optional extensions

SQLStatement

public SQLStatement(SQLStatement parentStmt,
                    RDBMSStoreManager rdbmsMgr,
                    Table table,
                    DatastoreIdentifier alias,
                    String tableGroupName)

Constructor for an SQL statement that is a subquery of another statement.

Parameters:

parentStmt - Parent statement

rdbmsMgr - The datastore manager

table - The primary table

alias - Alias for this table

tableGroupName - Name of candidate table-group (if any). Uses "Group0" if not provided

SQLStatement

public SQLStatement(SQLStatement parentStmt,
                    RDBMSStoreManager rdbmsMgr,
                    Table table,
                    DatastoreIdentifier alias,
                    String tableGroupName,
                    Map<String,Object> extensions)

Constructor for an SQL statement that is a subquery of another statement.

Parameters:

parentStmt - Parent statement

rdbmsMgr - The datastore manager

table - The primary table

alias - Alias for this table

tableGroupName - Name of candidate table-group (if any). Uses "Group0" if not provided

extensions - Optional extensions

Method Detail

getRDBMSManager

public RDBMSStoreManager getRDBMSManager()

setClassLoaderResolver

public void setClassLoaderResolver(org.datanucleus.ClassLoaderResolver clr)

getClassLoaderResolver

public org.datanucleus.ClassLoaderResolver getClassLoaderResolver()

setCandidateClassName

public void setCandidateClassName(String name)

getCandidateClassName

public String getCandidateClassName()

getQueryGenerator

public QueryGenerator getQueryGenerator()

setQueryGenerator

public void setQueryGenerator(QueryGenerator gen)

getSQLExpressionFactory

public SQLExpressionFactory getSQLExpressionFactory()

getDatastoreAdapter

public DatastoreAdapter getDatastoreAdapter()

getParentStatement

public SQLStatement getParentStatement()

isChildStatementOf

public boolean isChildStatementOf(SQLStatement stmt)

Convenience method to return if this statement is a child (inner) statement of the supplied statement.

Parameters:

stmt - The statement that may be parent, grandparent etc of this statement

Returns:

Whether this is a child of the supplied statement

addExtension

public void addExtension(String key,
                         Object value)

Method to define an extension for this query statement allowing control over its behaviour in generating a query.

Parameters:

key - Extension key

value - Value for the key

getValueForExtension

public Object getValueForExtension(String key)

Accessor for the value for an extension.

Parameters:

key - Key for the extension

Returns:

Value for the extension (if any)

union

public void union(SQLStatement stmt)

Method to union this SQL statement with another SQL statement.

Parameters:

stmt - The other SQL statement to union

getNumberOfUnions

public int getNumberOfUnions()

getUnions

public List<SQLStatement> getUnions()

Accessor for the unioned statements.

Returns:

The unioned SQLStatements

allUnionsForSamePrimaryTable

public boolean allUnionsForSamePrimaryTable()

Convenience accessor for whether all unions of this statement are for the same primary table.

Returns:

Whether all unions have the same primary table

isDistinct

public boolean isDistinct()

Accessor for whether the statement restricts the results to distinct.

Returns:

Whether results are distinct

setDistinct

public void setDistinct(boolean distinct)

Mutator for whether the query returns distinct results.

Parameters:

distinct - Whether to return distinct

getNumberOfSelects

public int getNumberOfSelects()

Accessor for the number of selected items in the SELECT clause.

Returns:

Number of selected items

select

public int[] select(SQLExpression expr,
                    String alias)

Select an expression. This will be used when adding aggregates to the select clause (e.g "COUNT(*)").

Parameters:

expr - The expression to add to the select statement

alias - Optional alias for this selected expression

Returns:

The index(es) of the expression in the select

select

public int[] select(SQLTable table,
                    JavaTypeMapping mapping,
                    String alias,
                    boolean applyToUnions)

Add a select clause for the specified field (via its mapping). If an alias is supplied and there are more than 1 column for this mapping then they will have names like "{alias}_n" where n is the column number (starting at 0).

Parameters:

table - The SQLTable to select from (null implies the primary table)

mapping - The mapping for the field

alias - optional alias

applyToUnions - Whether to apply to unions

Returns:

The column index(es) in the statement for the specified field (1 is first).

select

public int[] select(SQLTable table,
                    JavaTypeMapping mapping,
                    String alias)

Add a select clause for the specified field (via its mapping) and apply to unions. If an alias is supplied and there are more than 1 column for this mapping then they will have names like "{alias}_n" where n is the column number (starting at 0).

Parameters:

table - The SQLTable to select from (null implies the primary table)

mapping - The mapping for the field

alias - optional alias

Returns:

The column index(es) in the statement for the specified field (1 is first).

select

public int select(SQLTable table,
                  Column column,
                  String alias)

Add a select clause for the specified column.

Parameters:

table - The SQLTable to select from (null implies the primary table)

column - The column

alias - Optional alias

Returns:

The column index in the statement for the specified column (1 is first).

setUpdates

public void setUpdates(SQLExpression[] exprs)

Method to set the UPDATE clause of the statement.

Parameters:

exprs - The update clause expression

hasUpdates

public boolean hasUpdates()

getPrimaryTable

public SQLTable getPrimaryTable()

Accessor for the primary table of the statement.

Returns:

The primary table

getTable

public SQLTable getTable(String alias)

Accessor for the SQLTable object with the specified alias (if defined for this statement).

Parameters:

alias - Alias

Returns:

The SQLTable

getTableForDatastoreContainer

public SQLTable getTableForDatastoreContainer(Table table)

Convenience method to find a registered SQLTable that is for the specified table

Parameters:

table - The table

Returns:

The SQLTable (or null if not referenced)

getTable

public SQLTable getTable(Table table,
                         String groupName)

Accessor for the SQLTable object for the specified table (if defined for this statement) in the specified table group.

Parameters:

table - The table

groupName - Name of the table group where we should look for this table

Returns:

The SQLTable (if found)

getTableGroup

public SQLTableGroup getTableGroup(String groupName)

Accessor for the table group with this name.

Parameters:

groupName - Name of the group

Returns:

The table group

getNumberOfTableGroups

public int getNumberOfTableGroups()

Accessor for the number of table groups.

Returns:

Number of table groups (including that of the candidate)

getNumberOfTables

public int getNumberOfTables()

Accessor for the number of tables defined for this statement.

Returns:

Number of tables (in addition to the primary table)

join

public SQLTable join(SQLJoin.JoinType joinType,
                     SQLTable sourceTable,
                     JavaTypeMapping sourceMapping,
                     Table target,
                     String targetAlias,
                     JavaTypeMapping targetMapping,
                     Object[] discrimValues,
                     String tableGrpName)

Method to form a join to the specified table using the provided mappings, with the join also being applied to any UNIONed statements.

Parameters:

joinType - Type of join.

sourceTable - SQLTable for the source (null implies primaryTable)

sourceMapping - Mapping in this table to join from

target - Table to join to

targetAlias - Alias for the target table (if known)

targetMapping - Mapping in the other table to join to (also defines the table to join to)

discrimValues - Any discriminator values to apply for the joined table (null if not)

tableGrpName - Name of the table group for the target (null implies a new group)

Returns:

SQLTable for the target

join

public SQLTable join(SQLJoin.JoinType joinType,
                     SQLTable sourceTable,
                     JavaTypeMapping sourceMapping,
                     Table target,
                     String targetAlias,
                     JavaTypeMapping targetMapping,
                     Object[] discrimValues,
                     String tableGrpName,
                     boolean applyToUnions)

Method to form a join to the specified table using the provided mappings.

Parameters:

joinType - Type of join.

sourceTable - SQLTable for the source (null implies primaryTable)

sourceMapping - Mapping in this table to join from

target - Table to join to

targetAlias - Alias for the target table (if known)

targetMapping - Mapping in the other table to join to (also defines the table to join to)

discrimValues - Any discriminator values to apply for the joined table (null if not)

tableGrpName - Name of the table group for the target (null implies a new group)

applyToUnions - Whether to apply to any unioned statements

Returns:

SQLTable for the target

join

public SQLTable join(SQLJoin.JoinType joinType,
                     SQLTable sourceTable,
                     JavaTypeMapping sourceMapping,
                     JavaTypeMapping sourceParentMapping,
                     Table target,
                     String targetAlias,
                     JavaTypeMapping targetMapping,
                     JavaTypeMapping targetParentMapping,
                     Object[] discrimValues,
                     String tableGrpName,
                     boolean applyToUnions)

Method to form a join to the specified table using the provided mappings.

Parameters:

joinType - Type of join.

sourceTable - SQLTable for the source (null implies primaryTable)

sourceMapping - Mapping in this table to join from

sourceParentMapping - Optional, if this source mapping is a sub mapping (e.g interface impl).

target - Table to join to

targetAlias - Alias for the target table (if known)

targetMapping - Mapping in the other table to join to (also defines the table to join to)

targetParentMapping - Optional, if this source mapping is a sub mapping (e.g interface impl).

discrimValues - Any discriminator values to apply for the joined table (null if not)

tableGrpName - Name of the table group for the target (null implies a new group)

applyToUnions - Whether to apply to any unioned statements

Returns:

SQLTable for the target

innerJoin

public SQLTable innerJoin(SQLTable sourceTable,
                          JavaTypeMapping sourceMapping,
                          Table target,
                          String targetAlias,
                          JavaTypeMapping targetMapping,
                          Object[] discrimValues,
                          String tableGrpName)

Method to form an inner join to the specified table using the provided mappings. Will be applied to all unioned statements.

Parameters:

sourceTable - SQLTable for the source (null implies primaryTable)

sourceMapping - Mapping in this table to join from

target - Table to join to

targetAlias - Alias for the target table (if known)

targetMapping - Mapping in the other table to join to (also defines the table to join to)

discrimValues - Any discriminator values to apply for the joined table (null if not)

tableGrpName - Name of the table group for the target (null implies a new group)

Returns:

SQLTable for the target

innerJoin

public SQLTable innerJoin(SQLTable sourceTable,
                          JavaTypeMapping sourceMapping,
                          JavaTypeMapping sourceParentMapping,
                          Table target,
                          String targetAlias,
                          JavaTypeMapping targetMapping,
                          JavaTypeMapping targetParentMapping,
                          Object[] discrimValues,
                          String tableGrpName)

Method to form an inner join to the specified table using the provided mappings. Will be applied to all unioned statements.

Parameters:

sourceTable - SQLTable for the source (null implies primaryTable)

sourceMapping - Mapping in this table to join from

sourceParentMapping - Optional, if this source mapping is a sub mapping (e.g interface impl).

target - Table to join to

targetAlias - Alias for the target table (if known)

targetMapping - Mapping in the other table to join to (also defines the table to join to)

targetParentMapping - Optional, if this source mapping is a sub mapping (e.g interface impl).

discrimValues - Any discriminator values to apply for the joined table (null if not)

tableGrpName - Name of the table group for the target (null implies a new group)

Returns:

SQLTable for the target

leftOuterJoin

public SQLTable leftOuterJoin(SQLTable sourceTable,
                              JavaTypeMapping sourceMapping,
                              Table target,
                              String targetAlias,
                              JavaTypeMapping targetMapping,
                              Object[] discrimValues,
                              String tableGrpName)

Method to form a left outer join to the specified table using the provided mappings. Will be applied to all unioned statements.

Parameters:

sourceTable - SQLTable for the source (null implies primaryTable)

sourceMapping - Mapping in this table to join from

target - Table to join to

targetAlias - Alias for the target table (if known)

targetMapping - Mapping in the other table to join to (also defines the table to join to)

discrimValues - Any discriminator values to apply for the joined table (null if not)

tableGrpName - Name of the table group for the target (null implies a new group)

Returns:

SQLTable for the target

leftOuterJoin

public SQLTable leftOuterJoin(SQLTable sourceTable,
                              JavaTypeMapping sourceMapping,
                              JavaTypeMapping sourceParentMapping,
                              Table target,
                              String targetAlias,
                              JavaTypeMapping targetMapping,
                              JavaTypeMapping targetParentMapping,
                              Object[] discrimValues,
                              String tableGrpName)

Method to form a left outer join to the specified table using the provided mappings. Will be applied to all unioned statements.

Parameters:

sourceTable - SQLTable for the source (null implies primaryTable)

sourceMapping - Mapping in this table to join from

sourceParentMapping - Optional, if this source mapping is a sub mapping (e.g interface impl).

target - Table to join to

targetAlias - Alias for the target table (if known)

targetMapping - Mapping in the other table to join to (also defines the table to join to)

targetParentMapping - Optional, if this source mapping is a sub mapping (e.g interface impl).

discrimValues - Any discriminator values to apply for the joined table (null if not)

tableGrpName - Name of the table group for the target (null implies a new group)

Returns:

SQLTable for the target

rightOuterJoin

public SQLTable rightOuterJoin(SQLTable sourceTable,
                               JavaTypeMapping sourceMapping,
                               Table target,
                               String targetAlias,
                               JavaTypeMapping targetMapping,
                               Object[] discrimValues,
                               String tableGrpName)

Method to form a right outer join to the specified table using the provided mappings. Will be applied to all unioned statements.

Parameters:

sourceTable - SQLTable for the source (null implies primaryTable)

sourceMapping - Mapping in this table to join from

target - Table to join to

targetAlias - Alias for the target table (if known)

targetMapping - Mapping in the other table to join to (also defines the table to join to)

discrimValues - Any discriminator values to apply for the joined table (null if not)

tableGrpName - Name of the table group for the target (null implies a new group)

Returns:

SQLTable for the target

rightOuterJoin

public SQLTable rightOuterJoin(SQLTable sourceTable,
                               JavaTypeMapping sourceMapping,
                               JavaTypeMapping sourceParentMapping,
                               Table target,
                               String targetAlias,
                               JavaTypeMapping targetMapping,
                               JavaTypeMapping targetParentMapping,
                               Object[] discrimValues,
                               String tableGrpName)

Method to form a right outer join to the specified table using the provided mappings. Will be applied to all unioned statements.

Parameters:

sourceTable - SQLTable for the source (null implies primaryTable)

sourceMapping - Mapping in this table to join from

sourceParentMapping - mapping for the parent of the source

target - Table to join to

targetAlias - Alias for the target table (if known)

targetMapping - Mapping in the other table to join to (also defines the table to join to)

targetParentMapping - mapping for the parent of the target

discrimValues - Any discriminator values to apply for the joined table (null if not)

tableGrpName - Name of the table group for the target (null implies a new group)

Returns:

SQLTable for the target

crossJoin

public SQLTable crossJoin(Table target,
                          String targetAlias,
                          String tableGrpName)

Method to form a right outer join to the specified table using the provided mappings. Will be applied to all unioned statements.

Parameters:

target - Table to join to

targetAlias - Alias for the target table (if known)

tableGrpName - Name of the table group for the target (null implies a new group)

Returns:

SQLTable for the target

getJoinTypeForTable

public SQLJoin.JoinType getJoinTypeForTable(SQLTable sqlTbl)

Accessor for the type of join used for the specified table.

Parameters:

sqlTbl - The table to check

Returns:

The join type, or null if not joined in this statement

getJoinForTable

public SQLJoin getJoinForTable(SQLTable sqlTbl)

Accessor for the type of join used for the specified table.

Parameters:

sqlTbl - The table to check

Returns:

The join type, or null if not joined in this statement

removeCrossJoin

public String removeCrossJoin(SQLTable targetSqlTbl)

Method to remove a cross join for the specified table (if joined via cross join). Also removes the table from the list of tables. This is called where we have bound a variable via a CROSS JOIN (in the absence of better information) and found out later it could become an INNER JOIN. If the supplied table is not joined via a cross join then does nothing.

Parameters:

targetSqlTbl - The table to drop the cross join for

Returns:

The removed alias

addJoin

protected void addJoin(SQLJoin.JoinType joinType,
                       SQLTable sourceTable,
                       JavaTypeMapping sourceMapping,
                       JavaTypeMapping sourceParentMapping,
                       SQLTable targetTable,
                       JavaTypeMapping targetMapping,
                       JavaTypeMapping targetParentMapping,
                       Object[] discrimValues)

Internal method to form a join to the specified table using the provided mappings.

Parameters:

joinType - Type of join (INNER, LEFT OUTER, RIGHT OUTER, CROSS, NON-ANSI)

sourceTable - SQLTable to join from

sourceMapping - Mapping in this table to join from

sourceParentMapping - Optional parent of this source mapping (when joining an impl of an interface)

targetTable - SQLTable to join to

targetMapping - Mapping in the other table to join to (also defines the table to join to)

targetParentMapping - Optional parent of this target mapping (when joining an impl of an interface)

discrimValues - Any discriminator values to apply for the joined table (null if not)

getJoinConditionForJoin

protected BooleanExpression getJoinConditionForJoin(SQLTable sourceTable,
                                                    JavaTypeMapping sourceMapping,
                                                    JavaTypeMapping sourceParentMapping,
                                                    SQLTable targetTable,
                                                    JavaTypeMapping targetMapping,
                                                    JavaTypeMapping targetParentMapping,
                                                    Object[] discrimValues)

Convenience method to generate the join condition between source and target tables for the supplied mappings.

Parameters:

sourceTable - Source table

sourceMapping - Mapping in source table

sourceParentMapping - Optional parent of this source mapping (if joining an impl of an interface)

targetTable - Target table

targetMapping - Mapping in target table

targetParentMapping - Optional parent of this target mapping (if joining an impl of an interface)

discrimValues - Optional discriminator values to further restrict

Returns:

The join condition

getTableNamer

protected SQLTableNamer getTableNamer(String namingSchema)

Method to return the namer for a particular schema. If there is no instantiated namer for this schema then instantiates one.

Parameters:

namingSchema - Table naming schema to use

Returns:

The namer

whereAnd

public void whereAnd(BooleanExpression expr,
                     boolean applyToUnions)

Method to add an AND condition to the WHERE clause.

Parameters:

expr - The condition

applyToUnions - whether to apply this and to any UNIONs in the statement

whereOr

public void whereOr(BooleanExpression expr,
                    boolean applyToUnions)

Method to add an OR condition to the WHERE clause.

Parameters:

expr - The condition

applyToUnions - Whether to apply to unions

addGroupingExpression

public void addGroupingExpression(SQLExpression expr)

Method to add a grouping expression to the query. Adds the grouping to any unioned queries

Parameters:

expr - The expression

setHaving

public void setHaving(BooleanExpression expr)

Mutator for the "having" expression.

Parameters:

expr - Boolean expression for the having clause

setOrdering

public void setOrdering(SQLExpression[] exprs,
                        boolean[] descending)

Mutator for the ordering criteria.

Parameters:

exprs - The expressions to order by

descending - Whether each expression is ascending/descending

setOrdering

public void setOrdering(SQLExpression[] exprs,
                        boolean[] descending,
                        org.datanucleus.query.NullOrderingType[] nullOrders)

Mutator for the ordering criteria.

Parameters:

exprs - The expressions to order by

descending - Whether each expression is ascending/descending

nullOrders - Ordering for nulls (if provided)

setRange

public void setRange(long offset,
                     long count)

Method to add a range constraint on any SELECT. This typically will use LIMIT/OFFSET where they are supported by the underlying RDBMS.

Parameters:

offset - The offset to start from

count - The number of records to return

getSelectStatement

public SQLText getSelectStatement()

Accessor for the SQL SELECT statement. If any mutator method has been called since this was last called the SQL will be regenerated otherwise the SQL is cached.

Returns:

The SQL statement

getUpdateStatement

public SQLText getUpdateStatement()

Accessor for the SQL UPDATE statement. If any mutator method has been called since this was last called the SQL will be regenerated otherwise the SQL is cached.

Returns:

The SQL statement for UPDATE

getDeleteStatement

public SQLText getDeleteStatement()

Accessor for the SQL DELETE statement. Generates a statement like DELETE FROM tbl1 A0 WHERE A0.xxx = yyy If any mutator method has been called since this was last called the SQL will be regenerated otherwise the SQL is cached.

Returns:

The SQL statement for DELETE

generateOrderingStatement

protected SQLText generateOrderingStatement()

Convenience method to generate the ordering statement to add to the overall query statement.

Returns:

The ordering statement

addOrderComponent

protected void addOrderComponent(SQLText orderST,
                                 String orderString,
                                 SQLExpression orderExpr,
                                 boolean orderDirection,
                                 org.datanucleus.query.NullOrderingType orderNullDirective,
                                 DatastoreAdapter dba)

addOrderingColumnsToSelect

protected void addOrderingColumnsToSelect()

Convenience method to add any necessary columns to the SELECT that are needed by the ordering constraint.

invalidateStatement

protected void invalidateStatement()

Method to uncache the generated SQL (because some condition has changed).

log

public void log(org.datanucleus.util.NucleusLogger logger)

Method to dump the statement to the supplied log (debug level). Logs the (SELECT or UPDATE) SQL that this statement equates to, and the TableGroup(s) and their associated tables.

Parameters:

logger - The logger