Class AggregateInput

java.lang.Object

com.kingsrook.qqq.backend.core.model.actions.AbstractActionInput

com.kingsrook.qqq.backend.core.model.actions.AbstractTableActionInput

com.kingsrook.qqq.backend.core.model.actions.tables.aggregate.AggregateInput

All Implemented Interfaces:

QueryOrCountInputInterface

public class AggregateInput
extends AbstractTableActionInput
implements QueryOrCountInputInterface

Input data for the Count action

Constructor Summary

Constructors

Constructor	Description
AggregateInput()
AggregateInput(String tableName)	Constructor

Method Summary

Modifier and Type	Method	Description
List<Aggregate>	getAggregates()	Getter for aggregates
QQueryFilter	getFilter()	Getter for filter
List<GroupBy>	getGroupBys()	Getter for groupBys
Integer	getLimit()	Getter for limit
EnumSet<QueryHint>	getQueryHints()	Getter for queryHints
List<QueryJoin>	getQueryJoins()	Getter for queryJoins
Integer	getTimeoutSeconds()	Getter for timeoutSeconds
QBackendTransaction	getTransaction()	Getter for transaction
boolean	hasQueryHint(QueryHint queryHint)	null-safely check if query hints map contains the specified hint
void	setAggregates(List<Aggregate> aggregates)	Setter for aggregates
void	setFilter(QQueryFilter filter)	Setter for filter
void	setGroupBys(List<GroupBy> groupBys)	Setter for groupBys
void	setLimit(Integer limit)	Setter for limit
void	setQueryHints(EnumSet<QueryHint> queryHints)	Setter for queryHints
void	setQueryJoins(List<QueryJoin> queryJoins)	Setter for queryJoins
void	setTimeoutSeconds(Integer timeoutSeconds)	Setter for timeoutSeconds
void	setTransaction(QBackendTransaction transaction)	Setter for transaction
AggregateInput	withAggregate(Aggregate aggregate)	Fluent setter for aggregates
AggregateInput	withAggregates(List<Aggregate> aggregates)	Fluent setter for aggregates
AggregateInput	withFilter(QQueryFilter filter)	Fluent setter for filter
AggregateInput	withGroupBy(GroupBy groupBy)	Fluent setter for groupBys
AggregateInput	withGroupBys(List<GroupBy> groupBys)	Fluent setter for groupBys
AggregateInput	withInputSource(InputSource inputSource)	Fluent setter for inputSource
AggregateInput	withLimit(Integer limit)	Fluent setter for limit
AggregateInput	withoutQueryHint(QueryHint queryHint)	Fluent setter for queryHints
AggregateInput	withQueryHint(QueryHint queryHint)	Fluent setter for queryHints
AggregateInput	withQueryHints(EnumSet<QueryHint> queryHints)	Fluent setter for queryHints
AggregateInput	withQueryJoin(QueryJoin queryJoin)	Fluent setter for queryJoins
AggregateInput	withQueryJoins(List<QueryJoin> queryJoins)	Fluent setter for queryJoins
AggregateInput	withTableName(String tableName)	Fluent setter for tableName
AggregateInput	withTimeoutSeconds(Integer timeoutSeconds)	Fluent setter for timeoutSeconds
AggregateInput	withTransaction(QBackendTransaction transaction)	Fluent setter for transaction

Methods inherited from class com.kingsrook.qqq.backend.core.model.actions.AbstractTableActionInput

getActionIdentity, getBackend, getInputSource, getTable, getTableMetaData, getTableName, setInputSource, setTableMetaData, setTableName, withTableMetaData

Methods inherited from class com.kingsrook.qqq.backend.core.model.actions.AbstractActionInput

getAsyncJobCallback, getInstance, getSession, setAsyncJobCallback

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.kingsrook.qqq.backend.core.model.actions.tables.QueryOrCountInputInterface

getInputSource, getTable, getTableName, setCommonParamsFrom, setTableName

Constructor Details

AggregateInput

public AggregateInput()

AggregateInput

public AggregateInput(String tableName)

Constructor

Method Details

withTableName

public AggregateInput withTableName(String tableName)

Description copied from class: AbstractTableActionInput

Fluent setter for tableName

Overrides:

withTableName in class AbstractTableActionInput

getFilter

public QQueryFilter getFilter()

Getter for filter

Specified by:

getFilter in interface QueryOrCountInputInterface

setFilter

public void setFilter(QQueryFilter filter)

Setter for filter

Specified by:

setFilter in interface QueryOrCountInputInterface

withFilter

public AggregateInput withFilter(QQueryFilter filter)

Fluent setter for filter

getAggregates

public List<Aggregate> getAggregates()

Getter for aggregates

setAggregates

public void setAggregates(List<Aggregate> aggregates)

Setter for aggregates

withAggregates

public AggregateInput withAggregates(List<Aggregate> aggregates)

Fluent setter for aggregates

withAggregate

public AggregateInput withAggregate(Aggregate aggregate)

Fluent setter for aggregates

getGroupBys

public List<GroupBy> getGroupBys()

Getter for groupBys

setGroupBys

public void setGroupBys(List<GroupBy> groupBys)

Setter for groupBys

withGroupBys

public AggregateInput withGroupBys(List<GroupBy> groupBys)

Fluent setter for groupBys

withGroupBy

public AggregateInput withGroupBy(GroupBy groupBy)

Fluent setter for groupBys

getQueryJoins

public List<QueryJoin> getQueryJoins()

Getter for queryJoins

Specified by:

getQueryJoins in interface QueryOrCountInputInterface

setQueryJoins

public void setQueryJoins(List<QueryJoin> queryJoins)

Setter for queryJoins

Specified by:

setQueryJoins in interface QueryOrCountInputInterface

withQueryJoins

public AggregateInput withQueryJoins(List<QueryJoin> queryJoins)

Fluent setter for queryJoins

withQueryJoin

public AggregateInput withQueryJoin(QueryJoin queryJoin)

Fluent setter for queryJoins

getLimit

public Integer getLimit()

Getter for limit

setLimit

public void setLimit(Integer limit)

Setter for limit

withLimit

public AggregateInput withLimit(Integer limit)

Fluent setter for limit

getTimeoutSeconds

public Integer getTimeoutSeconds()

Getter for timeoutSeconds

Specified by:

getTimeoutSeconds in interface QueryOrCountInputInterface

setTimeoutSeconds

public void setTimeoutSeconds(Integer timeoutSeconds)

Setter for timeoutSeconds

Specified by:

setTimeoutSeconds in interface QueryOrCountInputInterface

withTimeoutSeconds

public AggregateInput withTimeoutSeconds(Integer timeoutSeconds)

Fluent setter for timeoutSeconds

getQueryHints

public EnumSet<QueryHint> getQueryHints()

Getter for queryHints

Specified by:

getQueryHints in interface QueryOrCountInputInterface

setQueryHints

public void setQueryHints(EnumSet<QueryHint> queryHints)

Setter for queryHints

Specified by:

setQueryHints in interface QueryOrCountInputInterface

withQueryHints

public AggregateInput withQueryHints(EnumSet<QueryHint> queryHints)

Fluent setter for queryHints

withQueryHint

public AggregateInput withQueryHint(QueryHint queryHint)

Fluent setter for queryHints

withoutQueryHint

public AggregateInput withoutQueryHint(QueryHint queryHint)

Fluent setter for queryHints

hasQueryHint

public boolean hasQueryHint(QueryHint queryHint)

null-safely check if query hints map contains the specified hint

getTransaction

public QBackendTransaction getTransaction()

Getter for transaction

Specified by:

getTransaction in interface QueryOrCountInputInterface

setTransaction

public void setTransaction(QBackendTransaction transaction)

Setter for transaction

Specified by:

setTransaction in interface QueryOrCountInputInterface

withTransaction

public AggregateInput withTransaction(QBackendTransaction transaction)

Fluent setter for transaction

withInputSource

public AggregateInput withInputSource(InputSource inputSource)

Description copied from class: AbstractTableActionInput

Fluent setter for inputSource

Overrides:

withInputSource in class AbstractTableActionInput

Parameters:

inputSource - Indicator of what the source of the action is. Default values from QQQ are USER or SYSTEM (where it can be the case that an action that originated from a USER leads to SYSTEM actions (e.g., running a process - the RunProcessAction is USER initiated, but if that process then runs a query, by default, it would be SYSTEM initiated).

Returns:

this