lumis.search.filter
Class SearchFilterGroup

java.lang.Object
  lumis.search.filter.SearchFilterGroup

All Implemented Interfaces:

ISearchQueryFilter

@StableMinor(version="5.5",
             sinceVersion="4.2.2")
public class SearchFilterGroup
extends Object
implements ISearchQueryFilter

Allows the creation of composite filters by grouping them together and using a logical operator to join them.

Since:

4.2.2

Field Summary

static String	GROUP_OPERATOR_AND Performs a logical AND when grouping the filters.
static String	GROUP_OPERATOR_OR Performs a logical OR when grouping the filters.

Constructor Summary

SearchFilterGroup()

Method Summary

List<? extends ISearchQueryFilter>	getFilters() Returns the filters in this group.
String	getOperator() Returns the operator for grouping the filters.
void	setFilters(List<? extends ISearchQueryFilter> filters) Sets the filters in this group.
void	setOperator(String operator) Sets the operator for grouping the filters.

Methods inherited from class java.lang.Object

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

Field Detail

GROUP_OPERATOR_AND

public static final String GROUP_OPERATOR_AND

Performs a logical AND when grouping the filters.

Since:

4.2.2

See Also:

Constant Field Values

GROUP_OPERATOR_OR

public static final String GROUP_OPERATOR_OR

Performs a logical OR when grouping the filters.

Since:

4.2.2

See Also:

Constant Field Values

Constructor Detail

SearchFilterGroup

public SearchFilterGroup()

Method Detail

getOperator

public String getOperator()

Returns the operator for grouping the filters.

Returns:

the operator.

Since:

4.2.2

See Also:

setOperator(String)

setOperator

public void setOperator(String operator)

Sets the operator for grouping the filters. The default value is GROUP_OPERATOR_AND.

This class contains some operator constants defined as standard operators for clauses. The actual allowed operators and interpretation given depend on the Searcher implementation being used. It is recommended that all searchers implement the standard operators defined in this class for best compatibility.

Parameters:

operator - the operator value to set.

Since:

4.2.2

See Also:

GROUP_OPERATOR_AND, GROUP_OPERATOR_OR

getFilters

public List<? extends ISearchQueryFilter> getFilters()

Returns the filters in this group.

Returns:

a immutable list containing the filters.

Since:

4.2.2

setFilters

public void setFilters(List<? extends ISearchQueryFilter> filters)

Sets the filters in this group.

Parameters:

filters - a list containing the filters.

Since:

4.2.2