| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface FilterListener
A filter listener extends expression filters with custom functionality.
| Method Summary | |
|---|---|
|  Object | evaluate(Object target,
         Class targetClass,
         Object[] args,
         Class[] argClasses,
         Object candidate,
         StoreContext ctx)Evaluate the given expression. | 
|  boolean | expectsArguments()Return true if this extension expects arguments to act on. | 
|  boolean | expectsTarget()Return true if this extension expects a target to act on. | 
|  String | getTag()Return the tag that this extension listens for. | 
|  Class | getType(Class targetClass,
        Class[] argClasses)Return the expected type of the result of this listener. | 
| Method Detail | 
|---|
String getTag()
boolean expectsArguments()
field.ext:toUpperCase ().
boolean expectsTarget()
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.
Object evaluate(Object target,
                Class targetClass,
                Object[] args,
                Class[] argClasses,
                Object candidate,
                StoreContext ctx)
target - the target object / field value to act on; will be
 null if this extension does not expect a targettargetClass - the expected class of the target; given in case
 the target evaluates to null and typing is neededargs - the values of the arguments given in the filter;
 will be null if this extension does not expect an argumentargClasses - the expected classes of the arguments; given in case
 an argument evaluates to null and typing is neededcandidate - the candidate object being evaluatedctx - the persistence context
Boolean.TRUE or Boolean.FALSE
UserException - if this extension does not 
 support in-memory operation
Class getType(Class targetClass,
              Class[] argClasses)
targetClass - the expected class of the target, or null if no targetargClasses - the expected classes of the arguments, or null if
 no arguments| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||