TConstant (gudusoft.gsqlparser 2.0.1.0 API)

java.lang.Object
- gudusoft.gsqlparser.nodes.TParseTreeNode
- - gudusoft.gsqlparser.nodes.TConstant

All Implemented Interfaces:

Visitable
```
public class TConstant
extends TParseTreeNode
```
SQL constant (sometimes called a literal) specifies a value. Constants are classified as:
- string(text) constants
- numeric constants,Numeric constants are further classified as integer, floating-point, or decimal
- datetime constants
- interval constants
- boolean constants

Constructor Summary

Constructors
Constructor and Description
`TConstant()`
`TConstant(ELiteralType pLiteralType)` Class constructor, set the type of this constant while creating a new instance of the constant
`TConstant(ELiteralType literalType, TSourceToken valueToken)` Class constructor, set the type and value of this constant when creating a new instance of the constant
`TConstant(ELiteralType literalType, TSourceToken valueToken, EIntervalType intervalType)` Class constructor, set the type and value of this constant when creating a new instance of the constant.

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
`TSourceToken`	`getBind1()`
`TSourceToken`	`getBind2()`
`TTypeName`	`getCastType()` Constants can be specified with explicit types.
`TSourceToken`	`getFractionalSecondsPrecision()` the number of digits in the fractional part of the SECOND datetime field in a interval day to second constant.
`TSourceToken`	`getIndicator()`
`EIntervalType`	`getIntervalType()` Oracle interval year to month and interval day to second constant.
`TSourceToken`	`getLeadingPrecision()` the maximum number of digits in the leading field of a interval constant.
`ELiteralType`	`getLiteralType()` get type of this constant, can be strings, integers, and floating point numbers and more.
`TSourceToken`	`getSign()` The '+' or '-' before this constant.
`TSourceTokenList`	`getStringLiteralSequence()` String list constant in Hive.
`String`	`getStringValue()` Deprecated. since 1.8.2.4, use `getValue()` instead.
`String`	`getValue()` Deprecated. use `getValueToken()` instead
`TSourceToken`	`getValueToken()` The value of this constant represented by a source token.
`void`	`init(Object arg1)` Initialize a query tree node.
`void`	`init(Object arg1, Object arg2)`
`void`	`init(Object arg1, Object arg2, Object arg3)`
`void`	`init(Object arg1, Object arg2, Object arg3, Object arg4)`
`void`	`setBind1(TSourceToken bind1)`
`void`	`setBind2(TSourceToken bind2)`
`void`	`setCastType(TTypeName castType)` Set the explicit type of this constant
`void`	`setFractionalSecondsPrecision(TSourceToken fractionalSecondsPrecision)` set the fractional precision which is the number of digits in the fractional part of the SECOND datetime field in a interval day to second constant.
`void`	`setIndicator(TSourceToken indicator)`
`void`	`setIntervalType(EIntervalType intervalType)` Set the sub-type of interval constant
`void`	`setLeadingPrecision(TSourceToken leadingPrecision)` set the precision which is the maximum number of digits in the leading field of a interval constant.
`void`	`setLiteralType(ELiteralType literalType)` The type of this constant.
`void`	`setSign(TSourceToken sign)` The '+' or '-' before this constant.
`void`	`setStringLiteralSequence(TSourceTokenList stringLiteralSequence)`
`void`	`setStringValue(String stringValue)` Deprecated. use `getValueToken()` instead
`void`	`setValueToken(TSourceToken valueToken)` set value of this constant

Methods inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode
addAllMyTokensToTokenList, appendString, doParse, fastSetString, getColumnNo, getDummyTag, getEndToken, getGsqlparser, getLineNo, getNodeType, getStartToken, init, init, removeAllMyTokensFromTokenList, setDummyTag, setEndToken, setEndToken, setEndToken, setEndToken, setGsqlparser, setIncludingComment, setNodeType, setStartToken, setStartToken, setStartToken, setStartToken, setString, toScript, toString

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

- Constructor Detail
  - TConstant
```
public TConstant()
```
  - TConstant
```
public TConstant(ELiteralType pLiteralType)
```
    Class constructor, set the type of this constant while creating a new instance of the constant
    
    Parameters:
    
    pLiteralType - type of this constant
  - TConstant
```
public TConstant(ELiteralType literalType,
                 TSourceToken valueToken)
```
    Class constructor, set the type and value of this constant when creating a new instance of the constant
    
    Parameters:
    
    literalType - type of this constant
    
    valueToken - value of this constant
  - TConstant
```
public TConstant(ELiteralType literalType,
                 TSourceToken valueToken,
                 EIntervalType intervalType)
```
    Class constructor, set the type and value of this constant when creating a new instance of the constant. set the sub-type of an interval constant.
    
    Parameters:
    
    literalType - type of this constant, must be etInterval
    
    valueToken - value of this constant
    
    intervalType - sub-type of an interval constant
- Method Detail
  - setCastType
```
public void setCastType(TTypeName castType)
```
    Set the explicit type of this constant
    
    Parameters:
    
    castType - explicit type
    
    See Also:
    
    getCastType()
  - getCastType
```
public TTypeName getCastType()
```
    Constants can be specified with explicit types. This method returns the explicit type. In PostgreSQL, a constant of an arbitrary type can be entered using any one of the following notations:
```
     type 'string'
     'string'::type
     CAST 'string' AS type
 
```
    Returns:
    
    explicit type for this constant
  - setIntervalType
```
public void setIntervalType(EIntervalType intervalType)
```
    Set the sub-type of interval constant
    
    Parameters:
    
    intervalType - sub-type of interval constant
    
    See Also:
    
    getIntervalType()
  - getIntervalType
```
public EIntervalType getIntervalType()
```
    Oracle interval year to month and interval day to second constant. This method return sub-type of interval constant such as year to month, minute to second.
    
    Returns:
    
    sub-type of interval constant
  - setValueToken
```
public void setValueToken(TSourceToken valueToken)
```
    set value of this constant
```
     INTERVAL '30.12345' SECOND(2,4)
 
```
    '30.12345' in the above SQL in the valueToken
    Parameters:
    
    valueToken - value of this constant
  - setLeadingPrecision
```
public void setLeadingPrecision(TSourceToken leadingPrecision)
```
    set the precision which is the maximum number of digits in the leading field of a interval constant.
```
     INTERVAL '400 5' DAY(3) TO HOUR
 
```
    3 in the above SQL is the leadingPrecision
    Parameters:
    
    leadingPrecision - the precision of the leading field
  - setFractionalSecondsPrecision
```
public void setFractionalSecondsPrecision(TSourceToken fractionalSecondsPrecision)
```
    set the fractional precision which is the number of digits in the fractional part of the SECOND datetime field in a interval day to second constant.
```
     INTERVAL '30.12345' SECOND(2,4)
 
```
    4 in the above SQL is the fractionalSecondsPrecision, 2 is the leadingPrecision
    Parameters:
    
    fractionalSecondsPrecision -
  - getLeadingPrecision
```
public TSourceToken getLeadingPrecision()
```
    the maximum number of digits in the leading field of a interval constant.
```
     INTERVAL '400 5' DAY(3) TO HOUR
 
```
    3 in the above SQL is the leadingPrecision
    Returns:
    
    the leading precision
  - getFractionalSecondsPrecision
```
public TSourceToken getFractionalSecondsPrecision()
```
    the number of digits in the fractional part of the SECOND datetime field in a interval day to second constant.
```
     INTERVAL '30.12345' SECOND(2,4)
 
```
    4 in the above SQL is the fractionalSecondsPrecision, 2 is the leadingPrecision
    Returns:
    
    the fractional seconds precision
  - setStringValue
```
public void setStringValue(String stringValue)
```
    Deprecated. use getValueToken() instead
    
    Parameters:
    
    stringValue - text value of this constant
  - getValue
```
public String getValue()
```
    Deprecated. use getValueToken() instead
    
    Returns:
    
    text value of this constant
  - getStringValue
```
public String getStringValue()
```
    Deprecated. since 1.8.2.4, use getValue() instead.
    
    Returns:
    
    text value of this constant
  - getLiteralType
```
public ELiteralType getLiteralType()
```
    get type of this constant, can be strings, integers, and floating point numbers and more. Please check ELiteralType for more type of constant
    
    Returns:
    
    type of this constant
  - setStringLiteralSequence
```
public void setStringLiteralSequence(TSourceTokenList stringLiteralSequence)
```
  - getStringLiteralSequence
```
public TSourceTokenList getStringLiteralSequence()
```
    String list constant in Hive.
    
    Returns:
    
    a sequence of source token
  - setSign
```
public void setSign(TSourceToken sign)
```
    The '+' or '-' before this constant. Valid only when getLiteralType() is ELiteralType.etNumber
    
    Parameters:
    
    sign - the '+' or '-' token
  - getSign
```
public TSourceToken getSign()
```
    The '+' or '-' before this constant. Valid only when getLiteralType() is ELiteralType.etNumber
    
    Returns:
    
    the '+' or '-' token
  - getValueToken
```
public TSourceToken getValueToken()
```
    The value of this constant represented by a source token.
    
    Returns:
    
    the value of this constant
  - 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
  - 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
  - setLiteralType
```
public void setLiteralType(ELiteralType literalType)
```
    The type of this constant.
    The most used type are: etNumber,etFloat,etString,etTimestamp,etDate,etInterval
    
    Parameters:
    
    literalType - the type of this constant
  - init
```
public void init(Object arg1,
                 Object arg2)
```
    Overrides:
    
    init in class TParseTreeNode
  - setBind1
```
public void setBind1(TSourceToken bind1)
```
  - setBind2
```
public void setBind2(TSourceToken bind2)
```
  - setIndicator
```
public void setIndicator(TSourceToken indicator)
```
  - getBind1
```
public TSourceToken getBind1()
```
  - getBind2
```
public TSourceToken getBind2()
```
  - getIndicator
```
public TSourceToken getIndicator()
```
  - init
```
public void init(Object arg1,
                 Object arg2,
                 Object arg3)
```
    Overrides:
    
    init in class TParseTreeNode
  - init
```
public void init(Object arg1,
                 Object arg2,
                 Object arg3,
                 Object arg4)
```
    Overrides:
    
    init in class TParseTreeNode

Class TConstant

Constructor Summary

Method Summary

Methods inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

Methods inherited from class java.lang.Object

Constructor Detail

TConstant

TConstant

TConstant

TConstant

Method Detail

setCastType

getCastType

setIntervalType

getIntervalType

setValueToken

setLeadingPrecision

setFractionalSecondsPrecision

getLeadingPrecision

getFractionalSecondsPrecision

setStringValue

getValue

getStringValue

getLiteralType

setStringLiteralSequence

getStringLiteralSequence

setSign

getSign

getValueToken

accept

acceptChildren

init

setLiteralType

init

setBind1

setBind2

setIndicator

getBind1

getBind2

getIndicator

init

init