Package com.loop54.model.request.parameters.filters

Class AttributeFilterParameter<T>

java.lang.Object

com.loop54.model.request.parameters.filters.FilterParameter

com.loop54.model.request.parameters.filters.AttributeFilterParameter<T>

Type Parameters:

T - The type of the entity that we want to filter.

public class AttributeFilterParameter<T>
extends FilterParameter

Used for filtering entities that have a certain attribute value.

Field Summary

Fields

Modifier and Type	Field	Description
final String	attributeName	The name of attribute to filter on.
FilterComparisonMode	comparisonMode	How to compare the attribute value against the provided value.
final FilterParameterType	type	Type of the filter.
T	value	The value to test the attributes values against.

Constructor Summary

Constructors

Constructor	Description
AttributeFilterParameter(FilterParameterType type, T value)
AttributeFilterParameter(String attributeName, T value)	Constructor.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

type

public final FilterParameterType type

Type of the filter. If the type of the filter is FilterParameterType.ATTRIBUTE, the name of the attribute needs to be specified in the attributeName field.

attributeName

public final String attributeName

The name of attribute to filter on. This must be set if type is FilterParameterType.ATTRIBUTE.

value

public T value

The value to test the attributes values against.

comparisonMode

public FilterComparisonMode comparisonMode

How to compare the attribute value against the provided value. Defaults to FilterComparisonMode.EQUALS.

Constructor Details

AttributeFilterParameter

public AttributeFilterParameter(FilterParameterType type,
 T value)

Parameters:

type - Type of the filter. If you want to use FilterParameterType.ATTRIBUTE it's easier to use the AttributeFilterParameter(String, Object) constructor.

value - The value to compare.

AttributeFilterParameter

public AttributeFilterParameter(String attributeName,
 T value)

Constructor. Use this if you want to use the filter parameter to filter on an attribute. Will set the type of the filter to FilterParameterType.ATTRIBUTE.

Parameters:

attributeName - Name of the attribute to filter on. For instance "category". Note that the names of the attributes vary depending on setup.

value - The value to compare. For instance a category name if filtering on a category attribute.