Class ORJSONObjectFilter
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.jsonfilter.JSONObjectFilter
-
- com.unboundid.ldap.sdk.unboundidds.jsonfilter.ORJSONObjectFilter
-
- All Implemented Interfaces:
java.io.Serializable
@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class ORJSONObjectFilter extends JSONObjectFilter
This class provides an implementation of a JSON object filter that can perform a logical OR across the result obtained from a number of filters. The OR filter will match an object only if at least one (and optionally, exactly one) of the filters contained in it matches that object. An OR filter with an empty set of embedded filters will never match any object.
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.
The fields that are required to be included in an "OR" filter are:-
orFilters
-- An array of JSON objects, each of which is a valid JSON object filter. At least one of these filters must match a JSON object in order for the OR filter to match. If this is an empty array, then the filter will not match any object.
-
exclusive
-- Indicates whether this should be treated as an exclusive OR. If this is present, then it must have a Boolean value of eithertrue
(to indicate that this OR filter will only match a JSON object if exactly one of the embedded filters matches that object), orfalse
(to indicate that it is a non-exclusive OR and will match a JSON object as long as at least one of the filters matches that object). If this is not specified, then a non-exclusive OR will be performed.
Examples
The following is an example of an OR filter that will never match any JSON object:{ "filterType" : "or", "orFilters" : [ ] }
The above filter can be created with the code:ORJSONObjectFilter filter = new ORJSONObjectFilter();
The following is an example of an OR filter that will match any JSON object that contains either a top-level field named "homePhone" or a top-level field named "workPhone":{ "filterType" : "or", "orFilters" : [ { "filterType" : "containsField", "field" : "homePhone" }, { "filterType" : "containsField", "field" : "workPhone" } ] }
The above filter can be created with the code:ORJSONObjectFilter filter = new ORJSONObjectFilter( new ContainsFieldJSONObjectFilter("homePhone"), new EqualsJSONObjectFilter("workPhone"));
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
FIELD_EXCLUSIVE
The name of the JSON field that is used to indicate whether this should be an exclusive OR.static java.lang.String
FIELD_OR_FILTERS
The name of the JSON field that is used to specify the set of filters to include in this OR filter.static java.lang.String
FILTER_TYPE
The value that should be used for the filterType element of the JSON object that represents an "OR" filter.-
Fields inherited from class com.unboundid.ldap.sdk.unboundidds.jsonfilter.JSONObjectFilter
FIELD_FILTER_TYPE, JSON_OBJECT_FILTER_MATCHING_RULE_NAME, JSON_OBJECT_FILTER_MATCHING_RULE_OID
-
-
Constructor Summary
Constructors Constructor Description ORJSONObjectFilter(JSONObjectFilter... orFilters)
Creates a new instance of this filter type with the provided information.ORJSONObjectFilter(java.util.Collection<JSONObjectFilter> orFilters)
Creates a new instance of this filter type with the provided information.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected ORJSONObjectFilter
decodeFilter(JSONObject filterObject)
Decodes the provided JSON object as a filter of this type.boolean
exclusive()
Indicates whether this filter should be treated as an exclusive OR, in which it will only match a JSON object if exactly one of the embedded filters matches that object.java.lang.String
getFilterType()
Retrieves the value that must appear in thefilterType
field for this filter.protected java.util.Set<java.lang.String>
getOptionalFieldNames()
Retrieves the names of all fields that may optionally be present but are not required in the JSON object representing a filter of this type.java.util.List<JSONObjectFilter>
getORFilters()
Retrieves the set of filters for this OR filter.protected java.util.Set<java.lang.String>
getRequiredFieldNames()
Retrieves the names of all fields (excluding thefilterType
field) that must be present in the JSON object representing a filter of this type.boolean
matchesJSONObject(JSONObject o)
Indicates whether this JSON object filter matches the provided JSON object.void
setExclusive(boolean exclusive)
Specifies whether this filter should be treated as an exclusive OR, in which it will only match a JSON object if exactly one of the embedded filters matches that object.void
setORFilters(JSONObjectFilter... orFilters)
Specifies the set of filters for this OR filter.void
setORFilters(java.util.Collection<JSONObjectFilter> orFilters)
Specifies the set of filters for this OR filter.JSONObject
toJSONObject()
Retrieves a JSON object that represents this filter.-
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.jsonfilter.JSONObjectFilter
decode, equals, getBoolean, getFilters, getString, getStrings, getValues, hashCode, registerFilterType, toLDAPFilter, toString, toString
-
-
-
-
Field Detail
-
FILTER_TYPE
@NotNull public static final java.lang.String FILTER_TYPE
The value that should be used for the filterType element of the JSON object that represents an "OR" filter.- See Also:
- Constant Field Values
-
FIELD_OR_FILTERS
@NotNull public static final java.lang.String FIELD_OR_FILTERS
The name of the JSON field that is used to specify the set of filters to include in this OR filter.- See Also:
- Constant Field Values
-
FIELD_EXCLUSIVE
@NotNull public static final java.lang.String FIELD_EXCLUSIVE
The name of the JSON field that is used to indicate whether this should be an exclusive OR.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ORJSONObjectFilter
public ORJSONObjectFilter(@Nullable JSONObjectFilter... orFilters)
Creates a new instance of this filter type with the provided information.- Parameters:
orFilters
- The set of filters for this OR filter. At least one of these filters must match a JSON object in order for this OR filter to match that object. If this isnull
or empty, then this OR filter will never match any JSON object.
-
ORJSONObjectFilter
public ORJSONObjectFilter(@Nullable java.util.Collection<JSONObjectFilter> orFilters)
Creates a new instance of this filter type with the provided information.- Parameters:
orFilters
- The set of filters for this OR filter. At least one of these filters must match a JSON object in order for this OR filter to match that object. If this isnull
or empty, then this OR filter will never match any JSON object.
-
-
Method Detail
-
getORFilters
@NotNull public java.util.List<JSONObjectFilter> getORFilters()
Retrieves the set of filters for this OR filter. At least one of these filters must match a JSON object in order fro this OR filter to match that object.- Returns:
- The set of filters for this OR filter.
-
setORFilters
public void setORFilters(@Nullable JSONObjectFilter... orFilters)
Specifies the set of filters for this OR filter. At least one of these filters must match a JSON object in order for this OR filter to match that object.- Parameters:
orFilters
- The set of filters for this OR filter. At least one of these filters must match a JSON object in order for this OR filter to match that object. If this isnull
or empty, then this OR filter will never match any JSON object.
-
setORFilters
public void setORFilters(@Nullable java.util.Collection<JSONObjectFilter> orFilters)
Specifies the set of filters for this OR filter. At least one of these filters must match a JSON object in order for this OR filter to match that object.- Parameters:
orFilters
- The set of filters for this OR filter. At least one of these filters must match a JSON object in order for this OR filter to match that object. If this isnull
or empty, then this OR filter will never match any JSON object.
-
exclusive
public boolean exclusive()
Indicates whether this filter should be treated as an exclusive OR, in which it will only match a JSON object if exactly one of the embedded filters matches that object.- Returns:
true
if this filter should be treated as an exclusive OR and will only match a JSON object if exactly one of the embedded filters matches that object, orfalse
if this filter will be non-exclusive and will match a JSON object as long as at least one of the embedded filters matches that object.
-
setExclusive
public void setExclusive(boolean exclusive)
Specifies whether this filter should be treated as an exclusive OR, in which it will only match a JSON object if exactly one of the embedded filters matches that object.- Parameters:
exclusive
- Indicates whether this filter should be treated as an exclusive OR.
-
getFilterType
@NotNull public java.lang.String getFilterType()
Retrieves the value that must appear in thefilterType
field for this filter.- Specified by:
getFilterType
in classJSONObjectFilter
- Returns:
- The value that must appear in the
filterType
field for this filter.
-
getRequiredFieldNames
@NotNull protected java.util.Set<java.lang.String> getRequiredFieldNames()
Retrieves the names of all fields (excluding thefilterType
field) that must be present in the JSON object representing a filter of this type.- Specified by:
getRequiredFieldNames
in classJSONObjectFilter
- Returns:
- The names of all fields (excluding the
filterType
field) that must be present in the JSON object representing a filter of this type.
-
getOptionalFieldNames
@NotNull protected java.util.Set<java.lang.String> getOptionalFieldNames()
Retrieves the names of all fields that may optionally be present but are not required in the JSON object representing a filter of this type.- Specified by:
getOptionalFieldNames
in classJSONObjectFilter
- Returns:
- The names of all fields that may optionally be present but are not required in the JSON object representing a filter of this type.
-
matchesJSONObject
public boolean matchesJSONObject(@NotNull JSONObject o)
Indicates whether this JSON object filter matches the provided JSON object.- Specified by:
matchesJSONObject
in classJSONObjectFilter
- Parameters:
o
- The JSON object for which to make the determination.- Returns:
true
if this JSON object filter matches the provided JSON object, orfalse
if not.
-
toJSONObject
@NotNull public JSONObject toJSONObject()
Retrieves a JSON object that represents this filter.- Specified by:
toJSONObject
in classJSONObjectFilter
- Returns:
- A JSON object that represents this filter.
-
decodeFilter
@NotNull protected ORJSONObjectFilter decodeFilter(@NotNull JSONObject filterObject) throws JSONException
Decodes the provided JSON object as a filter of this type.- Specified by:
decodeFilter
in classJSONObjectFilter
- Parameters:
filterObject
- The JSON object to be decoded. The caller will have already validated that all required fields are present, and that it does not have any fields that are neither required nor optional.- Returns:
- The decoded JSON object filter.
- Throws:
JSONException
- If the provided JSON object cannot be decoded as a valid filter of this type.
-
-