Package org.forgerock.util.query

Class BaseQueryFilterVisitor<R,P,F>

java.lang.Object
org.forgerock.util.query.BaseQueryFilterVisitor<R,P,F>
Type Parameters:
R - The return type of this visitor's methods. Use Void for visitors that do not need to return results.
P - The type of the additional parameter to this visitor's methods. Use Void for visitors that do not need an additional parameter.
F - The type of the field definitions in this visitor's methods.
All Implemented Interfaces:
QueryFilterVisitor<R,P,F>
public abstract class BaseQueryFilterVisitor<R,P,F> extends Object implements QueryFilterVisitor<R,P,F>
A base implementation of QueryFilterVisitor where all methods throw an UnsupportedOperationException by default - override just the methods you need.
See Also:

  • Constructor Details

    • BaseQueryFilterVisitor

      public BaseQueryFilterVisitor()

  • Method Details

    • visitAndFilter

      public R visitAndFilter(P p, List<QueryFilter<F>> subFilters)
      Description copied from interface: QueryFilterVisitor
      Visits an and filter.

      Implementation note: for the purposes of matching, an empty sub-filter list should always evaluate to true.

      Specified by:
      visitAndFilter in interface QueryFilterVisitor<R,P,F>
      Parameters:
      p - A visitor specified parameter.
      subFilters - The unmodifiable list of sub-filters.
      Returns:
      Returns a visitor specified result.

    • visitBooleanLiteralFilter

      public R visitBooleanLiteralFilter(P p, boolean value)
      Description copied from interface: QueryFilterVisitor
      Visits a boolean literal filter.
      Specified by:
      visitBooleanLiteralFilter in interface QueryFilterVisitor<R,P,F>
      Parameters:
      p - A visitor specified parameter.
      value - The boolean literal value.
      Returns:
      Returns a visitor specified result.

    • visitContainsFilter

      public R visitContainsFilter(P p, F field, Object valueAssertion)
      Description copied from interface: QueryFilterVisitor
      Visits a contains filter.
      Specified by:
      visitContainsFilter in interface QueryFilterVisitor<R,P,F>
      Parameters:
      p - A visitor specified parameter.
      field - A definition of the field to be compared.
      valueAssertion - The value assertion.
      Returns:
      Returns a visitor specified result.

    • visitEqualsFilter

      public R visitEqualsFilter(P p, F field, Object valueAssertion)
      Description copied from interface: QueryFilterVisitor
      Visits a equality filter.
      Specified by:
      visitEqualsFilter in interface QueryFilterVisitor<R,P,F>
      Parameters:
      p - A visitor specified parameter.
      field - A definition of the field to be compared.
      valueAssertion - The value assertion.
      Returns:
      Returns a visitor specified result.

    • visitExtendedMatchFilter

      public R visitExtendedMatchFilter(P p, F field, String operator, Object valueAssertion)
      Description copied from interface: QueryFilterVisitor
      Visits a comparison filter.
      Specified by:
      visitExtendedMatchFilter in interface QueryFilterVisitor<R,P,F>
      Parameters:
      p - A visitor specified parameter.
      field - A definition of the field to be compared.
      operator - The operator to use for the comparison, which will not be one of the core operator names.
      valueAssertion - The value assertion.
      Returns:
      Returns a visitor specified result.

    • visitGreaterThanFilter

      public R visitGreaterThanFilter(P p, F field, Object valueAssertion)
      Description copied from interface: QueryFilterVisitor
      Visits a greater than filter.
      Specified by:
      visitGreaterThanFilter in interface QueryFilterVisitor<R,P,F>
      Parameters:
      p - A visitor specified parameter.
      field - A definition of the field to be compared.
      valueAssertion - The value assertion.
      Returns:
      Returns a visitor specified result.

    • visitGreaterThanOrEqualToFilter

      public R visitGreaterThanOrEqualToFilter(P p, F field, Object valueAssertion)
      Description copied from interface: QueryFilterVisitor
      Visits a greater than or equal to filter.
      Specified by:
      visitGreaterThanOrEqualToFilter in interface QueryFilterVisitor<R,P,F>
      Parameters:
      p - A visitor specified parameter.
      field - A definition of the field to be compared.
      valueAssertion - The value assertion.
      Returns:
      Returns a visitor specified result.

    • visitLessThanFilter

      public R visitLessThanFilter(P p, F field, Object valueAssertion)
      Description copied from interface: QueryFilterVisitor
      Visits a less than filter.
      Specified by:
      visitLessThanFilter in interface QueryFilterVisitor<R,P,F>
      Parameters:
      p - A visitor specified parameter.
      field - A definition of the field to be compared.
      valueAssertion - The value assertion.
      Returns:
      Returns a visitor specified result.

    • visitLessThanOrEqualToFilter

      public R visitLessThanOrEqualToFilter(P p, F field, Object valueAssertion)
      Description copied from interface: QueryFilterVisitor
      Visits a less than or equal to filter.
      Specified by:
      visitLessThanOrEqualToFilter in interface QueryFilterVisitor<R,P,F>
      Parameters:
      p - A visitor specified parameter.
      field - A definition of the field to be compared.
      valueAssertion - The value assertion.
      Returns:
      Returns a visitor specified result.

    • visitNotFilter

      public R visitNotFilter(P p, QueryFilter<F> subFilter)
      Description copied from interface: QueryFilterVisitor
      Visits a not filter.
      Specified by:
      visitNotFilter in interface QueryFilterVisitor<R,P,F>
      Parameters:
      p - A visitor specified parameter.
      subFilter - The sub-filter.
      Returns:
      Returns a visitor specified result.

    • visitOrFilter

      public R visitOrFilter(P p, List<QueryFilter<F>> subFilters)
      Description copied from interface: QueryFilterVisitor
      Visits an or filter.

      Implementation note: for the purposes of matching, an empty sub-filter list should always evaluate to false.

      Specified by:
      visitOrFilter in interface QueryFilterVisitor<R,P,F>
      Parameters:
      p - A visitor specified parameter.
      subFilters - The unmodifiable list of sub-filters.
      Returns:
      Returns a visitor specified result.

    • visitPresentFilter

      public R visitPresentFilter(P p, F field)
      Description copied from interface: QueryFilterVisitor
      Visits a present filter.
      Specified by:
      visitPresentFilter in interface QueryFilterVisitor<R,P,F>
      Parameters:
      p - A visitor specified parameter.
      field - A definition of the field to be compared.
      Returns:
      Returns a visitor specified result.

    • visitStartsWithFilter

      public R visitStartsWithFilter(P p, F field, Object valueAssertion)
      Description copied from interface: QueryFilterVisitor
      Visits a starts with filter.
      Specified by:
      visitStartsWithFilter in interface QueryFilterVisitor<R,P,F>
      Parameters:
      p - A visitor specified parameter.
      field - A definition of the field to be compared.
      valueAssertion - The value assertion.
      Returns:
      Returns a visitor specified result.

    • visitAnyFilter

      protected R visitAnyFilter(P p)
      By default, unless overridden, all the visit*() methods end up calling this method, which can be overridden to provide a different default behaviour.
      Parameters:
      p - A visitor-specified parameter.
      Returns:
      Returns a visitor-specified result.