com.solarmetric.rd.kodo.query.listen
Class StringContains

java.lang.Object
  |
  +--com.solarmetric.rd.kodo.query.listen.StringContains

All Implemented Interfaces:

FilterListener

Direct Known Subclasses:

JDBCStringContains

public class StringContains

extends java.lang.Object

implements FilterListener

Tests if the target contains the given argument. The argument must be a constant.

Examples:
"address.street.ext:stringContains (\"main\")"

Field Summary

static java.lang.String

TAG

Constructor Summary

StringContains()

Method Summary

java.lang.Object	evaluate(java.lang.Object target, java.lang.Object arg, java.lang.Object candidate, com.solarmetric.rd.kodo.runtime.PersistenceManagerImpl pm) Evaluate the given expression.
boolean	expectsArgument() Return true if this extension expects an argument to act on.
boolean	expectsTarget() Return true if this extension expects a target to act on.
java.lang.String	getTag() Return the tag that this extension listens for.
boolean	isExpression() Return true if this extension is an expression; i.e.

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

Constructor Detail

StringContains

public StringContains()

Method Detail

getTag

public java.lang.String getTag()

Description copied from interface: FilterListener

Return the tag that this extension listens for.

Specified by:

getTag in interface FilterListener

expectsArgument

public boolean expectsArgument()

Description copied from interface: FilterListener

Return true if this extension expects an argument to act on. Some extensions may not need arguments; for example, an extension to switch a string to upper case might be of the form: field.ext:toUpperCase ().

Specified by:

expectsArgument in interface FilterListener

expectsTarget

public boolean expectsTarget()

Description copied from interface: FilterListener

Return true if this extension expects a target to act on. Some extensions act on a field or object value; others stand alone. field.ext:toUpperCase () acts on the target field but has no arguments, while another possible form, ext:toUpperCase (field) has no target but does have an argument.

Specified by:

expectsTarget in interface FilterListener

isExpression

public boolean isExpression()

Description copied from interface: FilterListener

Return true if this extension is an expression; i.e. if it evaluates to true or false on its own.

Specified by:

isExpression in interface FilterListener

evaluate

public java.lang.Object evaluate(java.lang.Object target,
                                 java.lang.Object arg,
                                 java.lang.Object candidate,
                                 com.solarmetric.rd.kodo.runtime.PersistenceManagerImpl pm)

Description copied from interface: FilterListener

Evaluate the given expression. This method is used when evaluating in-memory expressions. The method used when evaluating data store expressions will change depending on the data store in use.

Specified by:

evaluate in interface FilterListener

Parameters:

target - the target object / field value to act on; will be null if this extension does not expect a target

arg - the value of the argument given in the filter; will be null if this extension does not expect an argument

candidate - the candidate object being evaluated

pm - a persistence manager to use if needed

Returns:

the value of the extension for this candidate; if this extension is an expression, this method should return Boolean.TRUE or Boolean.FALSE