com.healthmarketscience.sqlbuilder

Class SetOperationQuery<ThisType extends SetOperationQuery<ThisType>>

java.lang.Object

com.healthmarketscience.common.util.AppendeeObject

com.healthmarketscience.sqlbuilder.SqlObject

com.healthmarketscience.sqlbuilder.CustomizableSqlObject

com.healthmarketscience.sqlbuilder.Query<ThisType>

com.healthmarketscience.sqlbuilder.SetOperationQuery<ThisType>

All Implemented Interfaces:

Appendee, Verifiable<ThisType>

Direct Known Subclasses:

ExceptQuery, IntersectQuery, UnionQuery

public class SetOperationQuery<ThisType extends SetOperationQuery<ThisType>>
extends Query<ThisType>

Base query for queries which generate a series of SELECT queries joined by one or more "set operations", such as UNION [ALL], EXCEPT [ALL], and INTERSECT [ALL].

Author:

James Ahlborn

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SetOperationQuery.Type Enumeration representing the type of union to use

Field Summary

Fields inherited from class com.healthmarketscience.sqlbuilder.SqlObject

ALL_SYMBOL, NULL_VALUE, QUESTION_MARK

Constructor Summary

Constructors

Constructor and Description
SetOperationQuery(SetOperationQuery.Type type)
SetOperationQuery(SetOperationQuery.Type type, Object... queries)

Method Summary

Modifier and Type	Method and Description
ThisType	addCustomOrdering(Object columnStr, OrderObject.Dir dir) Adds the given column with the given direction to the "ORDER BY" clause
ThisType	addCustomOrderings(Object... columnStrs) Adds the given columns to the "ORDER BY" clause
ThisType	addIndexedOrdering(Integer columnIdx, OrderObject.Dir dir) Adds the given column index with the given direction to the "ORDER BY" clause
ThisType	addIndexedOrderings(Integer... columnIdxs) Adds the given column index to the "ORDER BY" clause
ThisType	addOrdering(Column column, OrderObject.Dir dir) Adds the given column with the given direction to the "ORDER BY" clause
ThisType	addOrderings(Column... columns) Adds the given columns to the "ORDER BY" clause
ThisType	addQueries(Object... queries) Adds the given queries to the list of queries with the default set operation type (the one configured in the constructor).
ThisType	addQueries(SelectQuery... queries) Adds the given queries to the list of queries with the default set operation type (the one configured in the constructor).
ThisType	addQueries(SetOperationQuery.Type type, Object... queries) Adds the given queries to the list of queries with the given set operation type.
ThisType	addQueries(SetOperationQuery.Type type, SelectQuery... queries) Adds the given queries to the list of queries with the given set operation type.
protected void	appendTo(AppendableExt app, SqlContext newContext) Appends the sql query to the given AppendableExt within the given, modifiable SqlContext.
protected void	collectSchemaObjects(ValidationContext vContext) Used during Query.validate() calls to collect the dbschema objects referenced in a query.
static ExceptQuery	except() Convenience method to create a EXCEPT query.
static ExceptQuery	except(SelectQuery... queries) Convenience method to create a EXCEPT query.
static ExceptQuery	exceptAll() Convenience method to create a EXCEPT ALL query.
static ExceptQuery	exceptAll(SelectQuery... queries) Convenience method to create a EXCEPT ALL query.
static IntersectQuery	intersect() Convenience method to create a INTERSECT query.
static IntersectQuery	intersect(SelectQuery... queries) Convenience method to create a INTERSECT query.
static IntersectQuery	intersectAll() Convenience method to create a INTERSECT ALL query.
static IntersectQuery	intersectAll(SelectQuery... queries) Convenience method to create a INTERSECT ALL query.
static UnionQuery	union() Convenience method to create a UNION query.
static UnionQuery	union(SelectQuery... queries) Convenience method to create a UNION query.
static UnionQuery	unionAll() Convenience method to create a UNION ALL query.
static UnionQuery	unionAll(SelectQuery... queries) Convenience method to create a UNION ALL query.
void	validate(ValidationContext vContext) Runs validation on this verifiable object using a previously collected ValidationContext.

Methods inherited from class com.healthmarketscience.sqlbuilder.Query

appendTo, getThisType, prependTo, validate, validateTables

Methods inherited from class com.healthmarketscience.sqlbuilder.CustomizableSqlObject

addCustomization, customAppendTo, customAppendTo, maybeAppendTo, maybeAppendTo

Methods inherited from class com.healthmarketscience.sqlbuilder.SqlObject

collectSchemaObjects, doValidate, toString

Methods inherited from class com.healthmarketscience.common.util.AppendeeObject

toString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SetOperationQuery

public SetOperationQuery(SetOperationQuery.Type type)

SetOperationQuery

public SetOperationQuery(SetOperationQuery.Type type,
                         Object... queries)

Method Detail

addQueries

public ThisType addQueries(SelectQuery... queries)

Adds the given queries to the list of queries with the default set operation type (the one configured in the constructor).

addQueries

public ThisType addQueries(SetOperationQuery.Type type,
                           SelectQuery... queries)

Adds the given queries to the list of queries with the given set operation type.

addQueries

public ThisType addQueries(Object... queries)

Adds the given queries to the list of queries with the default set operation type (the one configured in the constructor).

addQueries

public ThisType addQueries(SetOperationQuery.Type type,
                           Object... queries)

Adds the given queries to the list of queries with the given set operation type.

addCustomOrdering

public ThisType addCustomOrdering(Object columnStr,
                                  OrderObject.Dir dir)

Adds the given column with the given direction to the "ORDER BY" clause

Object -> SqlObject conversions handled by Converter.toCustomColumnSqlObject(Object).

addCustomOrderings

public ThisType addCustomOrderings(Object... columnStrs)

Adds the given columns to the "ORDER BY" clause

Note, NULL ordering can be specified by passing an appropriately configured instance of OrderObject to this method.

Object -> SqlObject conversions handled by Converter.CUSTOM_COLUMN_TO_OBJ.

addOrdering

public ThisType addOrdering(Column column,
                            OrderObject.Dir dir)

Adds the given column with the given direction to the "ORDER BY" clause

addOrderings

public ThisType addOrderings(Column... columns)

Adds the given columns to the "ORDER BY" clause

addIndexedOrdering

public ThisType addIndexedOrdering(Integer columnIdx,
                                   OrderObject.Dir dir)

Adds the given column index with the given direction to the "ORDER BY" clause

addIndexedOrderings

public ThisType addIndexedOrderings(Integer... columnIdxs)

Adds the given column index to the "ORDER BY" clause

validate

public void validate(ValidationContext vContext)
              throws ValidationException

Description copied from interface: Verifiable

Runs validation on this verifiable object using a previously collected ValidationContext.

In general, this method will only be called internally, not by users.

Specified by:

validate in interface Verifiable<ThisType extends SetOperationQuery<ThisType>>

Overrides:

validate in class Query<ThisType extends SetOperationQuery<ThisType>>

Parameters:

vContext - handle to the current, filled-in validation context

Throws:

ValidationException

collectSchemaObjects

protected void collectSchemaObjects(ValidationContext vContext)

Description copied from class: SqlObject

Used during Query.validate() calls to collect the dbschema objects referenced in a query. Any subclass of this class should add all referenced tables and columns to the appropriate collections.

Overrides:

collectSchemaObjects in class Query<ThisType extends SetOperationQuery<ThisType>>

Parameters:

vContext - handle to the current validation context

appendTo

protected void appendTo(AppendableExt app,
                        SqlContext newContext)
                 throws IOException

Description copied from class: Query

Appends the sql query to the given AppendableExt within the given, modifiable SqlContext. This method is invoked by the Query.appendTo(AppendableExt) method within the context of calls to SqlContext.pushContext(com.healthmarketscience.common.util.AppendableExt) and SqlContext.popContext(com.healthmarketscience.common.util.AppendableExt, com.healthmarketscience.sqlbuilder.SqlContext), so the implementation is free to modify the given SqlContext.

Specified by:

appendTo in class Query<ThisType extends SetOperationQuery<ThisType>>

Parameters:

app - the target for the sql query generation

newContext - modifiable SqlContext for nested Appendees

Throws:

IOException

union

public static UnionQuery union()

Convenience method to create a UNION query.

union

public static UnionQuery union(SelectQuery... queries)

Convenience method to create a UNION query.

unionAll

public static UnionQuery unionAll()

Convenience method to create a UNION ALL query.

unionAll

public static UnionQuery unionAll(SelectQuery... queries)

Convenience method to create a UNION ALL query.

except

public static ExceptQuery except()

Convenience method to create a EXCEPT query.

except

public static ExceptQuery except(SelectQuery... queries)

Convenience method to create a EXCEPT query.

exceptAll

public static ExceptQuery exceptAll()

Convenience method to create a EXCEPT ALL query.

exceptAll

public static ExceptQuery exceptAll(SelectQuery... queries)

Convenience method to create a EXCEPT ALL query.

intersect

public static IntersectQuery intersect()

Convenience method to create a INTERSECT query.

intersect

public static IntersectQuery intersect(SelectQuery... queries)

Convenience method to create a INTERSECT query.

intersectAll

public static IntersectQuery intersectAll()

Convenience method to create a INTERSECT ALL query.

intersectAll

public static IntersectQuery intersectAll(SelectQuery... queries)

Convenience method to create a INTERSECT ALL query.