Package org.openhab.core.persistence

Class FilterCriteria

java.lang.Object

org.openhab.core.persistence.FilterCriteria

@NonNullByDefault
public class FilterCriteria
extends Object

This class is used to define a filter for queries to a PersistenceService.

It is designed as a Java bean, for which the different properties are constraints on the query result. These properties include the item name, begin and end date and the item state. A compare operator can be defined to compare not only state equality, but also its decimal value (<,>).

Additionally, the filter criteria supports ordering and paging of the result, so the caller can ask to only return chunks of the result of a certain size (=pageSize) from a starting index (pageNumber*pageSize).

All setter methods return the filter criteria instance, so that the methods can be easily chained in order to define a filter.

Author:

Kai Kreuzer - Initial contribution, Lyubomir Papazov - Deprecate methods using java.util and add methods that use Java8's ZonedDateTime, Mark Herwege - Copy constructor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FilterCriteria.Operator	Enumeration with all possible compare options
static enum	FilterCriteria.Ordering	Enumeration with all ordering options

Constructor Summary

Constructors

Constructor	Description
FilterCriteria()
FilterCriteria(FilterCriteria filter)

Method Summary

Modifier and Type	Method	Description
@Nullable ZonedDateTime	getBeginDate()
@Nullable ZonedDateTime	getEndDate()
@Nullable String	getItemName()
FilterCriteria.Operator	getOperator()
FilterCriteria.Ordering	getOrdering()
int	getPageNumber()
int	getPageSize()
@Nullable State	getState()
FilterCriteria	setBeginDate(ZonedDateTime beginDate)
FilterCriteria	setEndDate(ZonedDateTime endDate)
FilterCriteria	setItemName(String itemName)
FilterCriteria	setOperator(FilterCriteria.Operator operator)
FilterCriteria	setOrdering(FilterCriteria.Ordering ordering)
FilterCriteria	setPageNumber(int pageNumber)
FilterCriteria	setPageSize(int pageSize)
FilterCriteria	setState(State state)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

FilterCriteria

public FilterCriteria()

FilterCriteria

public FilterCriteria(FilterCriteria filter)

Method Details

getItemName

public @Nullable String getItemName()

getBeginDate

public @Nullable ZonedDateTime getBeginDate()

getEndDate

public @Nullable ZonedDateTime getEndDate()

getPageNumber

public int getPageNumber()

getPageSize

public int getPageSize()

getOperator

public FilterCriteria.Operator getOperator()

getOrdering

public FilterCriteria.Ordering getOrdering()

getState

public @Nullable State getState()

setItemName

public FilterCriteria setItemName(String itemName)

setBeginDate

public FilterCriteria setBeginDate(ZonedDateTime beginDate)

setEndDate

public FilterCriteria setEndDate(ZonedDateTime endDate)

setPageNumber

public FilterCriteria setPageNumber(int pageNumber)

setPageSize

public FilterCriteria setPageSize(int pageSize)

setOperator

public FilterCriteria setOperator(FilterCriteria.Operator operator)

setOrdering

public FilterCriteria setOrdering(FilterCriteria.Ordering ordering)

setState

public FilterCriteria setState(State state)

toString

public String toString()

Overrides:

toString in class Object