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. UseVoid
for visitors that do not need to return results.P
- The type of the additional parameter to this visitor's methods. UseVoid
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 ofQueryFilterVisitor
where all methods throw anUnsupportedOperationException
by default - override just the methods you need.- See Also:
QueryFilterVisitor
-
-
Constructor Summary
Constructors Constructor Description BaseQueryFilterVisitor()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description R
visitAndFilter(P p, List<QueryFilter<F>> subFilters)
Visits anand
filter.R
visitBooleanLiteralFilter(P p, boolean value)
Visits a boolean literal filter.R
visitContainsFilter(P p, F field, Object valueAssertion)
Visits acontains
filter.R
visitEqualsFilter(P p, F field, Object valueAssertion)
Visits aequality
filter.R
visitExtendedMatchFilter(P p, F field, String operator, Object valueAssertion)
Visits acomparison
filter.R
visitGreaterThanFilter(P p, F field, Object valueAssertion)
Visits agreater than
filter.R
visitGreaterThanOrEqualToFilter(P p, F field, Object valueAssertion)
Visits agreater than or equal to
filter.R
visitLessThanFilter(P p, F field, Object valueAssertion)
Visits aless than
filter.R
visitLessThanOrEqualToFilter(P p, F field, Object valueAssertion)
Visits aless than or equal to
filter.R
visitNotFilter(P p, QueryFilter<F> subFilter)
Visits anot
filter.R
visitOrFilter(P p, List<QueryFilter<F>> subFilters)
Visits anor
filter.R
visitPresentFilter(P p, F field)
Visits apresent
filter.R
visitStartsWithFilter(P p, F field, Object valueAssertion)
Visits astarts with
filter.
-
-
-
Method Detail
-
visitAndFilter
public R visitAndFilter(P p, List<QueryFilter<F>> subFilters)
Description copied from interface:QueryFilterVisitor
Visits anand
filter.Implementation note: for the purposes of matching, an empty sub-filter list should always evaluate to
true
.- Specified by:
visitAndFilter
in interfaceQueryFilterVisitor<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 interfaceQueryFilterVisitor<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 acontains
filter.- Specified by:
visitContainsFilter
in interfaceQueryFilterVisitor<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 aequality
filter.- Specified by:
visitEqualsFilter
in interfaceQueryFilterVisitor<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 acomparison
filter.- Specified by:
visitExtendedMatchFilter
in interfaceQueryFilterVisitor<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 agreater than
filter.- Specified by:
visitGreaterThanFilter
in interfaceQueryFilterVisitor<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 agreater than or equal to
filter.- Specified by:
visitGreaterThanOrEqualToFilter
in interfaceQueryFilterVisitor<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 aless than
filter.- Specified by:
visitLessThanFilter
in interfaceQueryFilterVisitor<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 aless than or equal to
filter.- Specified by:
visitLessThanOrEqualToFilter
in interfaceQueryFilterVisitor<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 anot
filter.- Specified by:
visitNotFilter
in interfaceQueryFilterVisitor<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 anor
filter.Implementation note: for the purposes of matching, an empty sub-filter list should always evaluate to
false
.- Specified by:
visitOrFilter
in interfaceQueryFilterVisitor<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 apresent
filter.- Specified by:
visitPresentFilter
in interfaceQueryFilterVisitor<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 astarts with
filter.- Specified by:
visitStartsWithFilter
in interfaceQueryFilterVisitor<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.
-
-