Package org.forgerock.util.query

Class JsonValueFilterVisitor

java.lang.Object

org.forgerock.util.query.JsonValueFilterVisitor

All Implemented Interfaces:

QueryFilterVisitor<Boolean,JsonValue,JsonPointer>

public final class JsonValueFilterVisitor
extends Object
implements QueryFilterVisitor<Boolean,JsonValue,JsonPointer>

A QueryFilterVisitor that returns true if the provide JsonValue meets the criteria of the QueryFilter assertions and false if it does not.

Method Summary

Modifier and Type	Method	Description
static QueryFilterVisitor<Boolean,JsonValue,JsonPointer>	jsonValueFilterVisitor()	Returns a QueryFilterVisitor that can assess if a JsonValue resource matches a set of criteria defined by a QueryFilter.
Boolean	visitAndFilter(JsonValue p, List<QueryFilter<JsonPointer>> subFilters)	Visits an and filter.
Boolean	visitBooleanLiteralFilter(JsonValue p, boolean value)	Visits a boolean literal filter.
Boolean	visitComplexFilter(JsonValue p, JsonPointer field, QueryFilter<JsonPointer> subFilter)	Visits a complex filter.
Boolean	visitContainsFilter(JsonValue p, JsonPointer field, Object valueAssertion)	Visits a contains filter.
Boolean	visitEqualsFilter(JsonValue p, JsonPointer field, Object valueAssertion)	Visits a equality filter.
Boolean	visitExtendedMatchFilter(JsonValue p, JsonPointer field, String matchingRuleId, Object valueAssertion)	Visits a comparison filter.
Boolean	visitGreaterThanFilter(JsonValue p, JsonPointer field, Object valueAssertion)	Visits a greater than filter.
Boolean	visitGreaterThanOrEqualToFilter(JsonValue p, JsonPointer field, Object valueAssertion)	Visits a greater than or equal to filter.
Boolean	visitLessThanFilter(JsonValue p, JsonPointer field, Object valueAssertion)	Visits a less than filter.
Boolean	visitLessThanOrEqualToFilter(JsonValue p, JsonPointer field, Object valueAssertion)	Visits a less than or equal to filter.
Boolean	visitNotFilter(JsonValue p, QueryFilter<JsonPointer> subFilter)	Visits a not filter.
Boolean	visitOrFilter(JsonValue p, List<QueryFilter<JsonPointer>> subFilters)	Visits an or filter.
Boolean	visitPresentFilter(JsonValue p, JsonPointer field)	Visits a present filter.
Boolean	visitStartsWithFilter(JsonValue p, JsonPointer field, Object valueAssertion)	Visits a starts with filter.

Methods inherited from class java.lang.Object

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

Method Detail

jsonValueFilterVisitor

public static QueryFilterVisitor<Boolean,JsonValue,JsonPointer> jsonValueFilterVisitor()

Returns a QueryFilterVisitor that can assess if a JsonValue resource matches a set of criteria defined by a QueryFilter.

Returns:

a QueryFilterVisitor on a JsonValue resource

visitAndFilter

public Boolean visitAndFilter(JsonValue p,
                              List<QueryFilter<JsonPointer>> 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<Boolean,JsonValue,JsonPointer>

Parameters:

p - A visitor specified parameter.

subFilters - The unmodifiable list of sub-filters.

Returns:

Returns a visitor specified result.

visitBooleanLiteralFilter

public Boolean visitBooleanLiteralFilter(JsonValue p,
                                         boolean value)

Description copied from interface: QueryFilterVisitor

Visits a boolean literal filter.

Specified by:

visitBooleanLiteralFilter in interface QueryFilterVisitor<Boolean,JsonValue,JsonPointer>

Parameters:

p - A visitor specified parameter.

value - The boolean literal value.

Returns:

Returns a visitor specified result.

visitContainsFilter

public Boolean visitContainsFilter(JsonValue p,
                                   JsonPointer field,
                                   Object valueAssertion)

Description copied from interface: QueryFilterVisitor

Visits a contains filter.

Specified by:

visitContainsFilter in interface QueryFilterVisitor<Boolean,JsonValue,JsonPointer>

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 Boolean visitEqualsFilter(JsonValue p,
                                 JsonPointer field,
                                 Object valueAssertion)

Description copied from interface: QueryFilterVisitor

Visits a equality filter.

Specified by:

visitEqualsFilter in interface QueryFilterVisitor<Boolean,JsonValue,JsonPointer>

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 Boolean visitExtendedMatchFilter(JsonValue p,
                                        JsonPointer field,
                                        String matchingRuleId,
                                        Object valueAssertion)

Description copied from interface: QueryFilterVisitor

Visits a comparison filter.

Specified by:

visitExtendedMatchFilter in interface QueryFilterVisitor<Boolean,JsonValue,JsonPointer>

Parameters:

p - A visitor specified parameter.

field - A definition of the field to be compared.

matchingRuleId - 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 Boolean visitGreaterThanFilter(JsonValue p,
                                      JsonPointer field,
                                      Object valueAssertion)

Description copied from interface: QueryFilterVisitor

Visits a greater than filter.

Specified by:

visitGreaterThanFilter in interface QueryFilterVisitor<Boolean,JsonValue,JsonPointer>

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 Boolean visitGreaterThanOrEqualToFilter(JsonValue p,
                                               JsonPointer field,
                                               Object valueAssertion)

Description copied from interface: QueryFilterVisitor

Visits a greater than or equal to filter.

Specified by:

visitGreaterThanOrEqualToFilter in interface QueryFilterVisitor<Boolean,JsonValue,JsonPointer>

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 Boolean visitLessThanFilter(JsonValue p,
                                   JsonPointer field,
                                   Object valueAssertion)

Description copied from interface: QueryFilterVisitor

Visits a less than filter.

Specified by:

visitLessThanFilter in interface QueryFilterVisitor<Boolean,JsonValue,JsonPointer>

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 Boolean visitLessThanOrEqualToFilter(JsonValue p,
                                            JsonPointer field,
                                            Object valueAssertion)

Description copied from interface: QueryFilterVisitor

Visits a less than or equal to filter.

Specified by:

visitLessThanOrEqualToFilter in interface QueryFilterVisitor<Boolean,JsonValue,JsonPointer>

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 Boolean visitNotFilter(JsonValue p,
                              QueryFilter<JsonPointer> subFilter)

Description copied from interface: QueryFilterVisitor

Visits a not filter.

Specified by:

visitNotFilter in interface QueryFilterVisitor<Boolean,JsonValue,JsonPointer>

Parameters:

p - A visitor specified parameter.

subFilter - The sub-filter.

Returns:

Returns a visitor specified result.

visitOrFilter

public Boolean visitOrFilter(JsonValue p,
                             List<QueryFilter<JsonPointer>> 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<Boolean,JsonValue,JsonPointer>

Parameters:

p - A visitor specified parameter.

subFilters - The unmodifiable list of sub-filters.

Returns:

Returns a visitor specified result.

visitPresentFilter

public Boolean visitPresentFilter(JsonValue p,
                                  JsonPointer field)

Description copied from interface: QueryFilterVisitor

Visits a present filter.

Specified by:

visitPresentFilter in interface QueryFilterVisitor<Boolean,JsonValue,JsonPointer>

Parameters:

p - A visitor specified parameter.

field - A definition of the field to be compared.

Returns:

Returns a visitor specified result.

visitStartsWithFilter

public Boolean visitStartsWithFilter(JsonValue p,
                                     JsonPointer field,
                                     Object valueAssertion)

Description copied from interface: QueryFilterVisitor

Visits a starts with filter.

Specified by:

visitStartsWithFilter in interface QueryFilterVisitor<Boolean,JsonValue,JsonPointer>

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.

visitComplexFilter

public Boolean visitComplexFilter(JsonValue p,
                                  JsonPointer field,
                                  QueryFilter<JsonPointer> subFilter)

Description copied from interface: QueryFilterVisitor

Visits a complex filter.

Specified by:

visitComplexFilter in interface QueryFilterVisitor<Boolean,JsonValue,JsonPointer>

Parameters:

p - A visitor specified parameter.

field - A definition of the field to be compared.

subFilter - The subfilter expression to be evaluated on the object @ field.

Returns:

Returns a visitor specified result.