Package de.digitalcollections.model.api.filter.enums

Enum FilterOperation

java.lang.Object

java.lang.Enum<FilterOperation>

de.digitalcollections.model.api.filter.enums.FilterOperation

All Implemented Interfaces:

Serializable, Comparable<FilterOperation>

public enum FilterOperation
extends Enum<FilterOperation>

Available filter operations

Mapping operation abbreviation to filter operation

Symbol	Operation	Example filter query param
eq	Equals	city=eq:Munich
neq	Not Equals	country=neq:de
gt	Greater Than	amount=gt:10000
gte	Greater Than or equals to	amount=gte:10000
lt	Less Than	amount=lt:10000
lte	Less Than or equals to	amount=lte:10000
in	IN	country=in:uk, usa, au
nin	Not IN	country=nin:fr, de, nz
btn	Between (inclusive)	joiningDate=btn:2018-01-01, 2016-01-01
like	Like	firstName=like:John
set	value exists (not null)	firstName=set:
notset	value is not set (null)	firstName=notset:

References:

See Also:

An example application using Spring boot MVC, Spring Data JPA with the ability to do filter, pagination and sorting.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FilterOperation.OperandCount

Enum Constant Summary

Enum Constants

Enum Constant	Description
BETWEEN
CONTAINS
EQUALS
GREATER_THAN
GREATER_THAN_OR_EQUAL_TO
IN
LESS_THAN
LESSTHAN_OR_EQUAL_TO
NOT_EQUALS
NOT_IN
NOT_SET
SET

Method Summary

Modifier and Type	Method	Description
static FilterOperation	fromValue(String value)
FilterOperation.OperandCount	getOperandCount()
String	toString()
static FilterOperation	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FilterOperation[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EQUALS

public static final FilterOperation EQUALS

NOT_EQUALS

public static final FilterOperation NOT_EQUALS

GREATER_THAN

public static final FilterOperation GREATER_THAN

GREATER_THAN_OR_EQUAL_TO

public static final FilterOperation GREATER_THAN_OR_EQUAL_TO

LESS_THAN

public static final FilterOperation LESS_THAN

LESSTHAN_OR_EQUAL_TO

public static final FilterOperation LESSTHAN_OR_EQUAL_TO

IN

public static final FilterOperation IN

NOT_IN

public static final FilterOperation NOT_IN

BETWEEN

public static final FilterOperation BETWEEN

CONTAINS

public static final FilterOperation CONTAINS

NOT_SET

public static final FilterOperation NOT_SET

SET

public static final FilterOperation SET

Method Detail

values

public static FilterOperation[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FilterOperation c : FilterOperation.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FilterOperation valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getOperandCount

public FilterOperation.OperandCount getOperandCount()

toString

public String toString()

Overrides:

toString in class Enum<FilterOperation>

fromValue

public static FilterOperation fromValue(String value)