Package net.solarnetwork.util

Class SearchFilter

java.lang.Object

net.solarnetwork.util.SearchFilter

public class SearchFilter
extends Object

Generic search filter supporting LDAP-style search queries.

This filter supports a group of key-value pairs joined by a common logical operator. The key-value pairs are provided by a Map. Nested SearchFilter instances can be used as values so that complex logic can be implemented.

Version:

2.0

Author:

matt

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SearchFilter.CompareOperator	A comparison operator for a single filter.
static enum	SearchFilter.LogicOperator	A filter logic qualifier for multiple filters.
static interface	SearchFilter.VisitorCallback	API for visiting all filters as a tree.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String,?>	filter

Constructor Summary

Constructors

Constructor	Description
SearchFilter(String key, Object value, SearchFilter.CompareOperator compareOp)	Construct with a single key-value pair.
SearchFilter(Map<String,?> filter)	Construct with a filter.
SearchFilter(Map<String,?> filter, SearchFilter.CompareOperator compareOp, SearchFilter.LogicOperator logicOp)	Construct with values.
SearchFilter(Map<String,?> filter, SearchFilter.LogicOperator logicOp)	Construct with a filter and logic operator and SearchFilter.CompareOperator.EQUAL comparison operator.

Method Summary

Modifier and Type	Method	Description
void	appendLDAPSearchFilter(StringBuilder buf)	Appends this filter as a LDAP query string to a StringBuilder.
String	asLDAPSearchFilterString()	Return an LDAP search filter string.
static SearchFilter	forLDAPSearchFilterString(String s)	Parse a LDAP search filter into a SearchFilter instance.
SearchFilter.CompareOperator	getCompareOperator()	Get the comparison operator.
Map<String,?>	getFilter()	Get the filter values.
SearchFilter.LogicOperator	getLogicOperator()	Get the logic operator.
boolean	hasNestedFilter()	Test if this filter has any nested filters.
String	toString()	Return an LDAP search filter string.
void	walk(SearchFilter.VisitorCallback callback)	Walk the filter as a tree.

Methods inherited from class java.lang.Object

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

Field Details

filter

protected final Map<String,?> filter

Constructor Details

SearchFilter

public SearchFilter(Map<String,?> filter)

Construct with a filter. Uses SearchFilter.CompareOperator.EQUAL and SearchFilter.LogicOperator.AND.

Parameters:

filter - the filter value

SearchFilter

public SearchFilter(Map<String,?> filter,
 SearchFilter.CompareOperator compareOp,
 SearchFilter.LogicOperator logicOp)

Construct with values.

Parameters:

filter - the filter value

compareOp - the comparison operator

logicOp - the logical operator

SearchFilter

public SearchFilter(String key,
 Object value,
 SearchFilter.CompareOperator compareOp)

Construct with a single key-value pair.

Parameters:

key - the key

value - the value

compareOp - the comparison operator

SearchFilter

public SearchFilter(Map<String,?> filter,
 SearchFilter.LogicOperator logicOp)

Construct with a filter and logic operator and SearchFilter.CompareOperator.EQUAL comparison operator.

Parameters:

filter - the filter

logicOp - the logic operator

Method Details

appendLDAPSearchFilter

public void appendLDAPSearchFilter(StringBuilder buf)

Appends this filter as a LDAP query string to a StringBuilder. If any value in the filter is itself a SearchFilter, the associated key is ignored and the SearchFilter is itself appended to the buffer. If the filter has only one key-value pair, the logicOp is ignored and not appended to the buffer. If the filter has more than one key-value pair and the logicOp is SearchFilter.LogicOperator.NOT, the filter will automatically be written as NOT(AND((x)(y))).

Parameters:

buf - the buffer to append to

asLDAPSearchFilterString

public String asLDAPSearchFilterString()

Return an LDAP search filter string.

Returns:

String

See Also:

• appendLDAPSearchFilter(StringBuilder)

toString

public String toString()

Return an LDAP search filter string. This simply calls asLDAPSearchFilterString().

Overrides:

toString in class Object

Returns:

String

getCompareOperator

public SearchFilter.CompareOperator getCompareOperator()

Get the comparison operator.

Returns:

the comparison

getLogicOperator

public SearchFilter.LogicOperator getLogicOperator()

Get the logic operator.

Returns:

the logic

getFilter

public Map<String,?> getFilter()

Get the filter values.

Returns:

the filter

hasNestedFilter

public boolean hasNestedFilter()

Test if this filter has any nested filters.

Returns:

true if any nested filters exist within this filter

Since:

1.1

walk

public void walk(SearchFilter.VisitorCallback callback)

Walk the filter as a tree.

Parameters:

callback - the callback

forLDAPSearchFilterString

public static SearchFilter forLDAPSearchFilterString(String s)

Parse a LDAP search filter into a SearchFilter instance.

Parameters:

s - the string to parse

Returns:

the filter, or null if s is not in a valid format