openconnector

Class Filter

java.lang.Object

openconnector.Filter

public class Filter
extends java.lang.Object

A Filter is a representation of criteria that can be used to search for objects. This model is intentionally simplified and does not support more sophisticated searches such as nested composites (for example - (a && b) || (c && d)). Typical usage involves creating a filter (either an AND or OR) and adding criteria to it. This filter model can later be turned into filters that can be used on resources (for example - an LDAP search string or JDBC where clause) or used to programmatically match objects. For example, to search for administrative users, you might use the following code.

  Filter f = new Filter(Conjunct.OR);
  f.add("username", Operator.EQ, "root");
  f.add("username", Operator.STARTS_WITH, "adm_");
  f.add("username", Operator.EQ, "adm_notReallyAnAdmin", true);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Filter.Conjunct An enumeration of conjunctions for a composite filter.
static class	Filter.Operator An enumeration of operators for filter criteria.

Constructor Summary

Constructors

Constructor and Description
Filter() Constructor for an AND filter.
Filter(Filter.Conjunct conjunct) Constructor.

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String property, Filter.Operator op, java.lang.Object value) Add the given criteria to this filter.
void	add(java.lang.String property, Filter.Operator op, java.lang.Object value, boolean negate) Add the given criteria to this filter.
Filter.Conjunct	getConjunct()
java.util.List<Filter>	getFilters()
Filter.Operator	getOp()
java.lang.String	getProperty()
java.lang.Object	getValue()
boolean	isNegate()

Methods inherited from class java.lang.Object

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

Constructor Detail

Filter

public Filter()

Constructor for an AND filter.

Filter

public Filter(Filter.Conjunct conjunct)

Constructor.

Parameters:

conjunct - The Conjunct to use for this filter.

Method Detail

add

public void add(java.lang.String property,
                Filter.Operator op,
                java.lang.Object value)

Add the given criteria to this filter.

add

public void add(java.lang.String property,
                Filter.Operator op,
                java.lang.Object value,
                boolean negate)

Add the given criteria to this filter.

getFilters

public java.util.List<Filter> getFilters()

Returns:

the filters that represent the criteria that was added using the add methods. These will have a property, operate, value, and negate, but not a conjunct or sub-filters.

getConjunct

public Filter.Conjunct getConjunct()

Returns:

the conjunct for this filter.

getProperty

public java.lang.String getProperty()

Returns:

the property this filter is comparing against. This will return null unless called on a filter returned by getFilters().

getOp

public Filter.Operator getOp()

Returns:

the operator this filter is using. This will return null unless called on a filter returned by getFilters().

getValue

public java.lang.Object getValue()

Returns:

the value this filter is comparing the specified property against. This will return null unless called on a filter returned by getFilters().

isNegate

public boolean isNegate()

Returns:

whether the operator is negated for this filter. This will always return false unless called on a filter returned by getFilters().