Interface CriteriaDefinition

All Known Implementing Classes:
Criteria
public interface CriteriaDefinition
Interface defining a criteria definition object. A criteria definition may chain multiple predicates and may also represent a group of nested criteria objects.
Since:
2.0
Author:
Mark Paluch, Jens Schauder
See Also:

  • Method Details

    • empty

      static CriteriaDefinition empty()
      Static factory method to create an empty CriteriaDefinition.
      Returns:
      an empty CriteriaDefinition.

    • from

      static CriteriaDefinition from(CriteriaDefinition... criteria)
      Create a new CriteriaDefinition and combine it as group with AND using the provided Criterias.
      Returns:
      new CriteriaDefinition.

    • from

      static CriteriaDefinition from(List<? extends CriteriaDefinition> criteria)
      Create a new CriteriaDefinition and combine it as group with AND using the provided Criterias.
      Returns:
      new CriteriaDefinition.
      Since:
      1.1

    • isGroup

      boolean isGroup()
      Returns:
      true if this CriteriaDefinition is empty.

    • getGroup

      List<CriteriaDefinition> getGroup()

    • getColumn

      @Nullable SqlIdentifier getColumn()
      Returns:
      the column/property name.

    • getComparator

      @Nullable CriteriaDefinition.Comparator getComparator()
      Returns:
      CriteriaDefinition.Comparator.

    • getValue

      @Nullable Object getValue()
      Returns:
      the comparison value. Can be null.

    • isIgnoreCase

      boolean isIgnoreCase()
      Checks whether comparison should be done in case-insensitive way.
      Returns:
      true if comparison should be done in case-insensitive way

    • getPrevious

      @Nullable CriteriaDefinition getPrevious()
      Returns:
      the previous CriteriaDefinition object. Can be null if there is no previous CriteriaDefinition.
      See Also:

    • getRequiredPrevious

      default CriteriaDefinition getRequiredPrevious()
      Returns:
      the required previous CriteriaDefinition object or throws an IllegalStateException if there is no previous CriteriaDefinition.
      Since:
      4.0
      See Also:

    • hasPrevious

      boolean hasPrevious()
      Returns:
      true if this CriteriaDefinition has a previous one.

    • isEmpty

      boolean isEmpty()
      Returns:
      true if this CriteriaDefinition is empty.

    • getCombinator

      CriteriaDefinition.Combinator getCombinator()
      Returns:
      CriteriaDefinition.Combinator to combine this CriteriaDefinition with a previous one.