Package io.github.jhipster.service.filter

Class Filter<FIELD_TYPE>

java.lang.Object

io.github.jhipster.service.filter.Filter<FIELD_TYPE>

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BooleanFilter, RangeFilter, StringFilter, UUIDFilter

public class Filter<FIELD_TYPE>
extends Object
implements Serializable

Base class for the various attribute filters. It can be added to a criteria class as a member, to support the following query parameters:

      fieldName.equals='something'
      fieldName.notEquals='somethingElse'
      fieldName.specified=true
      fieldName.specified=false
      fieldName.in='something','other'
      fieldName.notIn='something','other'
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Filter()	Constructor for Filter.
Filter(Filter<FIELD_TYPE> filter)	Constructor for Filter.

Method Summary

Modifier and Type	Method	Description
Filter<FIELD_TYPE>	copy()	copy.
boolean	equals(Object o)
FIELD_TYPE	getEquals()	Getter for the field equals.
protected String	getFilterName()	getFilterName.
List<FIELD_TYPE>	getIn()	Getter for the field in.
FIELD_TYPE	getNotEquals()	Getter for the field notEquals.
List<FIELD_TYPE>	getNotIn()	Getter for the field notIn.
Boolean	getSpecified()	Getter for the field specified.
int	hashCode()
Filter<FIELD_TYPE>	setEquals(FIELD_TYPE equals)	Setter for the field equals.
Filter<FIELD_TYPE>	setIn(List<FIELD_TYPE> in)	Setter for the field in.
Filter<FIELD_TYPE>	setNotEquals(FIELD_TYPE notEquals)	Setter for the field notEquals.
Filter<FIELD_TYPE>	setNotIn(List<FIELD_TYPE> notIn)	Setter for the field notIn.
Filter<FIELD_TYPE>	setSpecified(Boolean specified)	Setter for the field specified.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Filter

public Filter()

Constructor for Filter.

Filter

public Filter(Filter<FIELD_TYPE> filter)

Constructor for Filter.

Parameters:

filter - a Filter object.

Method Detail

copy

public Filter<FIELD_TYPE> copy()

copy.

Returns:

a Filter object.

getEquals

public FIELD_TYPE getEquals()

Getter for the field equals.

Returns:

a FIELD_TYPE object.

setEquals

public Filter<FIELD_TYPE> setEquals(FIELD_TYPE equals)

Setter for the field equals.

Parameters:

equals - a FIELD_TYPE object.

Returns:

a Filter object.

getNotEquals

public FIELD_TYPE getNotEquals()

Getter for the field notEquals.

Returns:

a FIELD_TYPE object.

setNotEquals

public Filter<FIELD_TYPE> setNotEquals(FIELD_TYPE notEquals)

Setter for the field notEquals.

Parameters:

notEquals - a FIELD_TYPE object.

Returns:

a Filter object.

getSpecified

public Boolean getSpecified()

Getter for the field specified.

Returns:

a Boolean object.

setSpecified

public Filter<FIELD_TYPE> setSpecified(Boolean specified)

Setter for the field specified.

Parameters:

specified - a Boolean object.

Returns:

a Filter object.

getIn

public List<FIELD_TYPE> getIn()

Getter for the field in.

Returns:

a List object.

setIn

public Filter<FIELD_TYPE> setIn(List<FIELD_TYPE> in)

Setter for the field in.

Parameters:

in - a List object.

Returns:

a Filter object.

getNotIn

public List<FIELD_TYPE> getNotIn()

Getter for the field notIn.

Returns:

a List object.

setNotIn

public Filter<FIELD_TYPE> setNotIn(List<FIELD_TYPE> notIn)

Setter for the field notIn.

Parameters:

notIn - a List object.

Returns:

a Filter object.

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

getFilterName

protected String getFilterName()

getFilterName.

Returns:

a String object.