Package com.apptus.esales.connector

Class FilterBuilder

java.lang.Object

com.apptus.esales.connector.FilterBuilder

public class FilterBuilder
extends Object

A set of static methods for building a filter.

The FilterBuilder class is a utility that is intended to be used to create filters for eSales queries. The methods in this class are all static and return some kind of Filter limiting your search.

Example:

  // create some simple attribute filters
  Filter a = FilterBuilder.attribute("artist", "Presley");
  Filter b = FilterBuilder.attribute("song", "Jumpin' Jack Flash");
  Filter c = FilterBuilder.attribute("description", "Rock nostalgia");

  System.out.println("Created some attribute filters:");
  System.out.println(a);
  System.out.println(b);
  System.out.println(c);

  System.out.println();

  // lets combine them
  Filter kingOfRock = FilterBuilder.and(a, c);
  System.out.println(kingOfRock);
  Filter classic = FilterBuilder.and(b, c);
  System.out.println(classic);
  Filter justCool = FilterBuilder.or(a, b);
  System.out.println(justCool);
  Filter coolOldie = FilterBuilder.and(justCool, c);
  System.out.println(coolOldie);

  System.out.println();

  // lets add some more stuff into the mix
  Filter lamers = FilterBuilder.attribute("artist", "Sofarock");
  lamers = FilterBuilder.or(lamers, FilterBuilder.attribute("artist", "amazonics"));
  Filter noLamers = FilterBuilder.not(lamers);
  System.out.println(noLamers);

  // combine more than 2 filters at once by simply supplying them all
  Filter theOriginal = FilterBuilder.and(classic, noLamers, c);
  System.out.println(theOriginal);
  

Author:

Björn Nyberg

Method Summary

Modifier and Type	Method	Description
static Filter	and(Filter[] filters)	Create a new AND filter to match the intersection of the results that all filters would return.
static Filter	and(Filter q1, Filter q2, Filter... filters)	Create a new AND filter to match the intersection of results that q1, q2 and each of the filters would return.
static Filter	attribute(String[] attributes, String value)	Create a new attribute filter, limiting results to products where all processed parts (after tokenization and normalization) of the specified value are present within any of the given attributes.
static Filter	attribute(String attribute, String value)	Create a new attribute filter, limiting results to products where all processed parts (after tokenization and normalization) of the specified value are present within the given attribute.
static Filter	empty()	Return a empty filter representing no results.
static Filter	fromString(String filter)	Create a new filter, limiting results to products inside the specified filter.
static Filter	fromString(String filter, boolean needsParentheses)	Create a new filter, limiting results to products inside the specified filter.
static Filter	incremental(String[] attributes, String value)	Create a new INCREMENTAL filter, limiting the result to products where all processed parts (after tokenization and normalization) of the specified value are present within any of the given attributes.
static Filter	incremental(String attribute, String value)	Create a new INCREMENTAL filter, limiting the result to products where all processed parts (after tokenization and normalization) of the specified value are present within the given attribute.
static Filter	not(Filter operand)	Create a new NOT filter matching every result that the given operand doesn't match.
static Filter	or(Filter[] filters)	Create a new OR filter to match the union of results that each of the filters would return.
static Filter	or(Filter q1, Filter q2, Filter... filters)	Create a new OR filter to match the union of results that q1 , q2 and each of the filters would return.
static Filter	range(String[] attributes, String from, String to)	Create a new range filter, limiting results to values between from (inclusive) and to (exclusive), for any of the specified attributes.
static Filter	range(String[] attributes, String from, String to, boolean fromInc, boolean toInc)	Create a new range filter limiting results to values between from and to, for any of the specified attributes.
static Filter	range(String attribute, String from, String to)	Create a new range filter, limiting results to values between from (inclusive) and to (exclusive), for the specified attribute.
static Filter	range(String attribute, String from, String to, boolean fromInc, boolean toInc)	Create a new range filter limiting results to values between from and to, for the specified attribute.
static Filter	universe()	Return a universe filter representing all results.

Methods inherited from class java.lang.Object

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

Method Detail

and

public static Filter and(Filter q1,
                         Filter q2,
                         Filter... filters)

Create a new AND filter to match the intersection of results that q1, q2 and each of the filters would return.

Parameters:

q1 - the first operand

q2 - the second operand

filters - additional operands

Returns:

an AND filter

or

public static Filter or(Filter q1,
                        Filter q2,
                        Filter... filters)

Create a new OR filter to match the union of results that q1 , q2 and each of the filters would return.

Parameters:

q1 - the first operand

q2 - the second operand

filters - additional operands

Returns:

an OR filter

not

public static Filter not(Filter operand)

Create a new NOT filter matching every result that the given operand doesn't match.

Parameters:

operand - the operand to negate

Returns:

a NOT filter

and

public static Filter and(Filter[] filters)

Create a new AND filter to match the intersection of the results that all filters would return.

Parameters:

filters - additional operands

Returns:

an AND filter

or

public static Filter or(Filter[] filters)

Create a new OR filter to match the union of results that each of the filters would return.

Parameters:

filters - additional operands

Returns:

an OR filter

attribute

public static Filter attribute(String[] attributes,
                               String value)

Create a new attribute filter, limiting results to products where all processed parts (after tokenization and normalization) of the specified value are present within any of the given attributes.

Parameters:

attributes - the attributes to search within

value - the value to match

Returns:

a new attribute filter

attribute

public static Filter attribute(String attribute,
                               String value)

Create a new attribute filter, limiting results to products where all processed parts (after tokenization and normalization) of the specified value are present within the given attribute.

Parameters:

attribute - the attribute to search within

value - the value to match

Returns:

a new attribute filter

fromString

public static Filter fromString(String filter)

Create a new filter, limiting results to products inside the specified filter. Parentheses will be added if this filter is part of a composite filter.

Parameters:

filter - the string representation of the filter to match

Returns:

a new string filter

fromString

public static Filter fromString(String filter,
                                boolean needsParentheses)

Create a new filter, limiting results to products inside the specified filter.

Parameters:

filter - the string representation of the filter to match

needsParentheses - true if parentheses is needed when this filter is part of a composite filter.

Returns:

a new string filter

incremental

public static Filter incremental(String[] attributes,
                                 String value)

Create a new INCREMENTAL filter, limiting the result to products where all processed parts (after tokenization and normalization) of the specified value are present within any of the given attributes. The last value token matches if any attribute contains a value to which it is a prefix (after tokenization).

Parameters:

attributes - the attributes to search within

value - the value to match

Returns:

a new attribute filter

incremental

public static Filter incremental(String attribute,
                                 String value)

Create a new INCREMENTAL filter, limiting the result to products where all processed parts (after tokenization and normalization) of the specified value are present within the given attribute. The last value token matches if any attribute contains a value to which it is a prefix (after tokenization).

Parameters:

attribute - the attributes to search within

value - the value to match

Returns:

a new attribute filter

range

public static Filter range(String[] attributes,
                           String from,
                           String to)

Create a new range filter, limiting results to values between from (inclusive) and to (exclusive), for any of the specified attributes.

Parameters:

attributes - the attributes

from - the lower bound

to - the upper bound

Returns:

a range filter as described above

range

public static Filter range(String attribute,
                           String from,
                           String to)

Create a new range filter, limiting results to values between from (inclusive) and to (exclusive), for the specified attribute.

Parameters:

attribute - the attribute

from - the lower bound

to - the upper bound

Returns:

a range filter as described above

range

public static Filter range(String[] attributes,
                           String from,
                           String to,
                           boolean fromInc,
                           boolean toInc)

Create a new range filter limiting results to values between from and to, for any of the specified attributes. Whether or not the bounds should be considered inclusive or exclusive is determined by the specified fromInc and toInc parameters.

Parameters:

attributes - the attributes

from - the lower bound

to - the upper bound

fromInc - if the lower bound is to be considered inclusive

toInc - if the upper bound is to be considered inclusive

Returns:

a range filter as described above

range

public static Filter range(String attribute,
                           String from,
                           String to,
                           boolean fromInc,
                           boolean toInc)

Create a new range filter limiting results to values between from and to, for the specified attribute. Whether or not the bounds should be considered inclusive or exclusive is determined by the specified fromInc and toInc parameters.

Parameters:

attribute - the attributes

from - the lower bound

to - the upper bound

fromInc - if the lower bound is to be considered inclusive

toInc - if the upper bound is to be considered inclusive

Returns:

a range filter as described above

universe

public static Filter universe()

Return a universe filter representing all results.

Returns:

the universe filter

empty

public static Filter empty()

Return a empty filter representing no results.

Returns:

the empty filter