Class PatternMatchExp

java.lang.Object

org.apache.cayenne.exp.Expression

org.apache.cayenne.exp.ConditionExp

org.apache.cayenne.exp.PatternMatchExp

All Implemented Interfaces:

XMLSerializable

Direct Known Subclasses:

LikeExp, LikeIgnoreCaseExp, NotLikeExp, NotLikeIgnoreCaseExp

public abstract sealed class PatternMatchExp
extends ConditionExp
permits LikeExp, NotLikeExp (not exhaustive)

Superclass of pattern matching nodes. Assumes that subclass is a binary expression with the second operand being a pattern.

Since:

5.0

Field Summary

Fields

Modifier and Type	Field	Description
protected char	escapeChar
protected Pattern	pattern
protected boolean	patternCompiled

Fields inherited from class Expression

operands, PRUNED_NODE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PatternMatchExp(Object... operands)	This method will return an escape character for the like clause.

Method Summary

Modifier and Type	Method	Description
char	getEscapeChar()
protected Pattern	getPattern()
abstract boolean	isIgnoringCase()
protected boolean	matchPattern(String string)
void	setEscapeChar(char value)	This method allows the setting of the escape character.
void	setOperand(int index, Object value)	Sets a value of operand at index, growing the operands array if needed.

Methods inherited from class ConditionExp

evaluateNode, evaluateSubNode, exists, getRequiredChildrenCount, isValidParent, notExists

Methods inherited from class Expression

andExp, andExp, appendAsString, appendOperandAsString, deepCopy, encodeAsXML, equals, evaluate, evaluateOperand, expName, filter, filterObjects, first, flattenTree, getExpressionOperator, getOperand, getOperandCount, getPathAliases, hashCode, match, notExp, orExp, orExp, params, params, paramsArray, parenthesizeAsOperand, pruneNodeForPrunedChild, setOperands, shallowCopy, toString, transform, transformExpression, traverse, traverse

Methods inherited from class Object

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

Field Details

pattern

protected Pattern pattern

patternCompiled

protected boolean patternCompiled

escapeChar

protected char escapeChar

Constructor Details

PatternMatchExp

protected PatternMatchExp(Object... operands)

This method will return an escape character for the like clause. The escape character will eventually end up in the query as ...(t0.foo LIKE ? {escape '|'}) where the pipe symbol is the escape character.

Note that having no escape character is represented as the character 0.

Method Details

getEscapeChar

public char getEscapeChar()

setEscapeChar

public void setEscapeChar(char value)

This method allows the setting of the escape character. The escape character can be used in a LIKE clause. The character 0 signifies no escape character. The escape character '?' is disallowed.

isIgnoringCase

public abstract boolean isIgnoringCase()

matchPattern

protected boolean matchPattern(String string)

getPattern

protected Pattern getPattern()

setOperand

public void setOperand(int index,
 Object value)

Description copied from class: Expression

Sets a value of operand at index, growing the operands array if needed. Operand indexing starts at 0. A Persistent is replaced with its ObjectId. A nested expression is asked first whether this node is a valid parent for it, see Expression.isValidParent(Expression).

Overrides:

setOperand in class Expression