TPivotClause (General SQL Parser Java Library Core 4.2.19 API)

Object
- gudusoft.gsqlparser.nodes.TParseTreeNode
- - gudusoft.gsqlparser.nodes.TNodeWithAliasClause
  - - gudusoft.gsqlparser.nodes.TPivotClause

All Implemented Interfaces:

IRelation, Visitable, Iterator<TSourceToken>
```
public class TPivotClause
extends TNodeWithAliasClause
implements IRelation
```
use the PIVOT and UNPIVOT relational operators to change a table-valued expression into another table.

Field Summary

Fields
Modifier and Type Field and Description

static int pivot

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

Fields
Modifier and Type	Field and Description
`static int`	`pivot`
`static int`	`unpivot`

Constructor Summary

Constructors
Constructor and Description

TPivotClause()

Constructors
Constructor and Description
`TPivotClause()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated 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.
`TResultColumnList`	`getAggregation_function_list()`
`TFunctionCall`	`getAggregation_function()`
`ArrayList<TAttributeNode>`	`getAttributes()` 每个 relation 包含的 attributes 当它为 base table 时，这些 attributes 的来源有三种可能 1.
`TObjectNameList`	`getColumnList()`
`String`	`getDisplayName()`
`List<String>`	`getGeneratedColumnNames()` The names of the columns this operator generates, in text order, duplicates included: for UNPIVOT its value and FOR columns, for PIVOT the names of its alias column list or one per IN item.
`List<Boolean>`	`getGeneratedColumnStored()` For each name of `getGeneratedColumnNames()`, whether it is the column's stored name as written: the literal of an unaliased IN value in a dialect that names the column after it (`IN ('direct')` in Oracle names the column `'direct'`, referenced as `"'direct'"`), never an identifier spelling to fold.
`TResultColumnList`	`getIn_result_list()` Deprecated. since 1.7.1.1, use `getPivotInClause()` instead
`TObjectName`	`getPivotColumn()` Deprecated. since 1.7.1.1 , use `getPivotColumnList()` instead.
`TObjectNameList`	`getPivotColumnList()`
`TPivotInClause`	`getPivotInClause()`
`TTable`	`getPivotTable()`
`String`	`getRelationName()`
`int`	`getType()`
`TUnpivotInClause`	`getUnpivotInClause()`
`TObjectName`	`getValueColumn()` Deprecated. since 1.7.1.1, use `getValueColumnList()` instead.
`TObjectNameList`	`getValueColumnList()`
`void`	`init(Object arg1, Object arg2)`
`void`	`init(Object arg1, Object arg2, Object arg3)`
`void`	`initAttributes()`
`void`	`setAggregation_function_list(TResultColumnList aggregation_function_list)`
`void`	`setAggregation_function(TFunctionCall aggregation_function)`
`void`	`setColumnList(TObjectNameList columnList)`
`void`	`setPivotColumnList(TObjectNameList pivotColumnList)`
`void`	`setPivotInClause(TPivotInClause pivotInClause)`
`void`	`setType(int type)`
`void`	`setUnpivotInClause(TUnpivotInClause unpivotInClause)`
`void`	`setValueColumnList(TObjectNameList valueColumnList)`
`int`	`size()`

Methods inherited from class gudusoft.gsqlparser.nodes.TNodeWithAliasClause
getAliasClause, setAliasClause, toString

Methods inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode
addAllMyTokensToTokenList, addToTokenChain, appendNewNode, calculateTokenCount, commentBlockAfter, commentBlockEndAfter, doAppendNewNode, fastSetString, getAnchorNode, getColumnNo, getCommentAfterNode, getCommentBeforeNode, getCommentBeforeNode, 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, toString2

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

Methods inherited from interface Iterator
forEachRemaining

- Field Detail
  - pivot
```
public static final int pivot
```
    See Also:
    
    Constant Field Values
  - unpivot
```
public static final int unpivot
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TPivotClause
```
public TPivotClause()
```
- Method Detail
  - getAttributes
```
public ArrayList<TAttributeNode> getAttributes()
```
    Description copied from interface: IRelation
    
    每个 relation 包含的 attributes 当它为 base table 时，这些 attributes 的来源有三种可能 1. 来自数据库的 metadata，第一次 resolve 时就可以获取，来自 sqlenv 2. 来自 create table ddl，第一次 resolve 时就可以获取，来自 sqlenv 3. 来自 sql script，第二次 resolve 时，来自relation的 referenceAttribute 属性。第一、二中来源是可靠的来源，attributes应该是完整的，第三种推断自 sql script，attributes很可能是不完整的。
    
    Specified by:
    
    getAttributes in interface IRelation
    
    Returns:
  - size
```
public int size()
```
    Specified by:
    
    size in interface IRelation
  - getRelationName
```
public String getRelationName()
```
    Specified by:
    
    getRelationName in interface IRelation
  - getDisplayName
```
public String getDisplayName()
```
  - initAttributes
```
public void initAttributes()
```
  - getPivotTable
```
public TTable getPivotTable()
```
  - getGeneratedColumnNames
```
public List<String> getGeneratedColumnNames()
```
    The names of the columns this operator generates, in text order, duplicates included: for UNPIVOT its value and FOR columns, for PIVOT the names of its alias column list or one per IN item. The rule is resolver2's (PivotNamespace.generatedColumnNames), so a consumer that publishes a pivot's columns names them as a reference to them is resolved (plan 09 slice 10).
  - getGeneratedColumnStored
```
public List<Boolean> getGeneratedColumnStored()
```
    For each name of getGeneratedColumnNames(), whether it is the column's stored name as written: the literal of an unaliased IN value in a dialect that names the column after it (IN ('direct') in Oracle names the column 'direct', referenced as "'direct'"), never an identifier spelling to fold.
  - getPivotInClause
```
public TPivotInClause getPivotInClause()
```
  - getUnpivotInClause
```
public TUnpivotInClause getUnpivotInClause()
```
  - getPivotColumnList
```
public TObjectNameList getPivotColumnList()
```
  - getIn_result_list
```
public TResultColumnList getIn_result_list()
```
    Deprecated. since 1.7.1.1, use getPivotInClause() instead
    
    Returns:
    
    result column list
  - getAggregation_function_list
```
public TResultColumnList getAggregation_function_list()
```
  - setType
```
public void setType(int type)
```
  - getType
```
public int getType()
```
  - getValueColumnList
```
public TObjectNameList getValueColumnList()
```
  - getAggregation_function
```
public TFunctionCall getAggregation_function()
```
    Returns:
    
    Is a system or user-defined aggregate function that accepts one or more inputs.
  - getColumnList
```
public TObjectNameList getColumnList()
```
    Returns:
    
    In the PIVOT clause, lists the values in the pivot_column that will become the column names of the output table. The list cannot specify any column names that already exist in the input table_source that is being pivoted. In the UNPIVOT clause, lists the columns in table_source that will be narrowed into a single pivot_column.
  - getPivotColumn
```
public TObjectName getPivotColumn()
```
    Deprecated. since 1.7.1.1 , use getPivotColumnList() instead.
    
    Returns:
    
    Is the pivot column of the PIVOT operator.
  - getValueColumn
```
public TObjectName getValueColumn()
```
    Deprecated. since 1.7.1.1, use getValueColumnList() instead.
    
    Returns:
    
    Is the value column of the PIVOT operator. When used with UNPIVOT, value_column cannot be the name of an existing column in the input table_source.
  - init
```
public void init(Object arg1,
                 Object arg2)
```
    Overrides:
    
    init in class TParseTreeNode
  - init
```
public void init(Object arg1,
                 Object arg2,
                 Object arg3)
```
    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
  - 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
  - setPivotInClause
```
public void setPivotInClause(TPivotInClause pivotInClause)
```
  - setUnpivotInClause
```
public void setUnpivotInClause(TUnpivotInClause unpivotInClause)
```
  - setAggregation_function_list
```
public void setAggregation_function_list(TResultColumnList aggregation_function_list)
```
  - setPivotColumnList
```
public void setPivotColumnList(TObjectNameList pivotColumnList)
```
  - setAggregation_function
```
public void setAggregation_function(TFunctionCall aggregation_function)
```
  - setValueColumnList
```
public void setValueColumnList(TObjectNameList valueColumnList)
```
  - setColumnList
```
public void setColumnList(TObjectNameList columnList)
```

Class TPivotClause

Field Summary

Fields inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

Constructor Summary

Method Summary

Methods inherited from class gudusoft.gsqlparser.nodes.TNodeWithAliasClause

Methods inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

Methods inherited from class Object

Methods inherited from interface Iterator

Field Detail

pivot

unpivot

Constructor Detail

TPivotClause

Method Detail

getAttributes

size

getRelationName

getDisplayName

initAttributes

getPivotTable

getGeneratedColumnNames

getGeneratedColumnStored

getPivotInClause

getUnpivotInClause

getPivotColumnList

getIn_result_list

getAggregation_function_list

setType

getType

getValueColumnList

getAggregation_function

getColumnList

getPivotColumn

getValueColumn

init

init

doParse

accept

acceptChildren

setPivotInClause

setUnpivotInClause

setAggregation_function_list

setPivotColumnList

setAggregation_function

setValueColumnList

setColumnList