TGroupBy (General SQL Parser Java Library Core 4.1.0.5 API)

Object
- gudusoft.gsqlparser.nodes.TParseTreeNode
- - gudusoft.gsqlparser.nodes.TGroupBy

All Implemented Interfaces:

Visitable, Iterator<TSourceToken>
```
public class TGroupBy
extends TParseTreeNode
```
This class represents group by clause and having clause.

Specify the GROUP BY clause if you want the database to group the selected rows based on the value of expr(s) for each row and return a single row of summary information for each group.
If this clause contains CUBE or ROLLUP extensions, then the database produces superaggregate groupings in addition to the regular groupings.

Use the HAVING clause to restrict the groups of returned rows to those groups for which the specified condition is TRUE. If you omit this clause, then the database returns summary rows for all groups.

Field Summary
- Fields inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode
  dbvendor, doubleLinkedTokenListToString, nodeActionAppend, nodeActionInsert, nodeActionRemove, nodeActionUnknown, nodeActionUpdate, nodeActionUpdateText, nodeChangeEndToken, nodeChangeStartToken

Constructor Summary

Constructors
Constructor and Description

TGroupBy()

Constructors
Constructor and Description
`TGroupBy()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accept(TParseTreeVisitor v)` Accept a visitor
`void`	`acceptChildren(TParseTreeVisitor v)` Accept a visitor to iterate this class and sub-nodes of this class
`void`	`doParse(TCustomSqlStatement psql, ESqlClause plocation)` Analyze the sub-nodes inside this node.
`TSourceToken`	`getALL()` Gets the ALL token for GROUP BY ALL syntax.
`TPTNodeList<TBinding>`	`getBindings()`
`TSourceToken`	`getBY()`
`TSourceToken`	`getGROUP()`
`TSourceToken`	`getHAVING()`
`TExpression`	`getHavingClause()` Restrict the groups of returned rows to those groups for which the specified condition is TRUE.
`TGroupByItemList`	`getItems()`
`TQualifyClause`	`getQualifyClause()`
`void`	`init(Object arg1)` Initialize a query tree node.
`void`	`init(Object arg1, Object arg2)`
`boolean`	`isAllModifier()` Returns whether this GROUP BY clause uses the ALL modifier.
`boolean`	`isCubeModifier()`
`boolean`	`isRollupModifier()`
`boolean`	`isTotalsModifier()` Returns whether this GROUP BY clause uses the WITH TOTALS modifier.
`void`	`setALL(TSourceToken ALL)` Sets the ALL token for GROUP BY ALL syntax.
`void`	`setAllModifier(boolean allModifier)` Sets whether this GROUP BY clause uses the ALL modifier.
`void`	`setBindings(TPTNodeList<TBinding> bindings)`
`void`	`setBY(TSourceToken BY)`
`void`	`setCubeModifier(boolean cubeModifier)`
`void`	`setGROUP(TSourceToken GROUP)`
`void`	`setHAVING(TSourceToken HAVING)`
`void`	`setHavingClause(TExpression havingClause)`
`void`	`setItems(TGroupByItemList items)`
`void`	`setQualifyClause(TQualifyClause qualifyClause)`
`void`	`setRollupModifier(boolean rollupModifier)`
`void`	`setTotalsModifier(boolean totalsModifier)` Sets whether this GROUP BY clause uses the WITH TOTALS modifier.

Methods inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode
addAllMyTokensToTokenList, addToTokenChain, appendNewNode, calculateTokenCount, doAppendNewNode, fastSetString, getAnchorNode, getColumnNo, getCommentAfterNode, getCommentBeforeNode, getCompactString, getDummyTag, getEndToken, getEvaluateDatatype, getEvalValue, getGsqlparser, getLineNo, getLocation, getMd5, getNodeStatus, getNodeType, getParentObjectName, getPlainText, getStartToken, getTokenCount, hasNext, init, init, init, init, init, init, init, init, insertAfterAToken, insertNewNodeBeforeMe, isChanged, isTokensInChain, next, refreshAllNodesTokenCount, remove, removeAllMyTokensFromTokenList, removeTokens, removeTokensBetweenNodes, removeTokensBetweenToken, replaceWithNewNode, resetIterator, setAnchorNode, setChanged, setDummyTag, setEndToken, setEndToken, setEndToken, setEndToken, setEndToken, setEndTokenDirectly, setEvaluateDatatype, setEvalValue, setGsqlparser, setIncludingComment, setLocation, setNewSubNode, setNodeStatus, setNodeType, setParent, setPlainText, setStartToken, setStartToken, setStartToken, setStartToken, setStartTokenDirectly, setString, setString2, subNodeInNode, toScript, toString, toString2

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Iterator
forEachRemaining

- Constructor Detail
  - TGroupBy
```
public TGroupBy()
```
- Method Detail
  - setQualifyClause
```
public void setQualifyClause(TQualifyClause qualifyClause)
```
  - getQualifyClause
```
public TQualifyClause getQualifyClause()
```
  - getBindings
```
public TPTNodeList<TBinding> getBindings()
```
  - setCubeModifier
```
public void setCubeModifier(boolean cubeModifier)
```
  - isCubeModifier
```
public boolean isCubeModifier()
```
  - setRollupModifier
```
public void setRollupModifier(boolean rollupModifier)
```
  - isRollupModifier
```
public boolean isRollupModifier()
```
  - setTotalsModifier
```
public void setTotalsModifier(boolean totalsModifier)
```
    Sets whether this GROUP BY clause uses the WITH TOTALS modifier.
    WITH TOTALS adds an extra row with totals to the result, which is the sum across all values in the column.
    Applies to ClickHouse.
    
    Parameters:
    
    totalsModifier - true if WITH TOTALS is used, false otherwise
  - isTotalsModifier
```
public boolean isTotalsModifier()
```
    Returns whether this GROUP BY clause uses the WITH TOTALS modifier.
    WITH TOTALS adds an extra row with totals to the result.
    
    Returns:
    
    true if WITH TOTALS is used, false otherwise
  - setAllModifier
```
public void setAllModifier(boolean allModifier)
```
    Sets whether this GROUP BY clause uses the ALL modifier.
    GROUP BY ALL is a shorthand notation to add all SELECT-list expressions not containing aggregate functions as group expressions.
    Applies to Databricks SQL Databricks Runtime 12.2 LTS and above.
    
    Parameters:
    
    allModifier - true if GROUP BY ALL is used, false otherwise
  - isAllModifier
```
public boolean isAllModifier()
```
    Returns whether this GROUP BY clause uses the ALL modifier.
    GROUP BY ALL automatically groups by all non-aggregate expressions in the SELECT clause.
    
    Returns:
    
    true if GROUP BY ALL is used, false otherwise
  - setBY
```
public void setBY(TSourceToken BY)
```
  - setGROUP
```
public void setGROUP(TSourceToken GROUP)
```
  - setHAVING
```
public void setHAVING(TSourceToken HAVING)
```
  - setALL
```
public void setALL(TSourceToken ALL)
```
    Sets the ALL token for GROUP BY ALL syntax.
    
    Parameters:
    
    ALL - the ALL token
  - getBY
```
public TSourceToken getBY()
```
  - getGROUP
```
public TSourceToken getGROUP()
```
  - getHAVING
```
public TSourceToken getHAVING()
```
  - getALL
```
public TSourceToken getALL()
```
    Gets the ALL token for GROUP BY ALL syntax.
    
    Returns:
    
    the ALL token, or null if GROUP BY ALL is not used
  - getHavingClause
```
public TExpression getHavingClause()
```
    Restrict the groups of returned rows to those groups for which the specified condition is TRUE.
    If you omit this clause, then the database returns summary rows for all groups.
    
    Returns:
  - getItems
```
public TGroupByItemList getItems()
```
    Returns:
    
    Items in group by clause, can be expr, rollup_cube_clause and grouping_sets_clause.
    
    See Also:
    
    TExpression, TRollupCube, TGroupingSet
  - setHavingClause
```
public void setHavingClause(TExpression havingClause)
```
  - init
```
public void init(Object arg1)
```
    Description copied from class: TParseTreeNode
    
    Initialize a query tree node. Used internally
    
    Overrides:
    
    init in class TParseTreeNode
    
    Parameters:
    
    arg1 - first argument
  - init
```
public void init(Object arg1,
                 Object arg2)
```
    Overrides:
    
    init in class TParseTreeNode
  - doParse
```
public void doParse(TCustomSqlStatement psql,
                    ESqlClause plocation)
```
    Description copied from class: TParseTreeNode
    
    Analyze the sub-nodes inside this node. Such as build the relationship between table and column.
    
    Overrides:
    
    doParse in class TParseTreeNode
    
    Parameters:
    
    psql - SQL statement this node belongs to
    
    plocation - SQL clause this node belongs to
  - setBindings
```
public void setBindings(TPTNodeList<TBinding> bindings)
```
  - accept
```
public void accept(TParseTreeVisitor v)
```
    Description copied from class: TParseTreeNode
    
    Accept a visitor
    
    Specified by:
    
    accept in interface Visitable
    
    Overrides:
    
    accept in class TParseTreeNode
    
    Parameters:
    
    v - visitor is a descendant class of TParseTreeVisitor
  - acceptChildren
```
public void acceptChildren(TParseTreeVisitor v)
```
    Description copied from class: TParseTreeNode
    
    Accept a visitor to iterate this class and sub-nodes of this class
    
    Specified by:
    
    acceptChildren in interface Visitable
    
    Overrides:
    
    acceptChildren in class TParseTreeNode
    
    Parameters:
    
    v - visitor is a descendant class of TParseTreeVisitor
  - setItems
```
public void setItems(TGroupByItemList items)
```

Class TGroupBy

Field Summary

Fields inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

Constructor Summary

Method Summary

Methods inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

Methods inherited from class Object

Methods inherited from interface Iterator

Constructor Detail

TGroupBy

Method Detail

setQualifyClause

getQualifyClause

getBindings

setCubeModifier

isCubeModifier

setRollupModifier

isRollupModifier

setTotalsModifier

isTotalsModifier

setAllModifier

isAllModifier

setBY

setGROUP

setHAVING

setALL

getBY

getGROUP

getHAVING

getALL

getHavingClause

getItems

setHavingClause

init

init

doParse

setBindings

accept

acceptChildren

setItems