Class FunctionCallExp

java.lang.Object

org.apache.cayenne.exp.Expression

org.apache.cayenne.exp.ValueExp

org.apache.cayenne.exp.FunctionCallExp

All Implemented Interfaces:

XMLSerializable

Direct Known Subclasses:

AbsExp, AggregateFunctionCallExp, ConcatExp, CurrentDateExp, CurrentTimeExp, CurrentTimestampExp, CustomFunctionExp, ExtractExp, LengthExp, LocateExp, LowerExp, ModExp, SqrtExp, SubstringExp, TrimExp, UpperExp

public abstract sealed class FunctionCallExp
extends ValueExp
permits AbsExp, AggregateFunctionCallExp, ConcatExp, CurrentDateExp, CurrentTimeExp, CurrentTimestampExp, CustomFunctionExp, ExtractExp, LengthExp, LocateExp, LowerExp, ModExp, SqrtExp, SubstringExp, TrimExp, UpperExp

Since:

5.0

Field Summary

Fields inherited from class Expression

operands, PRUNED_NODE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FunctionCallExp(Object... operands)

Method Summary

Modifier and Type	Method	Description
void	appendAsString(Appendable out)	Appends own content as a String to the provided Appendable: the operands separated by the operator.
protected void	appendFunctionNameAsString(Appendable out)
boolean	equals(Object o)
protected String	getExpressionOperator(int index)	Returns the operator printed between the operands, before the operand at the given index.
abstract String	getFunctionName()
int	hashCode()
protected static String	nameToCamelCase(String functionName)
boolean	needParenthesis()
protected boolean	parenthesizeAsOperand()	Whether this node is wrapped in parentheses when printed as an operand of another node.

Methods inherited from class ValueExp

evaluateNode, evaluateSubNode, getRequiredChildrenCount

Methods inherited from class Expression

andExp, andExp, appendOperandAsString, deepCopy, encodeAsXML, evaluate, evaluateOperand, exists, expName, filter, filterObjects, first, flattenTree, getOperand, getOperandCount, getPathAliases, isValidParent, match, notExists, notExp, orExp, orExp, params, params, paramsArray, pruneNodeForPrunedChild, setOperand, setOperands, shallowCopy, toString, transform, transformExpression, traverse, traverse

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

FunctionCallExp

protected FunctionCallExp(Object... operands)

Method Details

needParenthesis

public boolean needParenthesis()

getFunctionName

public abstract String getFunctionName()

getExpressionOperator

protected String getExpressionOperator(int index)

Description copied from class: Expression

Returns the operator printed between the operands, before the operand at the given index.

Specified by:

getExpressionOperator in class Expression

equals

public boolean equals(Object o)

Overrides:

equals in class Expression

hashCode

public int hashCode()

Overrides:

hashCode in class Expression

appendFunctionNameAsString

protected void appendFunctionNameAsString(Appendable out)
                                   throws IOException

Throws:

IOException

appendAsString

public void appendAsString(Appendable out)
                    throws IOException

Description copied from class: Expression

Appends own content as a String to the provided Appendable: the operands separated by the operator.

Overrides:

appendAsString in class Expression

Throws:

IOException

parenthesizeAsOperand

protected boolean parenthesizeAsOperand()

Description copied from class: Expression

Whether this node is wrapped in parentheses when printed as an operand of another node. Compound nodes are, leaves and nodes with their own delimiters (function calls, lists) are not.

Overrides:

parenthesizeAsOperand in class Expression

nameToCamelCase

protected static String nameToCamelCase(String functionName)

Parameters:

functionName - in UPPER_UNDERSCORE convention

Returns:

functionName in camelCase convention