|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.unboundidds.jsonfilter.JSONObjectFilter
com.unboundid.ldap.sdk.unboundidds.jsonfilter.EqualsJSONObjectFilter
@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class EqualsJSONObjectFilter
NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.This class provides an implementation of a JSON object filter that can be used to identify JSON objects that have a particular value for a specified field.
fieldName
-- A field path specifier for the JSON field for which
to make the determination. This may be either a single string or an
array of strings as described in the "Targeting Fields in JSON Objects"
section of the class-level documentation for JSONObjectFilter
.
value
-- The value to match. This value may be of any type. In
order for a JSON object to match the equals filter, the value of the
target field must either have the same type value as this value, or the
value of the target field must be an array containing at least one
element with the same type and value. If the provided value is an array,
then the order, types, and values of the array must match an array
contained in the target field. If the provided value is a JSON object,
then the target field must contain a JSON object with exactly the same
set of fields and values.
caseSensitive
-- Indicates whether string values should be
treated in a case-sensitive manner. If present, this field must have a
Boolean value of either true
or false
. If it is not
provided, then a default value of false
will be assumed so that
strings are treated in a case-insensitive manner.
{ "filterType" : "equals", "field" : "firstName", "value" : "John" }The above filter can be created with the code:
EqualsJSONObjectFilter filter = new EqualsJSONObjectFilter("firstName", "John");The following is an example of an "equals" filter that will match a JSON object with a top-level field named "contact" whose value is a JSON object (or an array containing one or more JSON objects) with a field named "type" and a value of "home":
{ "filterType" : "equals", "field" : [ "contact", "type" ], "value" : "home" }That filter can be created with the code:
EqualsJSONObjectFilter filter = new EqualsJSONObjectFilter(Arrays.asList("contact", "type"), "Home");
Field Summary | |
---|---|
static java.lang.String |
FIELD_CASE_SENSITIVE
The name of the JSON field that is used to indicate whether string matching should be case-sensitive. |
static java.lang.String |
FIELD_FIELD_PATH
The name of the JSON field that is used to specify the field in the target JSON object for which to make the determination. |
static java.lang.String |
FIELD_VALUE
The name of the JSON field that is used to specify the value to use for the matching. |
static java.lang.String |
FILTER_TYPE
The value that should be used for the filterType element of the JSON object that represents an "equals" 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 | |
---|---|
EqualsJSONObjectFilter(java.util.List<java.lang.String> field,
JSONValue value)
Creates a new instance of this filter type with the provided information. |
|
EqualsJSONObjectFilter(java.lang.String field,
boolean value)
Creates a new instance of this filter type with the provided information. |
|
EqualsJSONObjectFilter(java.lang.String field,
double value)
Creates a new instance of this filter type with the provided information. |
|
EqualsJSONObjectFilter(java.lang.String field,
JSONValue value)
Creates a new instance of this filter type with the provided information. |
|
EqualsJSONObjectFilter(java.lang.String field,
long value)
Creates a new instance of this filter type with the provided information. |
|
EqualsJSONObjectFilter(java.lang.String field,
java.lang.String value)
Creates a new instance of this filter type with the provided information. |
Method Summary | |
---|---|
boolean |
caseSensitive()
Indicates whether string matching should be performed in a case-sensitive manner. |
protected EqualsJSONObjectFilter |
decodeFilter(JSONObject filterObject)
Decodes the provided JSON object as a filter of this type. |
java.util.List<java.lang.String> |
getField()
Retrieves the field path specifier for this filter. |
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. |
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. |
JSONValue |
getValue()
Retrieves the target value for this filter. |
boolean |
matchesJSONObject(JSONObject o)
Indicates whether this JSON object filter matches the provided JSON object. |
void |
setCaseSensitive(boolean caseSensitive)
Specifies whether string matching should be performed in a case-sensitive manner. |
void |
setField(java.util.List<java.lang.String> field)
Sets the field path specifier for this filter. |
void |
setField(java.lang.String... field)
Sets the field path specifier for this filter. |
void |
setValue(boolean value)
Specifies the target value for this filter. |
void |
setValue(double value)
Specifies the target value for this filter. |
void |
setValue(JSONValue value)
Specifies the target value for this filter. |
void |
setValue(long value)
Specifies the target value for this filter. |
void |
setValue(java.lang.String value)
Specifies the target value for this 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 |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String FILTER_TYPE
public static final java.lang.String FIELD_FIELD_PATH
public static final java.lang.String FIELD_VALUE
public static final java.lang.String FIELD_CASE_SENSITIVE
Constructor Detail |
---|
public EqualsJSONObjectFilter(java.lang.String field, java.lang.String value)
field
- The name of the top-level field to target with this filter.
It must not be null
. See the class-level
documentation for the JSONObjectFilter
class for
information about field path specifiers.value
- The target string value for this filter. It must not be
null
.public EqualsJSONObjectFilter(java.lang.String field, boolean value)
field
- The name of the top-level field to target with this filter.
It must not be null
. See the class-level
documentation for the JSONObjectFilter
class for
information about field path specifiers.value
- The target boolean value for this filter.public EqualsJSONObjectFilter(java.lang.String field, long value)
field
- The name of the top-level field to target with this filter.
It must not be null
. See the class-level
documentation for the JSONObjectFilter
class for
information about field path specifiers.value
- The target numeric value for this filter.public EqualsJSONObjectFilter(java.lang.String field, double value)
field
- The name of the top-level field to target with this filter.
It must not be null
. See the class-level
documentation for the JSONObjectFilter
class for
information about field path specifiers.value
- The target numeric value for this filter. It must not be
null
.public EqualsJSONObjectFilter(java.lang.String field, JSONValue value)
field
- The name of the top-level field to target with this filter.
It must not be null
. See the class-level
documentation for the JSONObjectFilter
class for
information about field path specifiers.value
- The target value for this filter. It must not be
null
.public EqualsJSONObjectFilter(java.util.List<java.lang.String> field, JSONValue value)
field
- The field path specifier for this filter. It must not be
null
or empty. See the class-level documentation
for the JSONObjectFilter
class for information about
field path specifiers.value
- The target value for this filter. It must not be
null
(although it may be a JSONNull
).Method Detail |
---|
public java.util.List<java.lang.String> getField()
public void setField(java.lang.String... field)
field
- The field path specifier for this filter. It must not be
null
or empty. See the class-level documentation
for the JSONObjectFilter
class for information about
field path specifiers.public void setField(java.util.List<java.lang.String> field)
field
- The field path specifier for this filter. It must not be
null
or empty. See the class-level documentation
for the JSONObjectFilter
class for information about
field path specifiers.public JSONValue getValue()
public void setValue(java.lang.String value)
value
- The target string value for this filter. It must not be
null
.public void setValue(boolean value)
value
- The target Boolean value for this filter.public void setValue(long value)
value
- The target numeric value for this filter.public void setValue(double value)
value
- The target numeric value for this filter.public void setValue(JSONValue value)
value
- The target value for this filter. It must not be
null
(although it may be a JSONNull
).public boolean caseSensitive()
true
if string matching should be case sensitive, or
false
if not.public void setCaseSensitive(boolean caseSensitive)
caseSensitive
- Indicates whether string matching should be
case sensitive.public java.lang.String getFilterType()
filterType
field for
this filter.
getFilterType
in class JSONObjectFilter
filterType
field for
this filter.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.protected java.util.Set<java.lang.String> getOptionalFieldNames()
getOptionalFieldNames
in class JSONObjectFilter
public boolean matchesJSONObject(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.public JSONObject toJSONObject()
toJSONObject
in class JSONObjectFilter
protected EqualsJSONObjectFilter decodeFilter(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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |