Package de.digitalcollections.model.api.filter

Class FilterCriterion<T>

java.lang.Object
de.digitalcollections.model.api.filter.FilterCriterion<T>
Type Parameters:
T - target type for deserializing operand value
public class FilterCriterion<T>
extends java.lang.Object
Filter Criterion Container.A filter criterion is a composition of
  • a field name being target of filter operation
  • a filter operation (operator)
  • one ore more filter values to be used for filtering operation (operand(s))
References:
See Also:
An example application using Spring boot MVC, Spring Data JPA with the ability to do filter, pagination and sorting.

  • Constructor Summary

    Constructors
    Constructor Description
    FilterCriterion​(java.lang.String fieldName, FilterOperation operation, java.lang.Object value)
    Constructor for single value Filter Criteria.
    FilterCriterion​(java.lang.String fieldName, FilterOperation operation, java.lang.Object value, java.lang.Comparable<?> minValue, java.lang.Comparable<?> maxValue, java.util.Collection<?> values)
    Constructor for Filter Criteria.

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getFieldName()  
    java.lang.Comparable<?> getMaxValue()  
    java.lang.Comparable<?> getMinValue()  
    FilterOperation getOperation()  
    java.lang.Object getValue()  
    java.util.Collection<?> getValues()  
    void setFieldName​(java.lang.String fieldName)  
    java.lang.String toString()  

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • FilterCriterion

      public FilterCriterion​(java.lang.String fieldName, FilterOperation operation, java.lang.Object value, java.lang.Comparable<?> minValue, java.lang.Comparable<?> maxValue, java.util.Collection<?> values)
      Constructor for Filter Criteria.
      Parameters:
      fieldName - target field the criteria should be used for
      operation - operation of criteria
      value - operand of criteria
      minValue - minimum value of between operation
      maxValue - maximum value of between operation
      values - operand(s) of criteria

    • FilterCriterion

      public FilterCriterion​(java.lang.String fieldName, FilterOperation operation, java.lang.Object value)
      Constructor for single value Filter Criteria.
      Parameters:
      fieldName - target field the criteria should be used for
      operation - operation of criteria
      value - operand of criteria

  • Method Details

    • setFieldName

      public void setFieldName​(java.lang.String fieldName)

    • getValue

      public java.lang.Object getValue()
      Returns:
      value of a single value operation

    • getMinValue

      public java.lang.Comparable<?> getMinValue()
      Returns:
      minimum value - applicable only for FilterOperation.BETWEEN

    • getMaxValue

      public java.lang.Comparable<?> getMaxValue()
      Returns:
      maximum value - applicable only for FilterOperation.BETWEEN

    • getOperation

      public FilterOperation getOperation()
      Returns:
      the filter operation. available operations see FilterOperation

    • getFieldName

      public java.lang.String getFieldName()
      Returns:
      field name being target of filter operation

    • getValues

      public java.util.Collection<?> getValues()
      Returns:
      values of a multi value operation of field type T

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object