nz.co.gregs.dbvolution.internal.query

Class QueryOptions

java.lang.Object

nz.co.gregs.dbvolution.internal.query.QueryOptions

public class QueryOptions
extends Object

Support DBvolution at Patreon

Author:

greg

Constructor Summary

Constructors

Constructor and Description
QueryOptions()
QueryOptions(QueryOptions opts)

Method Summary

Methods

Modifier and Type	Method and Description
int	getPageIndex() Defines which page of results the query is to retrieve.
DBDatabase	getQueryDatabase()
QueryType	getQueryType()
int	getRowLimit() Returns the current row limit.
ColumnProvider[]	getSortColumns() Support DBvolution at Patreon
boolean	isBlankQueryAllowed() Support DBvolution at Patreon
boolean	isCartesianJoinAllowed() Support DBvolution at Patreon
boolean	isCreatingNativeQuery() Used while simulating OUTER JOIN to indicate that the simulation is occurring.
boolean	isMatchAllConditions() Indicates whether this query will use AND rather than OR to add the conditions.
boolean	isMatchAllRelationships() Support DBvolution at Patreon
boolean	isMatchAny() Indicates whether this query will use OR rather than AND to add the conditions.
boolean	isUseANSISyntax() Support DBvolution at Patreon
void	setBlankQueryAllowed(boolean blankQueryAllowed)
void	setCartesianJoinAllowed(boolean cartesianJoinAllowed)
void	setCreatingNativeQuery(boolean creatingNativeQuery) Used while simulating OUTER JOIN to indicate that the simulation is occurring.
void	setMatchAllConditions() Changes the DBQuery to using all ANDs to connect the criteria
void	setMatchAllRelationships() Controls how relationships, that is Foreign Keys, are compared.
void	setMatchAnyConditions() Changes the DBQuery to using all ORs to connect the criteria
void	setMatchAnyRelationship() Controls how relationships, that is Foreign Keys, are compared.
void	setPageIndex(int pageIndex)
void	setQueryDatabase(DBDatabase db)
void	setQueryType(QueryType queryType)
void	setRowLimit(int rowLimit)
void	setSortColumns(ColumnProvider[] sortColumns)
void	setUseANSISyntax(boolean useANSISyntax)

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryOptions

public QueryOptions()

QueryOptions

public QueryOptions(QueryOptions opts)

Method Detail

isMatchAllConditions

public boolean isMatchAllConditions()

Indicates whether this query will use AND rather than OR to add the conditions.

Support DBvolution at Patreon

Returns:

TRUE if criteria should be collected using AND

isMatchAny

public boolean isMatchAny()

Indicates whether this query will use OR rather than AND to add the conditions.

Support DBvolution at Patreon

Returns:

TRUE if criteria should be collected using OR

setMatchAllConditions

public void setMatchAllConditions()

Changes the DBQuery to using all ANDs to connect the criteria

setMatchAnyConditions

public void setMatchAnyConditions()

Changes the DBQuery to using all ORs to connect the criteria

getRowLimit

public int getRowLimit()

Returns the current row limit.

The value will be -1 if no row limit is set.

Support DBvolution at Patreon

Returns:

the rowLimit

setRowLimit

public final void setRowLimit(int rowLimit)

Parameters:

rowLimit - the rowLimit to set

getSortColumns

public ColumnProvider[] getSortColumns()

Support DBvolution at Patreon

Returns:

the sortColumns

setSortColumns

public final void setSortColumns(ColumnProvider[] sortColumns)

Parameters:

sortColumns - the sortColumns to set

isBlankQueryAllowed

public boolean isBlankQueryAllowed()

Support DBvolution at Patreon

Returns:

the blankQueryAllowed

setBlankQueryAllowed

public final void setBlankQueryAllowed(boolean blankQueryAllowed)

Parameters:

blankQueryAllowed - the blankQueryAllowed to set

isUseANSISyntax

public boolean isUseANSISyntax()

Support DBvolution at Patreon

Returns:

the useANSISyntax

setUseANSISyntax

public final void setUseANSISyntax(boolean useANSISyntax)

Parameters:

useANSISyntax - the useANSISyntax to set

isCartesianJoinAllowed

public boolean isCartesianJoinAllowed()

Support DBvolution at Patreon

Returns:

the cartesianJoinAllowed

setCartesianJoinAllowed

public final void setCartesianJoinAllowed(boolean cartesianJoinAllowed)

Parameters:

cartesianJoinAllowed - the cartesianJoinAllowed to set

getPageIndex

public int getPageIndex()

Defines which page of results the query is to retrieve.

getRowLimit() defines the size of a page, and this method return which page is to be retrieved.

Be default the page index is zero.

The first item on the page will be (pageindex*rowlimit) , and the first item on the next page will be ((pageindex+1)*rowlimit).

Support DBvolution at Patreon

Returns:

the pageIndex

setPageIndex

public final void setPageIndex(int pageIndex)

Parameters:

pageIndex - the pageIndex to set

setMatchAnyRelationship

public void setMatchAnyRelationship()

Controls how relationships, that is Foreign Keys, are compared.

If there are multiple FKs between 2 DBRows setMatchAnyRelationship() will switch the query to connecting the 2 rows if ANY of the FKs match, rather the normal case of ALL.

setMatchAllRelationships

public void setMatchAllRelationships()

Controls how relationships, that is Foreign Keys, are compared.

If there are multiple FKs between 2 DBRows setMatchAllRelationship() will switch the query to connecting the 2 rows if ALL of the FKs match.

This is the default option.

isMatchAllRelationships

public boolean isMatchAllRelationships()

Support DBvolution at Patreon

Returns:

the matchAllRelationship

isCreatingNativeQuery

public boolean isCreatingNativeQuery()

Used while simulating OUTER JOIN to indicate that the simulation is occurring.

Support DBvolution at Patreon

Returns:

TRUE if the query is native, FALSE otherwise

setCreatingNativeQuery

public final void setCreatingNativeQuery(boolean creatingNativeQuery)

Used while simulating OUTER JOIN to indicate that the simulation is occurring.

Parameters:

creatingNativeQuery -

getQueryType

public QueryType getQueryType()

setQueryType

public final void setQueryType(QueryType queryType)

setQueryDatabase

public final void setQueryDatabase(DBDatabase db)

getQueryDatabase

public DBDatabase getQueryDatabase()