@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class ORJSONObjectFilter extends JSONObjectFilter
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.
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
either true
(to indicate that this OR filter will only match a
JSON object if exactly one of the embedded filters matches that object),
or false
(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.
{ "filterType" : "or", "orFilters" : [ ] }The above filter can be created with the code:
ORJSONObjectFilter filter = new ORJSONObjectFilter();
{ "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"));
Modifier and Type | Field and 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.
|
FIELD_FILTER_TYPE, JSON_OBJECT_FILTER_MATCHING_RULE_NAME, JSON_OBJECT_FILTER_MATCHING_RULE_OID
Constructor and Description |
---|
ORJSONObjectFilter(java.util.Collection<JSONObjectFilter> orFilters)
Creates a new instance of this filter type with the provided information.
|
ORJSONObjectFilter(JSONObjectFilter... orFilters)
Creates a new instance of this filter type with the provided information.
|
Modifier and Type | Method and 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 the
filterType 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 the
filterType 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(java.util.Collection<JSONObjectFilter> orFilters)
Specifies the set of filters for this OR filter.
|
void |
setORFilters(JSONObjectFilter... orFilters)
Specifies the set of filters for this OR filter.
|
JSONObject |
toJSONObject()
Retrieves a JSON object that represents this filter.
|
JSONObject |
toNormalizedJSONObject()
Retrieves a JSON object that represents a normalized version of this
filter.
|
decode, equals, getBoolean, getFilters, getString, getStrings, getValues, hashCode, registerFilterType, toLDAPFilter, toNormalizedString, toNormalizedString, toString, toString
@NotNull public static final java.lang.String FILTER_TYPE
@NotNull public static final java.lang.String FIELD_OR_FILTERS
@NotNull public static final java.lang.String FIELD_EXCLUSIVE
public ORJSONObjectFilter(@Nullable JSONObjectFilter... orFilters)
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 is
null
or empty, then this OR filter will never
match any JSON object.public ORJSONObjectFilter(@Nullable java.util.Collection<JSONObjectFilter> orFilters)
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 is
null
or empty, then this OR filter will never
match any JSON object.@NotNull public java.util.List<JSONObjectFilter> getORFilters()
public void setORFilters(@Nullable JSONObjectFilter... orFilters)
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 is
null
or empty, then this OR filter will never
match any JSON object.public void setORFilters(@Nullable java.util.Collection<JSONObjectFilter> orFilters)
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 is
null
or empty, then this OR filter will never
match any JSON object.public boolean exclusive()
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, or false
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.public void setExclusive(boolean exclusive)
exclusive
- Indicates whether this filter should be treated as an
exclusive OR.@NotNull public java.lang.String getFilterType()
filterType
field for
this filter.getFilterType
in class JSONObjectFilter
filterType
field for
this filter.@NotNull protected java.util.Set<java.lang.String> getRequiredFieldNames()
filterType
field)
that must be present in the JSON object representing a filter of this type.getRequiredFieldNames
in class JSONObjectFilter
filterType
field)
that must be present in the JSON object representing a filter of
this type.@NotNull protected java.util.Set<java.lang.String> getOptionalFieldNames()
getOptionalFieldNames
in class JSONObjectFilter
public boolean matchesJSONObject(@NotNull JSONObject o)
matchesJSONObject
in class JSONObjectFilter
o
- The JSON object for which to make the determination.true
if this JSON object filter matches the provided JSON
object, or false
if not.@NotNull public JSONObject toJSONObject()
toJSONObject
in class JSONObjectFilter
@NotNull public JSONObject toNormalizedJSONObject()
toNormalizedJSONObject
in class JSONObjectFilter
@NotNull protected ORJSONObjectFilter decodeFilter(@NotNull JSONObject filterObject) throws JSONException
decodeFilter
in class JSONObjectFilter
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.JSONException
- If the provided JSON object cannot be decoded as a
valid filter of this type.