com.yahoo.bard.webservice.web

Class ApiFilter

java.lang.Object

com.yahoo.bard.webservice.web.ApiFilter

public class ApiFilter
extends Object

ApiFilter object.

Constructor Summary

Constructors

Constructor and Description
ApiFilter(Dimension dimension, DimensionField dimensionField, FilterOperation operation, Set<String> values) Constructor.
ApiFilter(String filterQuery, DimensionDictionary dimensionDictionary) Parses the URL filter Query and generates the ApiFilter object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Dimension	getDimension()
DimensionField	getDimensionField()
FilterOperation	getOperation()
Set<String>	getValues()
int	hashCode()
String	toString()
static ApiFilter	union(ApiFilter one, ApiFilter two) Take two Api filters which differ only by value sets and union their value sets.
ApiFilter	withDimension(Dimension dimension)
ApiFilter	withDimensionField(DimensionField dimensionField)
ApiFilter	withOperation(FilterOperation operation)
ApiFilter	withValues(Set<String> values)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ApiFilter

public ApiFilter(Dimension dimension,
                 DimensionField dimensionField,
                 FilterOperation operation,
                 Set<String> values)

Constructor.

Parameters:

dimension - Dimension the filter operates on

dimensionField - Dimension Field the filter operates on

operation - Operation the filter operates with

values - The values the filter uses when operating

ApiFilter

public ApiFilter(@NotNull
                 String filterQuery,
                 DimensionDictionary dimensionDictionary)
          throws BadFilterException

Parses the URL filter Query and generates the ApiFilter object.

Parameters:

filterQuery - Expects a URL filter query String in the format:

(dimension name)|(field name)-(operation)[?(value or comma separated values)]?

dimensionDictionary - cache containing all the valid dimension objects.

Throws:

BadFilterException - Exception when filter pattern is not matched or when any of its properties are not valid.

Method Detail

withDimension

public ApiFilter withDimension(@NotNull
                               Dimension dimension)

withDimensionField

public ApiFilter withDimensionField(@NotNull
                                    DimensionField dimensionField)

withOperation

public ApiFilter withOperation(@NotNull
                               FilterOperation operation)

withValues

public ApiFilter withValues(@NotNull
                            Set<String> values)

getDimension

public Dimension getDimension()

getDimensionField

public DimensionField getDimensionField()

getOperation

public FilterOperation getOperation()

getValues

public Set<String> getValues()

union

public static ApiFilter union(ApiFilter one,
                              ApiFilter two)

Take two Api filters which differ only by value sets and union their value sets.

Parameters:

one - The first ApiFilter

two - The second ApiFilter

Returns:

an ApiFilter with the union of values

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object