com.strategicgains.restexpress.common.query

Class QueryFilter

java.lang.Object

com.strategicgains.restexpress.common.query.QueryFilter

public class QueryFilter
extends Object

Supports the concept of filtering a result based on the 'filter' query parameter. a list of field name/value pairs separated by a vertical bar ('|') and the field name separated from the value with two colons ('::').

To filter on name: ?filter=name::todd

To filter on name and description: ?filter=name::todd|description::amazing

Since:

Apr 12, 2011

Author:

toddf

Constructor Summary

Constructors

Constructor and Description
QueryFilter()
QueryFilter(Map<String,String> filters) Create a QueryFilter instance from a Map of name/value pairs.

Method Summary

Methods

Modifier and Type	Method and Description
QueryFilter	addCriteria(String name, String value) Add a filter criteria to this QueryFilter instance.
boolean	hasFilters() Returns true if this QueryFilter instance would affect the query (has effective filters).
void	iterate(FilterCallback callback) Iterate the filter criteria within this QueryFilter, invoking the FilterCallback to presumably construct a query.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryFilter

public QueryFilter()

QueryFilter

public QueryFilter(Map<String,String> filters)

Create a QueryFilter instance from a Map of name/value pairs.

Parameters:

filters - name/value pairs to match on.

Method Detail

addCriteria

public QueryFilter addCriteria(String name,
                      String value)

Add a filter criteria to this QueryFilter instance.

Parameters:

name - the property name to filter on. Cannot be null.

value - the value to match. Cannot be null.

Returns:

a reference to this QueryFilter to facilitate method chaining.

hasFilters

public boolean hasFilters()

Returns true if this QueryFilter instance would affect the query (has effective filters).

Returns:

true if filters exist within this QueryFilter instance

iterate

public void iterate(FilterCallback callback)

Iterate the filter criteria within this QueryFilter, invoking the FilterCallback to presumably construct a query.

Parameters:

callback - a FilterCallback instance