nz.co.gregs.dbvolution.internal.query

Class QueryDetails

java.lang.Object

nz.co.gregs.dbvolution.internal.query.QueryDetails

All Implemented Interfaces:

DBQueryable

Direct Known Subclasses:

RecursiveQueryDetails

public class QueryDetails
extends Object
implements DBQueryable

Support DBvolution at Patreon

Author:

gregorygraham

Constructor Summary

Constructors

Constructor and Description
QueryDetails()

Method Summary

Methods

Modifier and Type	Method and Description
void	addToSortOrder(ColumnProvider[] sortColumns)
void	blankResults()
void	clear()
void	clearResults()
void	clearSortOrder()
protected void	fillResultSetFromSQL(DBDatabase db, QueryDetails details, DBDefinition defn, String sqlString)
protected void	fillResultSetInternal(DBDatabase db, QueryDetails details, QueryOptions options)
List<BooleanExpression>	getAllConditions() Get all conditions involved in this query.
List<DBRow>	getAllQueryTables() Support DBvolution at Patreon
List<DBQueryRow>	getAllRows()
void	getAllRowsForPage(DBDatabase database, QueryDetails details)
String	getANSIJoinClause(DBDefinition defn, QueryState queryState, DBRow newTable, List<DBRow> previousTables, QueryOptions options)
List<DBRow>	getAssumedQueryTables() Support DBvolution at Patreon
List<BooleanExpression>	getConditions() Support DBvolution at Patreon
Long	getCount()
List<DBQueryRow>	getCurrentPage()
Map<Object,DBExpression>	getDBReportGroupByColumns() Support DBvolution at Patreon
Map<Class<?>,Map<String,DBRow>>	getExistingInstances() Support DBvolution at Patreon
Map<Object,QueryableDatatype<?>>	getExpressionColumns() Support DBvolution at Patreon
List<DBRow>	getExtraExamples() Support DBvolution at Patreon
BooleanExpression[]	getHavingColumns() Support DBvolution at Patreon
List<DBRow>	getOptionalQueryTables() Support DBvolution at Patreon
QueryOptions	getOptions() Support DBvolution at Patreon
protected DBRow	getOrSetExistingInstanceForRow(DBDefinition defn, DBRow newInstance, Map<String,DBRow> existingInstancesOfThisTableRow) Retrieves or sets the existing instance of the DBRow provided.
String	getRawSQLClause()
<R extends DBRow> List<R>	getRelatedInstancesFromQuery(DBRow row, R example) Finds all instances of example that share a DBQueryRow with this instance.
List<DBRow>	getRequiredQueryTables() Support DBvolution at Patreon
List<DBQueryRow>	getResults()
protected ResultSet	getResultSetForSQL(DBStatement statement, String sql) Executes the query using the statement provided and returns the ResultSet
Integer	getResultsPageIndex()
String	getResultSQL()
Integer	getResultsRowLimit()
String	getSelectSQLClause() Get the SELECT clause used during the query.
String	getSQLForQuery(DBDatabase database, QueryState queryState, QueryType queryType, QueryOptions options)
Integer	getTimeoutInMilliseconds()
boolean	isGroupedQuery() Return the requirement for a GROUP BY clause.
boolean	needsResults(QueryOptions options)
DBQueryable	query(DBDatabase db) Performs the DB query and returns a list of all actions performed in the process.
protected void	setCurrentPage(List<DBQueryRow> results)
void	setDefinition(DBDefinition database)
protected Map<String,DBRow>	setExistingInstancesForTable(Map<String,DBRow> existingInstancesOfThisTableRow, DBRow newInstance) Creates the list of already created rows for the DBRow class supplied.
protected void	setFieldsFromColumns(DBDefinition defn, DBRow oldInstance, DBRow newInstance, ResultSet resultSet) Based on the template provided by oldInstance, fill all the fields of newInstance with data from the current row of the ResultSet.
void	setGroupByRequiredByAggregator(boolean b) Set the requirement for a GROUP BY clause.
void	setHavingColumns(BooleanExpression... havingColumns)
void	setOptions(QueryOptions tempOptions)
void	setQueryRowFromResultSet(DBDefinition defn, ResultSet resultSet, QueryDetails details, DBQueryRow queryRow, boolean isGroupedQuery)
void	setQueryType(QueryType queryType)
void	setRawSQLClause(String rawSQLClause)
void	setResults(List<DBQueryRow> results)
void	setResultsPageIndex(Integer resultsPageIndex)
void	setResultSQL(String resultSQL)
void	setResultsRowLimit(Integer resultsRowLimit)
void	setSelectSQLClause(String selectClause) Define the SELECT clause used during the query.
void	setSortOrder(ColumnProvider[] sortColumns)
void	setTimeoutInMilliseconds(Integer milliseconds)
String	toSQLString(DBDatabase db)
boolean	willCreateBlankQuery(DBDatabase db)

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryDetails

public QueryDetails()

Method Detail

getAllQueryTables

public List<DBRow> getAllQueryTables()

Support DBvolution at Patreon

Returns:

the allQueryTables

getRequiredQueryTables

public List<DBRow> getRequiredQueryTables()

Support DBvolution at Patreon

Returns:

the requiredQueryTables

getOptionalQueryTables

public List<DBRow> getOptionalQueryTables()

Support DBvolution at Patreon

Returns:

the optionalQueryTables

getAssumedQueryTables

public List<DBRow> getAssumedQueryTables()

Support DBvolution at Patreon

Returns:

the assumedQueryTables

getOptions

public QueryOptions getOptions()

Support DBvolution at Patreon

Returns:

the options

getExtraExamples

public List<DBRow> getExtraExamples()

Support DBvolution at Patreon

Returns:

the extraExamples

getAllConditions

public List<BooleanExpression> getAllConditions()

Get all conditions involved in this query.

Support DBvolution at Patreon

Returns:

all conditions in the query

getConditions

public List<BooleanExpression> getConditions()

Support DBvolution at Patreon

Returns:

the conditions

getExpressionColumns

public Map<Object,QueryableDatatype<?>> getExpressionColumns()

Support DBvolution at Patreon

Returns:

the expressionColumns

getDBReportGroupByColumns

public Map<Object,DBExpression> getDBReportGroupByColumns()

Support DBvolution at Patreon

Returns:

the dbReportGroupByColumns

getExistingInstances

public Map<Class<?>,Map<String,DBRow>> getExistingInstances()

Support DBvolution at Patreon

Returns:

the existingInstances

setGroupByRequiredByAggregator

public void setGroupByRequiredByAggregator(boolean b)

Set the requirement for a GROUP BY clause.

Parameters:

b -

isGroupedQuery

public boolean isGroupedQuery()

Return the requirement for a GROUP BY clause.

Support DBvolution at Patreon

Returns:

TRUE if the GROUP BY clause is required, otherwise FALSE.

setSelectSQLClause

public void setSelectSQLClause(String selectClause)

Define the SELECT clause used during the query.

Parameters:

selectClause -

getSelectSQLClause

public String getSelectSQLClause()

Get the SELECT clause used during the query.

Support DBvolution at Patreon

Returns:

the SELECT clause defined earlier

getHavingColumns

public BooleanExpression[] getHavingColumns()

Support DBvolution at Patreon

Returns:

the havingColumns

setHavingColumns

public void setHavingColumns(BooleanExpression... havingColumns)

Parameters:

havingColumns - the havingColumns to set

setDefinition

public void setDefinition(DBDefinition database)

setQueryType

public void setQueryType(QueryType queryType)

setOptions

public void setOptions(QueryOptions tempOptions)

getRawSQLClause

public String getRawSQLClause()

Returns:

the rawSQLClause

setRawSQLClause

public void setRawSQLClause(String rawSQLClause)

Parameters:

rawSQLClause - the rawSQLClause to set

getResults

public List<DBQueryRow> getResults()

Returns:

the results

setResults

public void setResults(List<DBQueryRow> results)

Parameters:

results - the results to set

getResultSQL

public String getResultSQL()

Returns:

the resultSQL

setResultSQL

public void setResultSQL(String resultSQL)

Parameters:

resultSQL - the resultSQL to set

getResultsPageIndex

public Integer getResultsPageIndex()

Returns:

the resultsPageIndex

setResultsPageIndex

public void setResultsPageIndex(Integer resultsPageIndex)

Parameters:

resultsPageIndex - the resultsPageIndex to set

getResultsRowLimit

public Integer getResultsRowLimit()

Returns:

the resultsRowLimit

setResultsRowLimit

public void setResultsRowLimit(Integer resultsRowLimit)

Parameters:

resultsRowLimit - the resultsRowLimit to set

clearResults

public void clearResults()

getCount

public Long getCount()

getSQLForQuery

public String getSQLForQuery(DBDatabase database,
                    QueryState queryState,
                    QueryType queryType,
                    QueryOptions options)

getANSIJoinClause

public String getANSIJoinClause(DBDefinition defn,
                       QueryState queryState,
                       DBRow newTable,
                       List<DBRow> previousTables,
                       QueryOptions options)

setSortOrder

public void setSortOrder(ColumnProvider[] sortColumns)

blankResults

public void blankResults()

addToSortOrder

public void addToSortOrder(ColumnProvider[] sortColumns)

clearSortOrder

public void clearSortOrder()

needsResults

public boolean needsResults(QueryOptions options)

getAllRows

public List<DBQueryRow> getAllRows()
                            throws SQLException,
                                   SQLTimeoutException,
                                   AccidentalBlankQueryException,
                                   AccidentalCartesianJoinException

Specified by:

getAllRows in interface DBQueryable

Throws:

SQLException

SQLTimeoutException

AccidentalBlankQueryException

AccidentalCartesianJoinException

query

public DBQueryable query(DBDatabase db)
                  throws SQLException

Description copied from interface: DBQueryable

Performs the DB query and returns a list of all actions performed in the process.

The supplied row will be changed by the action in an appropriate way, however the Action will contain an unchanged and unchangeable copy of the row for internal use.

Specified by:

query in interface DBQueryable

Parameters:

db - the target database.

Support DBvolution at Patreon

Returns:

The complete list of all actions performed to complete this action on the database

Throws:

SQLException - Database operations may throw SQLExceptions

getAllRowsForPage

public void getAllRowsForPage(DBDatabase database,
                     QueryDetails details)
                       throws SQLException

Throws:

SQLException

fillResultSetInternal

protected void fillResultSetInternal(DBDatabase db,
                         QueryDetails details,
                         QueryOptions options)
                              throws SQLException

Throws:

SQLException

fillResultSetFromSQL

protected void fillResultSetFromSQL(DBDatabase db,
                        QueryDetails details,
                        DBDefinition defn,
                        String sqlString)
                             throws SQLException

Throws:

SQLException

getRelatedInstancesFromQuery

public <R extends DBRow> List<R> getRelatedInstancesFromQuery(DBRow row,
                                                     R example)
                                                   throws SQLException

Finds all instances of example that share a DBQueryRow with this instance.

Type Parameters:

R - DBRow

Parameters:

row -

example - example

Support DBvolution at Patreon

Returns:

all instances of example that are connected to this instance in the query 1 Database exceptions may be thrown

Throws:

SQLException - java.sql.SQLException

willCreateBlankQuery

public boolean willCreateBlankQuery(DBDatabase db)

getResultSetForSQL

protected ResultSet getResultSetForSQL(DBStatement statement,
                           String sql)
                                throws SQLException,
                                       SQLTimeoutException

Executes the query using the statement provided and returns the ResultSet

Parameters:

statement - dbStatement

sql - sql

Support DBvolution at Patreon

Returns:

the ResultSet returned from the actual database. Database exceptions may be thrown

Throws:

SQLException - java.sql.SQLException

SQLTimeoutException

setQueryRowFromResultSet

public void setQueryRowFromResultSet(DBDefinition defn,
                            ResultSet resultSet,
                            QueryDetails details,
                            DBQueryRow queryRow,
                            boolean isGroupedQuery)
                              throws SQLException

Throws:

SQLException

setFieldsFromColumns

protected void setFieldsFromColumns(DBDefinition defn,
                        DBRow oldInstance,
                        DBRow newInstance,
                        ResultSet resultSet)
                             throws SQLException

Based on the template provided by oldInstance, fill all the fields of newInstance with data from the current row of the ResultSet.

OldInstance is used to find the selected properties, newInstance is the result, and restultSet contains the retrieved data. Database exceptions may be thrown

Parameters:

defn -

oldInstance - oldInstance

newInstance - newInstance

resultSet - resultSet

Throws:

SQLException - java.sql.SQLException

setExistingInstancesForTable

protected Map<String,DBRow> setExistingInstancesForTable(Map<String,DBRow> existingInstancesOfThisTableRow,
                                             DBRow newInstance)

Creates the list of already created rows for the DBRow class supplied.

Parameters:

existingInstancesOfThisTableRow - existingInstancesOfThisTableRow

newInstance - newInstance

Support DBvolution at Patreon

Returns:

a list of existing rows.

getOrSetExistingInstanceForRow

protected DBRow getOrSetExistingInstanceForRow(DBDefinition defn,
                                   DBRow newInstance,
                                   Map<String,DBRow> existingInstancesOfThisTableRow)

Retrieves or sets the existing instance of the DBRow provided.

Queries maintain a list of existing rows to avoid duplicating identical rows. This method checks to see if the supplied row already exists and returns the existing version.

If the row is new then this method stores it, and returns it as the existing instance.

Parameters:

defn -

newInstance - newInstance

existingInstancesOfThisTableRow - existingInstancesOfThisTableRow

Support DBvolution at Patreon

Returns:

the exisinting instance of the provided row, or the row itself if none exists.

setCurrentPage

protected void setCurrentPage(List<DBQueryRow> results)

getCurrentPage

public List<DBQueryRow> getCurrentPage()

clear

public void clear()

setTimeoutInMilliseconds

public void setTimeoutInMilliseconds(Integer milliseconds)

getTimeoutInMilliseconds

public Integer getTimeoutInMilliseconds()

Returns:

the timeoutInMilliseconds

toSQLString

public String toSQLString(DBDatabase db)

Specified by:

toSQLString in interface DBQueryable