TFunctionCall (gudusoft.gsqlparser 2.0.1.0 API)

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

All Implemented Interfaces:

Visitable

Direct Known Subclasses:

TDaxFunction
```
public class TFunctionCall
extends TParseTreeNode
```
Represents the database function, all functions are represented by this class no matter what's type of the function. Maybe it's a better idea to create the specific sub-class for function with different syntax such as the built-in function extract, convert, substring and others. We may implement this feature in the later version.
For the most of functions, the arguments are a lists of TExpression. For other functions with the different syntax in arguments, please check the detailed information below. this class includes function name and arguments.
There are 3 types of functions:
- Arguments is a list of expressions
- Analytic function
- Function with specific arguments, such as cast function
1.Arguments is a list of expressions
function([expr,expr, ...])
- function name: getFunctionName()
- args: getArgs()
2.Analytic function
Use getWindowDef() to get over clause information.
3.Function with specific arguments
trim
- type: EFunctionType.trim_t
- arg: getTrimArgument()
cast(expr as typename), cast(expr as typename [,datatypeAttribute]), cast(expr as datatypeAttribute)
- type:EFunctionType.cast_t
- expr: getExpr1()
- typename: getTypename(), datatypeAttribute is included in TTypeName as well
convert(typename,[null|not null] expr1 [,expr2]),
- type: EFunctionType.convert_t
- expr1: getExpr1()
- expr2: getExpr2()
- typename: getTypename()
extract([time_token from expr]),
- type: EFunctionType.extract_t
- expr: getExpr1()
- time_token: getExtract_time_token()
sql server contains function,contains(in_expr, expr [,langTerm]),
- type: EFunctionType.contains_t
- expr: getExpr1()
- in_expr: getInExpr()
sql server freetext,freetext(contain in expr, expr [,langTerm]),
- type: EFunctionType.freetext_t
- expr: getExpr1()
- in_expr: getInExpr()
Oracle Extract(XML): extract(XMLType_instance, XPath_string[,namespace_string]),
- type: EFunctionType.extractxml_t
- XMLType_instance: getXMLType_Instance()
- XPath_string: getXPath_String()
- namespace_string: getNamespace_String()
Rank(value,...),
- type: EFunctionType.rank_t
- value list getOrderByList()
XMLPassingClause of XMLExists function
- type: EFunctionType.xmlexists_t
- value list getPassingClause()

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`fntAddDate` Deprecated. As of v1.4.3.0, replaced by `EFunctionType.adddate_t`
`static int`	`fntCaseN` Deprecated. As of v1.4.3.0, replaced by `EFunctionType.case_n_t`
`static int`	`fntCast` Deprecated. As of v1.4.3.0, replaced by `EFunctionType.cast_t`
`static int`	`fntContains` Deprecated. As of v1.4.3.0, replaced by `EFunctionType.contains_t`
`static int`	`fntConvert` Deprecated. As of v1.4.3.0, replaced by `EFunctionType.convert_t`
`static int`	`fntCSUM` Deprecated. As of v1.4.3.0, replaced by `EFunctionType.csum_t`
`static int`	`fntDateAdd` Deprecated. As of v1.4.3.0, replaced by `EFunctionType.date_add_t`
`static int`	`fntDateSub` Deprecated. As of v1.4.3.0, replaced by `EFunctionType.date_sub_t`
`static int`	`fntExtract` Deprecated. As of v1.4.3.0, replaced by `EFunctionType.extract_t`
`static int`	`fntExtractXML` Deprecated. As of v1.4.3.0, replaced by `EFunctionType.extract_t`
`static int`	`fntFreetext` Deprecated. As of v1.4.3.0, replaced by `EFunctionType.freetext_t`
`static int`	`fntGroupConcat` Deprecated. As of v1.4.3.0, replaced by `EFunctionType.group_concat_t`
`static int`	`fntMatchAgainst` Deprecated. As of v1.4.3.0, replaced by `EFunctionType.match_against_t`
`static int`	`fntOGC` Deprecated. As of v1.4.3.0, replaced by `EFunctionType.ogc_t`
`static int`	`fntPosition` Deprecated. As of v1.4.3.0, replaced by `EFunctionType.position_t`
`static int`	`fntRangeN` Deprecated. As of v1.4.3.0, replaced by `EFunctionType.range_n_t`
`static int`	`fntRank` Deprecated. As of v1.4.3.0, replaced by `EFunctionType.rank_t`
`static int`	`fntSubDate` Deprecated. As of v1.4.3.0, replaced by `EFunctionType.subdate_t`
`static int`	`fntSubstring` Deprecated. As of v1.4.3.0, replaced by `EFunctionType.substring_t`
`static int`	`fntSubString` Deprecated. As of v1.4.3.0, replaced by `EFunctionType.substring_t`
`static int`	`fntTimestampAdd` Deprecated. As of v1.4.3.0, replaced by `EFunctionType.timestampadd_t`
`static int`	`fntTimestampDiff` Deprecated. As of v1.4.3.0, replaced by `EFunctionType.timestampdiff_t`
`static int`	`fntTranslate` Deprecated. As of v1.4.3.0, replaced by `EFunctionType.translate_t`
`static int`	`fntTranslateCHK` Deprecated. As of v1.4.3.0, replaced by `EFunctionType.translate_chk_t`
`static int`	`fntTreat` Deprecated. As of v1.4.3.0, replaced by `EFunctionType.treat_t`
`static int`	`fntTrim` Deprecated. As of v1.4.3.0, replaced by `EFunctionType.trim_t`
`static int`	`fntUdf` Deprecated. As of v1.4.3.0, replaced by `EFunctionType.udf_t`
`static int`	`fntXmlQuery` Deprecated. As of v1.4.3.0, replaced by `EFunctionType.xmlquery_t`
`TExpression`	`Trim_Expr`
`TExpression`	`Trim_From_Expr`

Constructor Summary

Constructors
Constructor and Description

TFunctionCall()

Constructors
Constructor and Description
`TFunctionCall()`

Method Summary

All Methods Static 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.
`TExpression`	`getAgainstExpr()` against expr in match function of MySQL
`EAggregateType`	`getAggregateType()` get `ALL \| DISTINCT \| UNIQUE` keywords used in an aggregate function.
`TAnalyticFunction`	`getAnalyticFunction()` Deprecated. As of v1.8.6.3, use `getWindowDef()` instead window clause in window function.
`TExpressionList`	`getArgs()` get the list of parameters defined in this function
`TTypeName`	`getAsDatatype()` get datatype defined in Oracle XMLSERIALIZE(value_expr as datatype)
`TExpression`	`getBetweenExpr()` get `between start and end expression` in Teradata range_n function.
`TExpressionCallTarget`	`getCallTarget()` get an xml type column, parameter, variable or subquery.
`TExpression`	`getCastOperand()` The first operand in the cast specification.
`TExpression`	`getColumnNameOrListExpression()` get column name or column list in SQL Server contains predicate.
`TDatatypeAttribute`	`getDatatypeAttribute()` Not used.
`TExpression`	`getDateExpression()` date, time or timestamp expression in extract function of DB2, Greenplum.
`TDummy`	`getDummy()` Not used
`TExpression`	`getExpr1()` paramter of following functions teradata: position function, sql server: convert; oracle: convert,translate,cast,oracle XMLSERIALIZE(value_expr), oracle XMLROOT (value_expr) mysql: substring
`TExpression`	`getExpr2()`
`TExpression`	`getExpr3()`
`TExpressionList`	`getExprList()` return TExpressionList instead of TGroupingExpressionItemList after v1.4.3.3
`TSourceToken`	`getExtract_time_token()` one of the YEAR/MONTH/DAY, HOUR/MINUTE/SECOND keywords in extract function
`TObjectName`	`getFunctionName()`
`EFunctionType`	`getFunctionType()`
`int`	`getFuncType()` Deprecated. As of v1.4.3.0, replaced by `getFunctionType()`.
`TGroupConcatParam`	`getGroupConcatParam()`
`TInExpr`	`getInExpr()`
`String`	`getIntervalUnit()`
`TExpression`	`getLengthExpression()` The length of the `getSourceExpression()` string unit to be returned in substring function.
`TObjectNameList`	`getMatchColumns()` column list in match function of MySQL
`TExpression`	`getNamespace_String()`
`TOrderByItemList`	`getOrderByList()` arguments in rank(value,...) function.
`TExpression`	`getParameter()` parameter in function:convert(datetype,parameter,style)
`TXMLPassingClause`	`getPassingClause()` XMLPassingClause of XMLExists function
`TExpression`	`getRangeSize()`
`TExpression`	`getSearchCondition()` contains search condition.
`TExpression`	`getSeparatorExpr()` DB2 listagg function.
`TOrderBy`	`getSortClause()`
`TExpression`	`getSourceExpression()` An expression that specifies the string from which the result is derived in substring function.
`TExpression`	`getStartExpression()` A start expression that specifies the position within `getSourceExpression()` that is to be the first string unit of the result in substring function.
`TExpression`	`getStringExpr()` DB2 listagg function
`TExpression`	`getStyle()` style in function:convert(datetype,parameter,style)
`TTrimArgument`	`getTrimArgument()`
`TExpression`	`getTypeExpression()` A structured type expression in subtype-treatment.
`TTypeName`	`getTypename()`
`TWindowDef`	`getWindowDef()` Over clause of analytic function
`TWindowSpecification`	`getWindowSpecification()`
`TXMLAttributesClause`	`getXMLAttributesClause()` XMLAttribute clause in xmlelement function
`TExpression`	`getXMLElementNameExpr()` XMLElement name/evalname expr
`TResultColumnList`	`getXMLElementValueExprList()` XMLElement ( value_expr [,XML_attribute_clause] [,value expr list] )
`TResultColumnList`	`getXMLForestValueList()` XMLFOREST (value_expr [as aliasName], ...
`TExpression`	`getXMLType_Instance()`
`TExpression`	`getXPath_String()`
`void`	`init(Object arg1)` Initialize a query tree node.
`void`	`init(Object arg1, Object arg2)`
`boolean`	`isBuiltIn(EDbVendor pDBVendor)`
`static boolean`	`isBuiltIn(String pName, EDbVendor pDBVendor)`
`void`	`setAgainstExpr(TExpression againstExpr)` against expr in match function of MySQL
`void`	`setAggregateType(EAggregateType aggregateType)` set `ALL \| DISTINCT \| UNIQUE` keywords used in an aggregate function.
`void`	`setAnalyticFunction(TAnalyticFunction analyticFunction)`
`void`	`setArgs(TExpressionList args)`
`void`	`setAsDatatype(TTypeName asDatatype)` datatype defined in Oracle function: `XMLSERIALIZE(value_expr as datatype)`
`void`	`setBetweenExpr(TExpression betweenExpr)` set `between start and end expression` in Teradata range_n function.
`void`	`setBuiltIn(boolean isBuiltIn)`
`void`	`setCallTarget(TExpressionCallTarget callTarget)` set expressionCallTarget
`void`	`setCastOperand(TExpression castOperand)` cast specification, set the first operand in the cast specification
`void`	`setCheckedBuiltIn(boolean isCheckedBuiltIn)`
`void`	`setColumnNameOrListExpression(TExpression columnNameOrListExpression)` set column name or column list of SQL Server contains predicate or freetext predicate
`void`	`setDatatypeAttribute(TDatatypeAttribute datatypeAttribute)` Not used.
`void`	`setDateExpression(TExpression dateExpression)` set date, time or timestamp expression in extract/extend function.
`void`	`setDummy(TDummy dummy)` Set value for temporary use only
`void`	`setExpr1(TExpression expr1)`
`void`	`setExpr2(TExpression expr2)`
`void`	`setExpr3(TExpression expr3)`
`void`	`setExprList(TExpressionList exprList)`
`void`	`setExtract_time_token(TSourceToken extract_time_token)` set one of the YEAR/MONTH/DAY, HOUR/MINUTE/SECOND keyword in extract function
`void`	`setExtractXMLArg(TExpressionList exprList)`
`void`	`setFunctionName(TObjectName functionName)`
`void`	`setFunctionType(EFunctionType functionType)`
`void`	`setFuncType(int funcType)` Deprecated. As of v1.4.3.0
`void`	`setGroupConcatParam(TGroupConcatParam groupConcatParam)`
`void`	`setInExpr(TInExpr inExpr)`
`void`	`setIntervalUnit(String intervalUnit)`
`void`	`setLengthExpression(TExpression lengthExpression)` set the length expression in substring function.
`void`	`setMatchColumns(TObjectNameList matchColumns)`
`void`	`setNamespace_String(TExpression namespace_String)`
`void`	`setOrderByList(TOrderByItemList orderByList)`
`void`	`setParameter(TExpression parameter)`
`void`	`setPassingClause(TXMLPassingClause passingClause)`
`void`	`setRangeSize(TExpression rangeSize)`
`void`	`setSearchCondition(TExpression searchCondition)` contains search condition.
`void`	`setSeparatorExpr(TExpression separatorExpr)`
`void`	`setSortClause(TOrderBy sortClause)`
`void`	`setSourceExpression(TExpression sourceExpression)` set an expression that specifies the string from which the result is derived in substring function.
`void`	`setStartExpression(TExpression startExpression)` set a start expression that specifies the position within `getSourceExpression()` that is to be the first string unit of the result in substring function.
`void`	`setStringExpr(TExpression stringExpr)`
`void`	`setStyle(TExpression style)`
`void`	`setTrim_Expr(TExpression trim_Expr)`
`void`	`setTrim_From_Expr(TExpression trim_From_Expr)`
`void`	`setTrimArgument(TTrimArgument trimArgument)`
`void`	`setTypeExpression(TExpression typeExpression)` a structured type expression in DB2 subtype-treatment: treat.
`void`	`setTypename(TTypeName typename)`
`void`	`setWindowDef(TWindowDef windowDef)`
`void`	`setXMLAttributesClause(TXMLAttributesClause XMLAttributesClause)`
`void`	`setXMLElementNameExpr(TExpression XMLElementNameExpr)`
`void`	`setXMLElementValueExprList(TResultColumnList XMLElementValueExprList)`
`void`	`setXMLForestValueList(TResultColumnList XMLForestValueList)`
`void`	`setXMLType_Instance(TExpression XMLType_Instance)`
`void`	`setXPath_String(TExpression XPath_String)`

Methods inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode
addAllMyTokensToTokenList, appendString, fastSetString, getColumnNo, getDummyTag, getEndToken, getGsqlparser, getLineNo, getNodeType, getStartToken, init, init, 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

- Field Detail
  - Trim_Expr
```
public TExpression Trim_Expr
```
  - Trim_From_Expr
```
public TExpression Trim_From_Expr
```
  - fntUdf
```
public static final int fntUdf
```
    Deprecated. As of v1.4.3.0, replaced by EFunctionType.udf_t
    
    See Also:
    
    Constant Field Values
  - fntTrim
```
public static final int fntTrim
```
    Deprecated. As of v1.4.3.0, replaced by EFunctionType.trim_t
    
    See Also:
    
    Constant Field Values
  - fntCast
```
public static final int fntCast
```
    Deprecated. As of v1.4.3.0, replaced by EFunctionType.cast_t
    
    See Also:
    
    Constant Field Values
  - fntConvert
```
public static final int fntConvert
```
    Deprecated. As of v1.4.3.0, replaced by EFunctionType.convert_t
    
    See Also:
    
    Constant Field Values
  - fntExtract
```
public static final int fntExtract
```
    Deprecated. As of v1.4.3.0, replaced by EFunctionType.extract_t
    
    See Also:
    
    Constant Field Values
  - fntTreat
```
public static final int fntTreat
```
    Deprecated. As of v1.4.3.0, replaced by EFunctionType.treat_t
    
    See Also:
    
    Constant Field Values
  - fntContains
```
public static final int fntContains
```
    Deprecated. As of v1.4.3.0, replaced by EFunctionType.contains_t
    
    See Also:
    
    Constant Field Values
  - fntFreetext
```
public static final int fntFreetext
```
    Deprecated. As of v1.4.3.0, replaced by EFunctionType.freetext_t
    
    See Also:
    
    Constant Field Values
  - fntCaseN
```
public static final int fntCaseN
```
    Deprecated. As of v1.4.3.0, replaced by EFunctionType.case_n_t
    
    See Also:
    
    Constant Field Values
  - fntRangeN
```
public static final int fntRangeN
```
    Deprecated. As of v1.4.3.0, replaced by EFunctionType.range_n_t
    
    See Also:
    
    Constant Field Values
  - fntPosition
```
public static final int fntPosition
```
    Deprecated. As of v1.4.3.0, replaced by EFunctionType.position_t
    
    See Also:
    
    Constant Field Values
  - fntSubstring
```
public static final int fntSubstring
```
    Deprecated. As of v1.4.3.0, replaced by EFunctionType.substring_t
    
    See Also:
    
    Constant Field Values
  - fntTranslate
```
public static final int fntTranslate
```
    Deprecated. As of v1.4.3.0, replaced by EFunctionType.translate_t
    
    See Also:
    
    Constant Field Values
  - fntTranslateCHK
```
public static final int fntTranslateCHK
```
    Deprecated. As of v1.4.3.0, replaced by EFunctionType.translate_chk_t
    
    See Also:
    
    Constant Field Values
  - fntCSUM
```
public static final int fntCSUM
```
    Deprecated. As of v1.4.3.0, replaced by EFunctionType.csum_t
    
    See Also:
    
    Constant Field Values
  - fntRank
```
public static final int fntRank
```
    Deprecated. As of v1.4.3.0, replaced by EFunctionType.rank_t
    
    See Also:
    
    Constant Field Values
  - fntXmlQuery
```
public static final int fntXmlQuery
```
    Deprecated. As of v1.4.3.0, replaced by EFunctionType.xmlquery_t
    
    See Also:
    
    Constant Field Values
  - fntSubString
```
public static final int fntSubString
```
    Deprecated. As of v1.4.3.0, replaced by EFunctionType.substring_t
    
    See Also:
    
    Constant Field Values
  - fntAddDate
```
public static final int fntAddDate
```
    Deprecated. As of v1.4.3.0, replaced by EFunctionType.adddate_t
    
    See Also:
    
    Constant Field Values
  - fntDateAdd
```
public static final int fntDateAdd
```
    Deprecated. As of v1.4.3.0, replaced by EFunctionType.date_add_t
    
    See Also:
    
    Constant Field Values
  - fntSubDate
```
public static final int fntSubDate
```
    Deprecated. As of v1.4.3.0, replaced by EFunctionType.subdate_t
    
    See Also:
    
    Constant Field Values
  - fntDateSub
```
public static final int fntDateSub
```
    Deprecated. As of v1.4.3.0, replaced by EFunctionType.date_sub_t
    
    See Also:
    
    Constant Field Values
  - fntTimestampAdd
```
public static final int fntTimestampAdd
```
    Deprecated. As of v1.4.3.0, replaced by EFunctionType.timestampadd_t
    
    See Also:
    
    Constant Field Values
  - fntTimestampDiff
```
public static final int fntTimestampDiff
```
    Deprecated. As of v1.4.3.0, replaced by EFunctionType.timestampdiff_t
    
    See Also:
    
    Constant Field Values
  - fntGroupConcat
```
public static final int fntGroupConcat
```
    Deprecated. As of v1.4.3.0, replaced by EFunctionType.group_concat_t
    
    See Also:
    
    Constant Field Values
  - fntMatchAgainst
```
public static final int fntMatchAgainst
```
    Deprecated. As of v1.4.3.0, replaced by EFunctionType.match_against_t
    
    See Also:
    
    Constant Field Values
  - fntExtractXML
```
public static final int fntExtractXML
```
    Deprecated. As of v1.4.3.0, replaced by EFunctionType.extract_t
    
    See Also:
    
    Constant Field Values
  - fntOGC
```
public static final int fntOGC
```
    Deprecated. As of v1.4.3.0, replaced by EFunctionType.ogc_t
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TFunctionCall
```
public TFunctionCall()
```
- Method Detail
  - setIntervalUnit
```
public void setIntervalUnit(String intervalUnit)
```
  - getIntervalUnit
```
public String getIntervalUnit()
```
  - setStringExpr
```
public void setStringExpr(TExpression stringExpr)
```
  - getStringExpr
```
public TExpression getStringExpr()
```
    DB2 listagg function
    
    Returns:
    
    the first argument of the listagg function
  - setSeparatorExpr
```
public void setSeparatorExpr(TExpression separatorExpr)
```
  - getSeparatorExpr
```
public TExpression getSeparatorExpr()
```
    DB2 listagg function.
    
    Returns:
    
    the second argument of the listagg function.
  - setSearchCondition
```
public void setSearchCondition(TExpression searchCondition)
```
    contains search condition. or freetext_string in freetext predicate
    
    Parameters:
    
    searchCondition - contains search condition.
  - getSearchCondition
```
public TExpression getSearchCondition()
```
    contains search condition. It usually a string constant or a variable. SQL Server contains predicate.
```
 CONTAINS (
 {
 column_name | ( column_list )
 | *
 | PROPERTY ( { column_name }, 'property_name' )
 }
 , ''
 [ , LANGUAGE language_term ]
 )
```
    Or freetext_string in freetext predicate
```
     FREETEXT ( { column_name | (column_list) | * }
     , 'freetext_string' [ , LANGUAGE language_term ] )
 
```
    Returns:
    
    contains search condition
  - setColumnNameOrListExpression
```
public void setColumnNameOrListExpression(TExpression columnNameOrListExpression)
```
    set column name or column list of SQL Server contains predicate or freetext predicate
    
    Parameters:
    
    columnNameOrListExpression - column name or column list
    
    See Also:
    
    getColumnNameOrListExpression()
  - getColumnNameOrListExpression
```
public TExpression getColumnNameOrListExpression()
```
    get column name or column list in SQL Server contains predicate.
```
 CONTAINS (
 {
 column_name | ( column_list )
 | *
 | PROPERTY ( { column_name }, 'property_name' )
 }
 , ''
 [ , LANGUAGE language_term ]
 )
```
    Or column name or column list in freetext predicate
```
     FREETEXT ( { column_name | (column_list) | * }
     , 'freetext_string' [ , LANGUAGE language_term ] )
 
```
    If this expression represents a column name, then the type of this expression is EExpressionType.simple_object_name_t, if this expression represents a column list, then the type of this expression is EExpressionType.list_t,
    Returns:
    
    column name or column list
  - setStartExpression
```
public void setStartExpression(TExpression startExpression)
```
    set a start expression that specifies the position within getSourceExpression() that is to be the first string unit of the result in substring function.
```
     substring(sourceExpression from startExpression [for lengthExpression])
     substring(sourceExpression , startExpression [, lengthExpression])
 
```
    Parameters:
    
    startExpression - an expression that specifies the position within getSourceExpression() that is to be the first string unit of the result in substring function
    
    See Also:
    
    getStartExpression()
  - setLengthExpression
```
public void setLengthExpression(TExpression lengthExpression)
```
    set the length expression in substring function.
```
     substring(sourceExpression from startExpression [for lengthExpression])
     substring(sourceExpression , startExpression [, lengthExpression])
 
```
    Parameters:
    
    lengthExpression - the length expression in substring function.
    
    See Also:
    
    getLengthExpression()
  - getStartExpression
```
public TExpression getStartExpression()
```
    A start expression that specifies the position within getSourceExpression() that is to be the first string unit of the result in substring function.
    substring
```
     substring(sourceExpression from startExpression [for lengthExpression])
     substring(sourceExpression , startExpression [, lengthExpression])
 
```
    Returns:
    
    an expression that specifies the position within getSourceExpression() that is to be the first string unit of the result.
  - getLengthExpression
```
public TExpression getLengthExpression()
```
    The length of the getSourceExpression() string unit to be returned in substring function.
    substring
```
     substring(sourceExpression from startExpression [for lengthExpression])
     substring(sourceExpression , startExpression [, lengthExpression])
 
```
    Returns:
    
    the length of the string unit to be returned.
  - setSourceExpression
```
public void setSourceExpression(TExpression sourceExpression)
```
    set an expression that specifies the string from which the result is derived in substring function.
```
     substring(sourceExpression from startExpression [for lengthExpression])
     substring(sourceExpression , startExpression [, lengthExpression])
 
```
    Parameters:
    
    sourceExpression - An expression that specifies the string from which the result is derived
    
    See Also:
    
    getSourceExpression()
  - getSourceExpression
```
public TExpression getSourceExpression()
```
    An expression that specifies the string from which the result is derived in substring function.
    substring: DB2
```
     substring(sourceExpression from startExpression [for lengthExpression])
     substring(sourceExpression , startExpression [, lengthExpression])
 
```
    Returns:
    
    An expression that specifies the string from which the result is derived
  - setTypeExpression
```
public void setTypeExpression(TExpression typeExpression)
```
    a structured type expression in DB2 subtype-treatment: treat.
    
    Parameters:
    
    typeExpression - a structured type expression
    
    See Also:
    
    getTypeExpression()
  - getTypeExpression
```
public TExpression getTypeExpression()
```
    A structured type expression in subtype-treatment.
    treat function: DB2, Greenplum
    
    Returns:
    
    a structured type expression
  - setCastOperand
```
public void setCastOperand(TExpression castOperand)
```
    cast specification, set the first operand in the cast specification
    
    Parameters:
    
    castOperand - set the first operand in the cast specification
    
    See Also:
    
    getCastOperand()
  - getCastOperand
```
public TExpression getCastOperand()
```
    The first operand in the cast specification.
    cast specification: DB2, Greenplum,SQL Server; try_cast function of SQL Server
    
    Returns:
    
    The first operand in the cast specification
  - setDateExpression
```
public void setDateExpression(TExpression dateExpression)
```
    set date, time or timestamp expression in extract/extend function.
    
    Parameters:
    
    dateExpression - date, time or timestamp expression
    
    See Also:
    
    getDateExpression()
  - getDateExpression
```
public TExpression getDateExpression()
```
    date, time or timestamp expression in extract function of DB2, Greenplum.
    datetime or date value expression in extend function of informix.
    
    Returns:
    
    date, time or timestamp expression
  - setCallTarget
```
public void setCallTarget(TExpressionCallTarget callTarget)
```
    set expressionCallTarget
    
    Parameters:
    
    callTarget - expression call target
    
    See Also:
    
    getCallTarget()
  - getCallTarget
```
public TExpressionCallTarget getCallTarget()
```
    get an xml type column, parameter, variable or subquery.
```
     DECLARE @myDoc xml
      DECLARE @ProdID int
      SET @myDoc = '<Root>
     <ProductDescription ProductID="1" ProductName="Road Bike">
     <Features>
     <Warranty>1 year parts and labor
     <Maintenance>3 year parts and labor extended maintenance is available
     </Features>
     </ProductDescription>
     </Root>'
     SET @ProdID =  @myDoc.value('(/Root/ProductDescription/@ProductID)[1]', 'int' )
     SELECT @ProdID
 
```
    the value returned by this method represents @myDoc before the value() function. SQL Server value() Method performs an XQuery against the XML and returns a value of SQL type.
    You typically use this method to extract a value from an XML instance stored in an xml type column, parameter, or variable.
    Returns:
    
    expressionCallTarget that represents an xml type column, parameter, variable or subquery
  - setGroupConcatParam
```
public void setGroupConcatParam(TGroupConcatParam groupConcatParam)
```
  - getGroupConcatParam
```
public TGroupConcatParam getGroupConcatParam()
```
  - isBuiltIn
```
public static boolean isBuiltIn(String pName,
                                EDbVendor pDBVendor)
```
  - isBuiltIn
```
public boolean isBuiltIn(EDbVendor pDBVendor)
```
  - setPassingClause
```
public void setPassingClause(TXMLPassingClause passingClause)
```
  - getPassingClause
```
public TXMLPassingClause getPassingClause()
```
    XMLPassingClause of XMLExists function
    
    Returns:
    
    XMLPassingClause of XMLExists function
  - setAggregateType
```
public void setAggregateType(EAggregateType aggregateType)
```
    set ALL | DISTINCT | UNIQUE keywords used in an aggregate function.
    
    Parameters:
    
    aggregateType -
    
    See Also:
    
    getAggregateType()
  - getAggregateType
```
public EAggregateType getAggregateType()
```
    get ALL | DISTINCT | UNIQUE keywords used in an aggregate function. An aggregate function performs a calculation on a set of values, and returns a single value.
    
    Returns:
    
    aggregate type, one of those values: none,all,distinct,unique
  - setOrderByList
```
public void setOrderByList(TOrderByItemList orderByList)
```
  - getOrderByList
```
public TOrderByItemList getOrderByList()
```
    arguments in rank(value,...) function.
    
    Returns:
    
    a list of TOrderByItem in function: rank, csum
  - setSortClause
```
public void setSortClause(TOrderBy sortClause)
```
  - getSortClause
```
public TOrderBy getSortClause()
```
  - getWindowDef
```
public TWindowDef getWindowDef()
```
    Over clause of analytic function
    
    Returns:
    
    over clause
  - setWindowDef
```
public void setWindowDef(TWindowDef windowDef)
```
  - getWindowSpecification
```
public TWindowSpecification getWindowSpecification()
```
  - setDatatypeAttribute
```
public void setDatatypeAttribute(TDatatypeAttribute datatypeAttribute)
```
    Not used.
    
    Parameters:
    
    datatypeAttribute - datatype attribute
  - getDatatypeAttribute
```
public TDatatypeAttribute getDatatypeAttribute()
```
    Not used.
    
    Returns:
    
    datatype attribute
  - getExtract_time_token
```
public TSourceToken getExtract_time_token()
```
    one of the YEAR/MONTH/DAY, HOUR/MINUTE/SECOND keywords in extract function
    
    Returns:
    
    one of the YEAR/MONTH/DAY, HOUR/MINUTE/SECOND keywords in extract function
  - setExtract_time_token
```
public void setExtract_time_token(TSourceToken extract_time_token)
```
    set one of the YEAR/MONTH/DAY, HOUR/MINUTE/SECOND keyword in extract function
    
    Parameters:
    
    extract_time_token - one of the YEAR/MONTH/DAY, HOUR/MINUTE/SECOND token
  - setDummy
```
public void setDummy(TDummy dummy)
```
    Set value for temporary use only
    
    Parameters:
    
    dummy - a temporary value from parse tree
  - getDummy
```
public TDummy getDummy()
```
    Not used
    
    Returns:
    
    a temporary value
  - setInExpr
```
public void setInExpr(TInExpr inExpr)
```
  - getInExpr
```
public TInExpr getInExpr()
```
  - setExtractXMLArg
```
public void setExtractXMLArg(TExpressionList exprList)
```
  - getNamespace_String
```
public TExpression getNamespace_String()
```
  - getXPath_String
```
public TExpression getXPath_String()
```
  - getXMLType_Instance
```
public TExpression getXMLType_Instance()
```
  - getMatchColumns
```
public TObjectNameList getMatchColumns()
```
    column list in match function of MySQL
    
    Returns:
  - getAgainstExpr
```
public TExpression getAgainstExpr()
```
    against expr in match function of MySQL
```
     MATCH (col1,col2,...) AGAINST (expr [search_modifier])
 
```
    Returns:
    
    expression after against keyword
  - setMatchColumns
```
public void setMatchColumns(TObjectNameList matchColumns)
```
  - setAgainstExpr
```
public void setAgainstExpr(TExpression againstExpr)
```
    against expr in match function of MySQL
```
     MATCH (col1,col2,...) AGAINST (expr [search_modifier])
 
```
    Parameters:
    
    againstExpr - expression after against keyword
  - setTypename
```
public void setTypename(TTypeName typename)
```
  - getTypename
```
public TTypeName getTypename()
```
  - setParameter
```
public void setParameter(TExpression parameter)
```
  - setStyle
```
public void setStyle(TExpression style)
```
  - getParameter
```
public TExpression getParameter()
```
    parameter in function:convert(datetype,parameter,style)
    
    Returns:
  - getStyle
```
public TExpression getStyle()
```
    style in function:convert(datetype,parameter,style)
    
    Returns:
  - getFunctionType
```
public EFunctionType getFunctionType()
```
  - getRangeSize
```
public TExpression getRangeSize()
```
  - getBetweenExpr
```
public TExpression getBetweenExpr()
```
    get between start and end expression in Teradata range_n function.
    
    Returns:
    
    between start and end expression in Teradata range_n function
  - setRangeSize
```
public void setRangeSize(TExpression rangeSize)
```
  - setBetweenExpr
```
public void setBetweenExpr(TExpression betweenExpr)
```
    set between start and end expression in Teradata range_n function.
    
    Parameters:
    
    betweenExpr - between condition in range_n function
  - getFunctionName
```
public TObjectName getFunctionName()
```
  - setTrimArgument
```
public void setTrimArgument(TTrimArgument trimArgument)
```
  - getTrimArgument
```
public TTrimArgument getTrimArgument()
```
  - setExpr1
```
public void setExpr1(TExpression expr1)
```
  - setExpr2
```
public void setExpr2(TExpression expr2)
```
  - setAsDatatype
```
public void setAsDatatype(TTypeName asDatatype)
```
    datatype defined in Oracle function: XMLSERIALIZE(value_expr as datatype)
    
    Parameters:
    
    asDatatype - datatype defined in Oracle function: XMLSERIALIZE(value_expr as datatype)
  - setXMLForestValueList
```
public void setXMLForestValueList(TResultColumnList XMLForestValueList)
```
  - setXMLElementNameExpr
```
public void setXMLElementNameExpr(TExpression XMLElementNameExpr)
```
  - getXMLElementNameExpr
```
public TExpression getXMLElementNameExpr()
```
    XMLElement name/evalname expr
    
    Returns:
    
    XMLElement name/evalname expr
  - setXMLAttributesClause
```
public void setXMLAttributesClause(TXMLAttributesClause XMLAttributesClause)
```
  - setXMLElementValueExprList
```
public void setXMLElementValueExprList(TResultColumnList XMLElementValueExprList)
```
  - getXMLElementValueExprList
```
public TResultColumnList getXMLElementValueExprList()
```
    XMLElement ( value_expr [,XML_attribute_clause] [,value expr list] )
    
    Returns:
    
    XMLElement value expr list
  - getXMLAttributesClause
```
public TXMLAttributesClause getXMLAttributesClause()
```
    XMLAttribute clause in xmlelement function
    
    Returns:
    
    XMLAttribute clause in xmlelement function
  - getXMLForestValueList
```
public TResultColumnList getXMLForestValueList()
```
    XMLFOREST (value_expr [as aliasName], ... )
    
    Returns:
    
    XMLFOREST value list
  - getAsDatatype
```
public TTypeName getAsDatatype()
```
    get datatype defined in Oracle XMLSERIALIZE(value_expr as datatype)
    
    Returns:
    
    datatype defined in oracle XMLSERIALIZE function
  - getExpr1
```
public TExpression getExpr1()
```
    paramter of following functions
    teradata: position function,
    sql server: convert;
    oracle: convert,translate,cast,oracle XMLSERIALIZE(value_expr), oracle XMLROOT (value_expr)
    mysql: substring
    
    Returns:
  - getExpr2
```
public TExpression getExpr2()
```
  - setExpr3
```
public void setExpr3(TExpression expr3)
```
  - getExpr3
```
public TExpression getExpr3()
```
  - setExprList
```
public void setExprList(TExpressionList exprList)
```
  - getExprList
```
public TExpressionList getExprList()
```
    return TExpressionList instead of TGroupingExpressionItemList after v1.4.3.3
    
    Returns:
    
    expr list
  - setArgs
```
public void setArgs(TExpressionList args)
```
  - 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
  - setAnalyticFunction
```
public void setAnalyticFunction(TAnalyticFunction analyticFunction)
```
  - getArgs
```
public TExpressionList getArgs()
```
    get the list of parameters defined in this function
    
    Returns:
    
    the list of parameter
  - 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
  - getAnalyticFunction
```
public TAnalyticFunction getAnalyticFunction()
```
    Deprecated. As of v1.8.6.3, use getWindowDef() instead window clause in window function.
    
    Returns:
    
    a value of TAnalyticFunction
    
    See Also:
    
    TAnalyticFunction
  - 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
  - setFuncType
```
public void setFuncType(int funcType)
```
    Deprecated. As of v1.4.3.0
  - getFuncType
```
public int getFuncType()
```
    Deprecated. As of v1.4.3.0, replaced by getFunctionType().
  - setCheckedBuiltIn
```
public void setCheckedBuiltIn(boolean isCheckedBuiltIn)
```
  - setBuiltIn
```
public void setBuiltIn(boolean isBuiltIn)
```
  - setXMLType_Instance
```
public void setXMLType_Instance(TExpression XMLType_Instance)
```
  - setXPath_String
```
public void setXPath_String(TExpression XPath_String)
```
  - setNamespace_String
```
public void setNamespace_String(TExpression namespace_String)
```
  - setFunctionType
```
public void setFunctionType(EFunctionType functionType)
```
  - setFunctionName
```
public void setFunctionName(TObjectName functionName)
```
  - setTrim_Expr
```
public void setTrim_Expr(TExpression trim_Expr)
```
  - setTrim_From_Expr
```
public void setTrim_From_Expr(TExpression trim_From_Expr)
```

Class TFunctionCall

Field Summary

Constructor Summary

Method Summary

Methods inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

Methods inherited from class java.lang.Object

Field Detail

Trim_Expr

Trim_From_Expr

fntUdf

fntTrim

fntCast

fntConvert

fntExtract

fntTreat

fntContains

fntFreetext

fntCaseN

fntRangeN

fntPosition

fntSubstring

fntTranslate

fntTranslateCHK

fntCSUM

fntRank

fntXmlQuery

fntSubString

fntAddDate

fntDateAdd

fntSubDate

fntDateSub

fntTimestampAdd

fntTimestampDiff

fntGroupConcat

fntMatchAgainst

fntExtractXML

fntOGC

Constructor Detail

TFunctionCall

Method Detail

setIntervalUnit

getIntervalUnit

setStringExpr

getStringExpr

setSeparatorExpr

getSeparatorExpr

setSearchCondition

getSearchCondition

setColumnNameOrListExpression

getColumnNameOrListExpression

setStartExpression

setLengthExpression

getStartExpression

getLengthExpression

setSourceExpression

getSourceExpression

setTypeExpression

getTypeExpression

setCastOperand

getCastOperand

setDateExpression

getDateExpression

setCallTarget

getCallTarget

setGroupConcatParam

getGroupConcatParam

isBuiltIn

isBuiltIn

setPassingClause

getPassingClause

setAggregateType

getAggregateType

setOrderByList

getOrderByList

setSortClause

getSortClause

getWindowDef

setWindowDef

getWindowSpecification

setDatatypeAttribute