com.unboundid.ldap.sdk.unboundidds.jsonfilter

Class EqualsAnyJSONObjectFilter

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.jsonfilter.JSONObjectFilter

com.unboundid.ldap.sdk.unboundidds.jsonfilter.EqualsAnyJSONObjectFilter

All Implemented Interfaces:

java.io.Serializable

@Mutable
@ThreadSafety(level=NOT_THREADSAFE)
public final class EqualsAnyJSONObjectFilter
extends JSONObjectFilter

This class provides an implementation of a JSON object filter that can be used to identify JSON objects that have a specified field whose value matches one of specified set of values.

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 "equals any" filter are:

• 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.
• values -- The set of values that should be used to match. This should be an array, but the elements of the array may be of any type. In order for a JSON object ot match this "equals any" filter, either the value of the target field must have the same type and value as one of the values in this array, or the value of the target field must be an array containing at least one element with the same type and value as one of the values in this array.

The fields that may optionally be included in an "equals" filter are:

• 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.

Example

The following is an example of an "equals any" filter that will match any JSON object that includes a top-level field of "userType" with a value of either "employee", "partner", or "contractor": value:

   { "filterType" : "equalsAny",
     "field" : "userType",
     "values" : [  "employee", "partner", "contractor" ] }
 

The above filter can be created with the code:

   EqualsAnyJSONObjectFilter filter = new EqualsAnyJSONObjectFilter(
        "userType", "employee", "partner", "contractor");
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
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_VALUES The name of the JSON field that is used to specify the values 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 any" 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 and Description
EqualsAnyJSONObjectFilter(java.util.List<java.lang.String> field, java.util.Collection<JSONValue> values) Creates a new instance of this filter type with the provided information.
EqualsAnyJSONObjectFilter(java.lang.String field, java.util.Collection<JSONValue> values) Creates a new instance of this filter type with the provided information.
EqualsAnyJSONObjectFilter(java.lang.String field, JSONValue... values) Creates a new instance of this filter type with the provided information.
EqualsAnyJSONObjectFilter(java.lang.String field, java.lang.String... values) Creates a new instance of this filter type with the provided information.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	caseSensitive() Indicates whether string matching should be performed in a case-sensitive manner.
protected EqualsAnyJSONObjectFilter	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.
java.util.List<JSONValue>	getValues() Retrieves the set of target values 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	setValues(java.util.Collection<JSONValue> values) Specifies the set of target values for this filter.
void	setValues(JSONValue... values) Specifies the set of target values for this filter.
void	setValues(java.lang.String... values) Specifies the set of target values 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

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 "equals any" filter.

See Also:

Constant Field Values

FIELD_FIELD_PATH

@NotNull
public static final 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.

See Also:

Constant Field Values

FIELD_VALUES

@NotNull
public static final java.lang.String FIELD_VALUES

The name of the JSON field that is used to specify the values to use for the matching.

See Also:

Constant Field Values

FIELD_CASE_SENSITIVE

@NotNull
public static final java.lang.String FIELD_CASE_SENSITIVE

The name of the JSON field that is used to indicate whether string matching should be case-sensitive.

See Also:

Constant Field Values

Constructor Detail

EqualsAnyJSONObjectFilter

public EqualsAnyJSONObjectFilter(@NotNull
                         java.lang.String field,
                         @NotNull
                         java.lang.String... values)

Creates a new instance of this filter type with the provided information.

Parameters:

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.

values - The set of expected string values for the target field. This filter will match an object in which the target field has the same type and value as any of the values in this set, or in which the target field is an array containing an element with the same type and value as any of the values in this set. It must not be null or empty.

EqualsAnyJSONObjectFilter

public EqualsAnyJSONObjectFilter(@NotNull
                         java.lang.String field,
                         @NotNull
                         JSONValue... values)

Creates a new instance of this filter type with the provided information.

Parameters:

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.

values - The set of expected string values for the target field. This filter will match an object in which the target field has the same type and value as any of the values in this set, or in which the target field is an array containing an element with the same type and value as any of the values in this set. It must not be null or empty.

EqualsAnyJSONObjectFilter

public EqualsAnyJSONObjectFilter(@NotNull
                         java.lang.String field,
                         @NotNull
                         java.util.Collection<JSONValue> values)

Creates a new instance of this filter type with the provided information.

Parameters:

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.

values - The set of expected string values for the target field. This filter will match an object in which the target field has the same type and value as any of the values in this set, or in which the target field is an array containing an element with the same type and value as any of the values in this set. It must not be null or empty.

EqualsAnyJSONObjectFilter

public EqualsAnyJSONObjectFilter(@NotNull
                         java.util.List<java.lang.String> field,
                         @NotNull
                         java.util.Collection<JSONValue> values)

Creates a new instance of this filter type with the provided information.

Parameters:

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.

values - The set of expected string values for the target field. This filter will match an object in which the target field has the same type and value as any of the values in this set, or in which the target field is an array containing an element with the same type and value as any of the values in this set. It must not be null or empty.

Method Detail

getField

@NotNull
public java.util.List<java.lang.String> getField()

Retrieves the field path specifier for this filter.

Returns:

The field path specifier for this filter.

setField

public void setField(@NotNull
            java.lang.String... field)

Sets the field path specifier for this filter.

Parameters:

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.

setField

public void setField(@NotNull
            java.util.List<java.lang.String> field)

Sets the field path specifier for this filter.

Parameters:

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.

getValues

@NotNull
public java.util.List<JSONValue> getValues()

Retrieves the set of target values for this filter. A JSON object will only match this filter if it includes the target field with a value contained in this set.

Returns:

The set of target values for this filter.

setValues

public void setValues(@NotNull
             java.lang.String... values)

Specifies the set of target values for this filter.

Parameters:

values - The set of target string values for this filter. It must not be null or empty.

setValues

public void setValues(@NotNull
             JSONValue... values)

Specifies the set of target values for this filter.

Parameters:

values - The set of target values for this filter. It must not be null or empty.

setValues

public void setValues(@NotNull
             java.util.Collection<JSONValue> values)

Specifies the set of target values for this filter.

Parameters:

values - The set of target values for this filter. It must not be null or empty.

caseSensitive

public boolean caseSensitive()

Indicates whether string matching should be performed in a case-sensitive manner.

Returns:

true if string matching should be case sensitive, or false if not.

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)

Specifies whether string matching should be performed in a case-sensitive manner.

Parameters:

caseSensitive - Indicates whether string matching should be case sensitive.

getFilterType

@NotNull
public java.lang.String getFilterType()

Retrieves the value that must appear in the filterType field for this filter.

Specified by:

getFilterType in class JSONObjectFilter

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 the filterType field) that must be present in the JSON object representing a filter of this type.

Specified by:

getRequiredFieldNames in class JSONObjectFilter

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 class JSONObjectFilter

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 class JSONObjectFilter

Parameters:

o - The JSON object for which to make the determination.

Returns:

true if this JSON object filter matches the provided JSON object, or false if not.

toJSONObject

@NotNull
public JSONObject toJSONObject()

Retrieves a JSON object that represents this filter.

Specified by:

toJSONObject in class JSONObjectFilter

Returns:

A JSON object that represents this filter.

decodeFilter

@NotNull
protected EqualsAnyJSONObjectFilter decodeFilter(@NotNull
                                             JSONObject filterObject)
                                          throws JSONException

Decodes the provided JSON object as a filter of this type.

Specified by:

decodeFilter in class JSONObjectFilter

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.