Module net.sf.jsqlparser

Package net.sf.jsqlparser.expression

Class Function

java.lang.Object

net.sf.jsqlparser.parser.ASTNodeAccessImpl

net.sf.jsqlparser.expression.Function

All Implemented Interfaces:

Serializable, Expression, Model, net.sf.jsqlparser.parser.ASTNodeAccess

Direct Known Subclasses:

TableFunction

public class Function
extends net.sf.jsqlparser.parser.ASTNodeAccessImpl
implements Expression

A function as MAX,COUNT...

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Function.HavingClause
static class	Function.NullHandling

Constructor Summary

Constructors

Constructor	Description
Function()
Function(String name, Expression... parameters)

Method Summary

Modifier and Type	Method	Description
<T,S> T	accept(ExpressionVisitor<T> expressionVisitor, S context)
Object	getAttribute()
<E extends Expression> E	getAttribute(Class<E> type)
Column	getAttributeColumn()
String	getAttributeName()	Deprecated.
Function.HavingClause	getHavingClause()
KeepExpression	getKeep()
Limit	getLimit()
List<String>	getMultipartName()
String	getName()
NamedExpressionList<?>	getNamedParameters()	the parameters might be named parameters, e.g. substring('foobar' from 2 for 3)
Function.NullHandling	getNullHandling()
List<OrderByElement>	getOrderByElements()
ExpressionList<?>	getParameters()	The list of parameters of the function (if any, else null) If the parameter is "*", allColumns is set to true
boolean	isAllColumns()
boolean	isDistinct()	true if the function is "distinct"
boolean	isEscaped()	Return true if it's in the form "{fn function_body() }"
boolean	isIgnoreNulls()
boolean	isIgnoreNullsOutside()
boolean	isUnique()	true if the function is "unique"
void	setAllColumns(boolean b)
void	setAttribute(Expression attributeExpression)
void	setAttribute(Column attributeColumn)
void	setAttributeName(String attributeName)
void	setDistinct(boolean b)
void	setEscaped(boolean isEscaped)
Function	setHavingClause(String havingType, Expression expression)
Function	setHavingClause(Function.HavingClause havingClause)
void	setIgnoreNulls(boolean ignoreNulls)	This is at the moment only necessary for AnalyticExpression initialization and not for normal functions.
Function	setIgnoreNullsOutside(boolean ignoreNullsOutside)
void	setKeep(KeepExpression keep)
Function	setLimit(Limit limit)
void	setName(String string)
void	setName(List<String> string)
void	setNamedParameters(NamedExpressionList<?> list)
Function	setNullHandling(Function.NullHandling nullHandling)
void	setOrderByElements(List<OrderByElement> orderByElements)
void	setParameters(Expression... expressions)
void	setParameters(ExpressionList<?> list)
void	setUnique(boolean b)
String	toString()
Function	withAllColumns(boolean allColumns)
Function	withAttribute(Expression attribute)
Function	withAttribute(Column attributeColumn)
Function	withAttributeName(String attributeName)	Deprecated.
Function	withDistinct(boolean distinct)
Function	withIgnoreNulls(boolean ignoreNulls)
Function	withKeep(KeepExpression keep)
Function	withName(String name)
Function	withName(List<String> nameparts)
Function	withNamedParameters(NamedExpressionList<?> namedParameters)
Function	withParameters(Expression... parameters)
Function	withParameters(ExpressionList<?> parameters)
Function	withUnique(boolean unique)

Methods inherited from class net.sf.jsqlparser.parser.ASTNodeAccessImpl

appendTo, getASTNode, getParent, getParent, setASTNode

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.jsqlparser.parser.ASTNodeAccess

getASTNode, setASTNode

Methods inherited from interface net.sf.jsqlparser.expression.Expression

accept

Constructor Detail

Function

public Function()

Function

public Function(String name,
                Expression... parameters)

Method Detail

accept

public <T,S> T accept(ExpressionVisitor<T> expressionVisitor,
                            S context)

Specified by:

accept in interface Expression

getName

public String getName()

setName

public void setName(String string)

setName

public void setName(List<String> string)

getMultipartName

public List<String> getMultipartName()

withName

public Function withName(String name)

withName

public Function withName(List<String> nameparts)

isAllColumns

public boolean isAllColumns()

setAllColumns

public void setAllColumns(boolean b)

getNullHandling

public Function.NullHandling getNullHandling()

setNullHandling

public Function setNullHandling(Function.NullHandling nullHandling)

isIgnoreNullsOutside

public boolean isIgnoreNullsOutside()

setIgnoreNullsOutside

public Function setIgnoreNullsOutside(boolean ignoreNullsOutside)

getLimit

public Limit getLimit()

setLimit

public Function setLimit(Limit limit)

isIgnoreNulls

public boolean isIgnoreNulls()

setIgnoreNulls

public void setIgnoreNulls(boolean ignoreNulls)

This is at the moment only necessary for AnalyticExpression initialization and not for normal functions. Therefore there is no deparsing for it for normal functions.

getHavingClause

public Function.HavingClause getHavingClause()

setHavingClause

public Function setHavingClause(Function.HavingClause havingClause)

setHavingClause

public Function setHavingClause(String havingType,
                                Expression expression)

isDistinct

public boolean isDistinct()

true if the function is "distinct"

Returns:

true if the function is "distinct"

setDistinct

public void setDistinct(boolean b)

isUnique

public boolean isUnique()

true if the function is "unique"

Returns:

true if the function is "unique"

setUnique

public void setUnique(boolean b)

getParameters

public ExpressionList<?> getParameters()

The list of parameters of the function (if any, else null) If the parameter is "*", allColumns is set to true

Returns:

the list of parameters of the function (if any, else null)

setParameters

public void setParameters(Expression... expressions)

setParameters

public void setParameters(ExpressionList<?> list)

getNamedParameters

public NamedExpressionList<?> getNamedParameters()

the parameters might be named parameters, e.g. substring('foobar' from 2 for 3)

Returns:

the list of named parameters of the function (if any, else null)

setNamedParameters

public void setNamedParameters(NamedExpressionList<?> list)

isEscaped

public boolean isEscaped()

Return true if it's in the form "{fn function_body() }"

Returns:

true if it's java-escaped

setEscaped

public void setEscaped(boolean isEscaped)

getAttribute

public Object getAttribute()

setAttribute

public void setAttribute(Expression attributeExpression)

setAttribute

public void setAttribute(Column attributeColumn)

getAttributeName

@Deprecated
public String getAttributeName()

Deprecated.

setAttributeName

public void setAttributeName(String attributeName)

getAttributeColumn

public Column getAttributeColumn()

withAttribute

public Function withAttribute(Column attributeColumn)

getKeep

public KeepExpression getKeep()

setKeep

public void setKeep(KeepExpression keep)

toString

public String toString()

Overrides:

toString in class Object

withAttribute

public Function withAttribute(Expression attribute)

withAttributeName

@Deprecated
public Function withAttributeName(String attributeName)

Deprecated.

withKeep

public Function withKeep(KeepExpression keep)

withIgnoreNulls

public Function withIgnoreNulls(boolean ignoreNulls)

withParameters

public Function withParameters(ExpressionList<?> parameters)

withParameters

public Function withParameters(Expression... parameters)

withNamedParameters

public Function withNamedParameters(NamedExpressionList<?> namedParameters)

withAllColumns

public Function withAllColumns(boolean allColumns)

withDistinct

public Function withDistinct(boolean distinct)

withUnique

public Function withUnique(boolean unique)

getOrderByElements

public List<OrderByElement> getOrderByElements()

setOrderByElements

public void setOrderByElements(List<OrderByElement> orderByElements)

getAttribute

public <E extends Expression> E getAttribute(Class<E> type)