|
|||||||||
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.ObjectMatchesJSONObjectFilter
@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class ObjectMatchesJSONObjectFilter
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 field whose value is a JSON object that matches a provided JSON object filter, or a field whose value is an array that contains at least one JSON object that matches the provided filter.
field
-- 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
. The value
of the target field is expected to either be a JSON object or an array
that contains one or more JSON objects.
filter
-- A JSON object that represents a valid JSON object
filter to match against any JSON object(s) in the value of the target
field. Note that field name references in this filter should be
relative to the object in the value of the target field, not to the
other JSON object that contains that field.
{ "filterType" : "objectMatches", "field" : "contact", "filter" : { "filterType" : "and", "andFilters" : [ { "filterType" : "equals", "field" : "type", "value" : "home" }, { "filterType" : "containsField", "field" : "email" } ] } }The above filter can be created with the code:
ObjectMatchesJSONObjectFilter filter = new ObjectMatchesJSONObjectFilter( "contact", new ANDJSONObjectFilter( new EqualsJSONObjectFilter("type", "home"), new ContainsFieldJSONObjectFilter("email")));
Field Summary | |
---|---|
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_FILTER
The name of the JSON field that is used to specify the filter to match against the object in the target field. |
static java.lang.String |
FILTER_TYPE
The value that should be used for the filterType element of the JSON object that represents an "object matches" 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 | |
---|---|
ObjectMatchesJSONObjectFilter(java.util.List<java.lang.String> field,
JSONObjectFilter filter)
Creates a new instance of this filter type with the provided information. |
|
ObjectMatchesJSONObjectFilter(java.lang.String field,
JSONObjectFilter filter)
Creates a new instance of this filter type with the provided information. |
Method Summary | |
---|---|
protected ObjectMatchesJSONObjectFilter |
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. |
JSONObjectFilter |
getFilter()
Retrieves the filter that will be matched against any JSON objects contained in the value of the specified field. |
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. |
boolean |
matchesJSONObject(JSONObject o)
Indicates whether this JSON object filter matches the provided JSON object. |
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 |
setFilter(JSONObjectFilter filter)
Specifies the filter that will be matched against any JSON objects contained in the value of the specified field. |
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_FILTER
Constructor Detail |
---|
public ObjectMatchesJSONObjectFilter(java.lang.String field, JSONObjectFilter filter)
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.filter
- The filter that will be matched against JSON objects
contained in the specified field.public ObjectMatchesJSONObjectFilter(java.util.List<java.lang.String> field, JSONObjectFilter filter)
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.filter
- The filter that will be matched against JSON objects
contained in the specified field.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 JSONObjectFilter getFilter()
public void setFilter(JSONObjectFilter filter)
filter
- The filter that will be matched against any JSON objects
contained in the value of the specified field. It must
not be null
.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 ObjectMatchesJSONObjectFilter 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 |