com.vaadin.addon.jpacontainer.util
Class DefaultQueryModifierDelegate

java.lang.Object
  com.vaadin.addon.jpacontainer.util.DefaultQueryModifierDelegate

All Implemented Interfaces:

QueryModifierDelegate, Serializable

public class DefaultQueryModifierDelegate
extends Object
implements QueryModifierDelegate

A default (empty) implementation of the QueryModifierDelegate interface. This is provided for the convenience of the developer who needs to implement only a specific delegate method.

Since:

2.0

See Also:

Serialized Form

Constructor Summary

DefaultQueryModifierDelegate()

Method Summary

void	filtersWereAdded(javax.persistence.criteria.CriteriaBuilder criteriaBuilder, javax.persistence.criteria.CriteriaQuery<?> query) This method is called after all filters have been applied to the query.
void	filtersWillBeAdded(javax.persistence.criteria.CriteriaBuilder criteriaBuilder, javax.persistence.criteria.CriteriaQuery<?> query, List<javax.persistence.criteria.Predicate> predicates) This method is called after filters (in the form of Container.Filter) have been translated into instances of Predicate, but before the resulting predicates have been added to query.
void	orderByWasAdded(javax.persistence.criteria.CriteriaBuilder criteriaBuilder, javax.persistence.criteria.CriteriaQuery<?> query) This method is called after the order by has been applied for the query.
void	orderByWillBeAdded(javax.persistence.criteria.CriteriaBuilder criteriaBuilder, javax.persistence.criteria.CriteriaQuery<?> query, List<javax.persistence.criteria.Order> orderBy) This method is called after all SortBy instances have been translated into Order instances, but before they have been applied to the query.
void	queryHasBeenBuilt(javax.persistence.criteria.CriteriaBuilder criteriaBuilder, javax.persistence.criteria.CriteriaQuery<?> query) This method is called after the CriteriaQuery instance has been completely built (configured).
void	queryWillBeBuilt(javax.persistence.criteria.CriteriaBuilder criteriaBuilder, javax.persistence.criteria.CriteriaQuery<?> query) This method is called after the CriteriaQuery instance ( query) has been instantiated, but before any state has been set.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultQueryModifierDelegate

public DefaultQueryModifierDelegate()

Method Detail

queryWillBeBuilt

public void queryWillBeBuilt(javax.persistence.criteria.CriteriaBuilder criteriaBuilder,
                             javax.persistence.criteria.CriteriaQuery<?> query)

This method is called after the CriteriaQuery instance ( query) has been instantiated, but before any state has been set. Operations and configuration may be performed on the query instance. This default implementation does nothing.

Specified by:

queryWillBeBuilt in interface QueryModifierDelegate

Parameters:

criteriaBuilder - the CriteriaBuilder used to build the query

query - the CriteriaQuery being built

queryHasBeenBuilt

public void queryHasBeenBuilt(javax.persistence.criteria.CriteriaBuilder criteriaBuilder,
                              javax.persistence.criteria.CriteriaQuery<?> query)

This method is called after the CriteriaQuery instance has been completely built (configured). Any operations may be performed on the query instance. This default implementation does nothing.

Specified by:

queryHasBeenBuilt in interface QueryModifierDelegate

Parameters:

criteriaBuilder - the CriteriaBuilder used to build the query

query - the CriteriaQuery being built

filtersWillBeAdded

public void filtersWillBeAdded(javax.persistence.criteria.CriteriaBuilder criteriaBuilder,
                               javax.persistence.criteria.CriteriaQuery<?> query,
                               List<javax.persistence.criteria.Predicate> predicates)

This method is called after filters (in the form of Container.Filter) have been translated into instances of Predicate, but before the resulting predicates have been added to query. The contents of the predicates list may be modified at this point. Any operations may be performed on the query instance. This default implementation does nothing.

Specified by:

filtersWillBeAdded in interface QueryModifierDelegate

Parameters:

criteriaBuilder - the CriteriaBuilder used to build the query

query - the CriteriaQuery being built

predicates - the list of predicates (Predicate) to be applied. The contents of this list may be modified.

filtersWereAdded

public void filtersWereAdded(javax.persistence.criteria.CriteriaBuilder criteriaBuilder,
                             javax.persistence.criteria.CriteriaQuery<?> query)

This method is called after all filters have been applied to the query. Any operations may be performed on the query instance. This default implementation does nothing.

Specified by:

filtersWereAdded in interface QueryModifierDelegate

Parameters:

criteriaBuilder - the CriteriaBuilder used to build the query

query - the CriteriaQuery being built

orderByWillBeAdded

public void orderByWillBeAdded(javax.persistence.criteria.CriteriaBuilder criteriaBuilder,
                               javax.persistence.criteria.CriteriaQuery<?> query,
                               List<javax.persistence.criteria.Order> orderBy)

This method is called after all SortBy instances have been translated into Order instances, but before they have been applied to the query. The contents of the orderBy list may be modified at this point. Any operations may be performed on the query instance. This default implementation does nothing.

Specified by:

orderByWillBeAdded in interface QueryModifierDelegate

Parameters:

criteriaBuilder - the CriteriaBuilder used to build the query

query - the CriteriaQuery being built

orderBy - the list of order by rules (Order) to be applied. The contents of this list may be modified.

orderByWasAdded

public void orderByWasAdded(javax.persistence.criteria.CriteriaBuilder criteriaBuilder,
                            javax.persistence.criteria.CriteriaQuery<?> query)

This method is called after the order by has been applied for the query. Any operations may be performed on the query instance. This default implementation does nothing.

Specified by:

orderByWasAdded in interface QueryModifierDelegate

Parameters:

criteriaBuilder - the CriteriaBuilder used to build the query

query - the CriteriaQuery being built