Class ExtractExp

java.lang.Object

org.apache.cayenne.exp.Expression

org.apache.cayenne.exp.ValueExp

org.apache.cayenne.exp.FunctionCallExp

org.apache.cayenne.exp.ExtractExp

All Implemented Interfaces:

XMLSerializable

public final class ExtractExp
extends FunctionCallExp

Since:

5.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ExtractExp.DateTimePart	Available components of date/time.

Field Summary

Fields inherited from class Expression

operands, PRUNED_NODE

Constructor Summary

Constructors

Constructor	Description
ExtractExp(Object... operands)

Method Summary

Modifier and Type	Method	Description
protected void	appendFunctionNameAsString(Appendable out)
protected Object	evaluateSubNode(Object o, Object[] evaluatedChildren)
String	getFunctionName()
ExtractExp.DateTimePart	getPart()
String	getPartCamelCaseName()
protected int	getRequiredChildrenCount()
void	setPart(ExtractExp.DateTimePart part)	This method is used by FunctionExpressionFactory
void	setPartToken(String partToken)	This method is used by invalid reference QLParser
Expression	shallowCopy()	Creates a copy of this expression node, without copying children.

Methods inherited from class FunctionCallExp

appendAsString, equals, getExpressionOperator, hashCode, nameToCamelCase, needParenthesis, parenthesizeAsOperand

Methods inherited from class ValueExp

evaluateNode

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, toString, transform, transformExpression, traverse, traverse

Methods inherited from class Object

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

Constructor Details

ExtractExp

public ExtractExp(Object... operands)

Method Details

getFunctionName

public String getFunctionName()

Specified by:

getFunctionName in class FunctionCallExp

appendFunctionNameAsString

protected void appendFunctionNameAsString(Appendable out)
                                   throws IOException

Overrides:

appendFunctionNameAsString in class FunctionCallExp

Throws:

IOException

setPartToken

public void setPartToken(String partToken)

This method is used by

invalid reference

QLParser

Parameters:

partToken -

invalid reference

Token#image

from

invalid reference

QLParser

setPart

public void setPart(ExtractExp.DateTimePart part)

This method is used by FunctionExpressionFactory

Parameters:

part - date/time part to extract

getPart

public ExtractExp.DateTimePart getPart()

getPartCamelCaseName

public String getPartCamelCaseName()

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

getRequiredChildrenCount

protected int getRequiredChildrenCount()

Specified by:

getRequiredChildrenCount in class ValueExp

evaluateSubNode

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

Specified by:

evaluateSubNode in class ValueExp

Throws:

Exception