Package org.apache.cayenne.exp.parser

Class ASTCustomFunction

java.lang.Object

org.apache.cayenne.exp.Expression

org.apache.cayenne.exp.parser.SimpleNode

org.apache.cayenne.exp.parser.EvaluatedNode

org.apache.cayenne.exp.parser.ASTFunctionCall

org.apache.cayenne.exp.parser.ASTCustomFunction

All Implemented Interfaces:

Serializable, Node, XMLSerializable

public class ASTCustomFunction
extends ASTFunctionCall

Since:

4.2

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.cayenne.exp.parser.ASTFunctionCall

functionName

Fields inherited from class org.apache.cayenne.exp.parser.SimpleNode

children, id, parent

Fields inherited from class org.apache.cayenne.exp.Expression

ADD, AND, ASTERISK, BETWEEN, BITWISE_AND, BITWISE_LEFT_SHIFT, BITWISE_NOT, BITWISE_OR, BITWISE_RIGHT_SHIFT, BITWISE_XOR, CUSTOM_OP, DB_PATH, DBID_PATH, DIVIDE, ENCLOSING_OBJECT, EQUAL_TO, EXISTS, FALSE, FULL_OBJECT, FUNCTION_CALL, GREATER_THAN, GREATER_THAN_EQUAL_TO, IN, LESS_THAN, LESS_THAN_EQUAL_TO, LIKE, LIKE_IGNORE_CASE, LIST, MULTIPLY, NEGATIVE, NOT, NOT_BETWEEN, NOT_EQUAL_TO, NOT_EXISTS, NOT_IN, NOT_LIKE, NOT_LIKE_IGNORE_CASE, OBJ_PATH, OR, PRUNED_NODE, SUBQUERY, SUBTRACT, TRUE, type

Constructor Summary

Constructors

Constructor	Description
ASTCustomFunction(String name, Object... arguments)

Method Summary

Modifier and Type	Method	Description
void	appendAsString(Appendable out)	Appends own content as a String to the provided Appendable.
protected Object	evaluateSubNode(Object o, Object[] evaluatedChildren)
protected int	getRequiredChildrenCount()
void	jjtAddChild(Node n, int i)	This method tells the node to add its argument to the node's list of children.
protected void	setFunctionName(String functionName)
Expression	shallowCopy()	Creates a copy of this expression node, without copying children.

Methods inherited from class org.apache.cayenne.exp.parser.ASTFunctionCall

appendAsEJBQL, appendFunctionNameAsString, equals, getExpressionOperator, getFunctionName, getType, hashCode, nameToCamelCase, needParenthesis

Methods inherited from class org.apache.cayenne.exp.parser.EvaluatedNode

evaluateNode

Methods inherited from class org.apache.cayenne.exp.parser.SimpleNode

appendAsEJBQL, appendAsEscapedString, appendChildrenAsEJBQL, appendScalarAsString, connectChildren, encodeScalarAsEJBQL, evaluate, evaluateChild, expName, flattenTree, getEJBQLExpressionOperator, getOperand, getOperandCount, getPathAliases, jjtClose, jjtGetChild, jjtGetNumChildren, jjtGetParent, jjtOpen, jjtSetParent, notExp, pruneNodeForPrunedChild, setOperand, unwrapChild, wrapChild

Methods inherited from class org.apache.cayenne.exp.Expression

andExp, andExp, deepCopy, encodeAsXML, filter, filterObjects, first, joinExp, joinExp, match, orExp, orExp, params, params, paramsArray, setType, toEJBQL, toEJBQL, toString, transform, transformExpression, traverse, traverse

Methods inherited from class java.lang.Object

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

Constructor Detail

ASTCustomFunction

public ASTCustomFunction(String name,
                         Object... arguments)

Method Detail

evaluateSubNode

protected Object evaluateSubNode(Object o,
                                 Object[] evaluatedChildren)
                          throws Exception

Specified by:

evaluateSubNode in class EvaluatedNode

Throws:

Exception

getRequiredChildrenCount

protected int getRequiredChildrenCount()

Specified by:

getRequiredChildrenCount in class EvaluatedNode

shallowCopy

public Expression shallowCopy()

Description copied from class: Expression

Creates a copy of this expression node, without copying children.

Specified by:

shallowCopy in class Expression

setFunctionName

protected void setFunctionName(String functionName)

Overrides:

setFunctionName in class ASTFunctionCall

jjtAddChild

public void jjtAddChild(Node n,
                        int i)

Description copied from interface: Node

This method tells the node to add its argument to the node's list of children.

Specified by:

jjtAddChild in interface Node

Overrides:

jjtAddChild in class SimpleNode

appendAsString

public void appendAsString(Appendable out)
                    throws IOException

Description copied from class: Expression

Appends own content as a String to the provided Appendable.

Overrides:

appendAsString in class ASTFunctionCall

Throws:

IOException