org.kuali.rice.core.api.criteria
Class LookupCustomizer<T>

java.lang.Object
  org.kuali.rice.core.api.criteria.LookupCustomizer<T>

public class LookupCustomizer<T>
extends Object

This class works withe the lookup framework to customize a query. It currently can do the following things:

• transform/remove predicates
• transform/remove query results

The predicate transform will applied to the predicates in the incoming query yielding a a predicate. If the predicate does not need to be transformed then the function can return the incoming argument. If the predicate should be removed the transform should return null. This is a way to remove or change a predicate before the query is executed. This is a good way to add new predicates to a query or to limit the result of the query before it is executed. Transforms also allow a predicate referencing a property path that does not exist on database mapped object to be changed to something that is valid.

The result transform will be applied to the results of the query after the query is executed. If the result does not need to be transformed then the function can return the incoming argument. This is a way to remove or change a result after the query is executed.

transformers should not have to deal with null items

Nested Class Summary

static class	LookupCustomizer.Builder<T>
static interface	LookupCustomizer.Transform<P,R>

Method Summary

LookupCustomizer.Transform<Predicate,Predicate>	getPredicateTransform()
LookupCustomizer.Transform<T,T>	getResultTransform()

Methods inherited from class java.lang.Object

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

Method Detail

getPredicateTransform

public LookupCustomizer.Transform<Predicate,Predicate> getPredicateTransform()

getResultTransform

public LookupCustomizer.Transform<T,T> getResultTransform()