au.com.cybersearch2.classyjpa.query

Class QueryInfo

java.lang.Object

au.com.cybersearch2.classyjpa.query.QueryInfo

public class QueryInfo
extends Object

QueryInfo Holds information to be used to build an SQLite query and map each result set row to an object. The query components are as follows (ones marked with "*" mandatory): table* The table name to compile the query against. columns* A list of which columns to return. selection A filter declaring which rows to return, formatted as an SQL WHERE clause (excluding the WHERE itself). By default, all rows for the given table are returned. selectionArgs You may include ?s in selection, which will be replaced by the values from selectionArgs, in order that they appear in the selection. The values will be bound as Strings. groupBy A filter declaring how to group rows, formatted as an SQL GROUP BY clause (excluding the GROUP BY itself). By default, rows are not grouped. having A filter declare which row groups to include in the cursor, if row grouping is being used, formatted as an SQL HAVING clause (excluding the HAVING itself). By default, all row groups will be included, and is required when row grouping is not being used. orderBy How to order the rows, formatted as an SQL ORDER BY clause (excluding the ORDER BY itself). The default sort order may be unordered. limit Limits the number of rows returned by the query, formatted as LIMIT clause. Default is no limit. parameterNames The parameter names mapped to selection arguments in same order.

Author:

Andrew Bowley 30/05/2014

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	QueryInfo.RowMapper RowMapper An interface to create an Object from a query result row

Constructor Summary

Constructors

Constructor and Description
QueryInfo(QueryInfo.RowMapper rowMapper, String table, String... columns)

Method Summary

Methods

Modifier and Type	Method and Description
String[]	getColumns() Returns a list of which columns to return
String	getGroupBy() Returns a filter declaring how to group rows, formatted as an SQL GROUP BY clause
String	getHaving() Returns a filter declaring which row groups to include in the cursor
String	getLimit() Returns a limit clause for the number of rows returned by the query
String	getOrderBy() Returns how to order the rows
String[]	getParameterNames() Get the parameter names mapped to selection arguments in same order
QueryInfo.RowMapper	getRowMapper() Returns agent which maps a query result row to an object
String	getSelection() Returns a filter declaring which rows to return
String[]	getSelectionArgs() Returns the selection arguments
String	getTable() Returns The table name to compile the query against.
void	setGroupBy(String groupBy) Sets a filter declaring how to group rows, formatted as an SQL GROUP BY clause
void	setHaving(String having) Set a filter declaring which row groups to include in the cursor
void	setLimit(String limit) Set a limit clause for the number of rows returned by the query
void	setOrderBy(String orderBy) Set how to order the rows
void	setParameterNames(String[] parameterNames) Set the parameter names mapped to selection arguments in same order
void	setSelection(String selection) Sets a filter declaring which rows to return
void	setSelectionArgs(String[] selectionArgs) Sets the selection arguments.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryInfo

public QueryInfo(QueryInfo.RowMapper rowMapper,
         String table,
         String... columns)

Method Detail

getTable

public String getTable()

Returns The table name to compile the query against.

Returns:

String

getColumns

public String[] getColumns()

Returns a list of which columns to return

Returns:

String

getSelection

public String getSelection()

Returns a filter declaring which rows to return

Returns:

String formatted as an SQL WHERE clause (excluding the WHERE itself)

setSelection

public void setSelection(String selection)

Sets a filter declaring which rows to return

Parameters:

selection - String formatted as an SQL WHERE clause (excluding the WHERE itself)

getParameterNames

public String[] getParameterNames()

Get the parameter names mapped to selection arguments in same order

Returns:

String[]

setParameterNames

public void setParameterNames(String[] parameterNames)

Set the parameter names mapped to selection arguments in same order

Parameters:

parameterNames - String[]

getGroupBy

public String getGroupBy()

Returns a filter declaring how to group rows, formatted as an SQL GROUP BY clause

Returns:

String formatted as an SQL HAVING clause (excluding the HAVING itself)

setGroupBy

public void setGroupBy(String groupBy)

Sets a filter declaring how to group rows, formatted as an SQL GROUP BY clause

Parameters:

groupBy - String formatted as an SQL HAVING clause (excluding the HAVING itself)

getHaving

public String getHaving()

Returns a filter declaring which row groups to include in the cursor

Returns:

String formatted as an SQL ORDER BY clause (excluding the ORDER BY itself)

setHaving

public void setHaving(String having)

Set a filter declaring which row groups to include in the cursor

Parameters:

having - String formatted as an SQL ORDER BY clause (excluding the ORDER BY itself)

getOrderBy

public String getOrderBy()

Returns how to order the rows

Returns:

String formatted as an SQL ORDER BY clause (excluding the ORDER BY itself). The default sort order may be unordered.

setOrderBy

public void setOrderBy(String orderBy)

Set how to order the rows

Parameters:

orderBy - String formatted as an SQL ORDER BY clause (excluding the ORDER BY itself). Default null will use the default sort order, which may be unordered.

getLimit

public String getLimit()

Returns a limit clause for the number of rows returned by the query

Returns:

String formatted as either a single value or ", " combination

setLimit

public void setLimit(String limit)

Set a limit clause for the number of rows returned by the query

Parameters:

limit - String formatted as either a single value or ", " combination

getRowMapper

public QueryInfo.RowMapper getRowMapper()

Returns agent which maps a query result row to an object

Returns:

RowMapper

getSelectionArgs

public String[] getSelectionArgs()

Returns the selection arguments

Returns:

String[]

setSelectionArgs

public void setSelectionArgs(String[] selectionArgs)

Sets the selection arguments. You may include ?s in selection, which will be replaced by the values from selectionArgs, in order that they appear in the selection. The values will be bound as Strings.

Parameters:

selectionArgs - String[]