com.unboundid.ldap.sdk.unboundidds.jsonfilter

Class ANDJSONObjectFilter

java.lang.Object

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

com.unboundid.ldap.sdk.unboundidds.jsonfilter.ANDJSONObjectFilter

All Implemented Interfaces:

java.io.Serializable

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

This class provides an implementation of a JSON object filter that can perform a logical AND across the result obtained from a number of filters. The AND filter will match an object only if all of the filters contained in it match that object. An AND filter with an empty set of embedded filters will 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 "AND" filter are:

• andFilters -- An array of JSON objects, each of which is a valid JSON object filter. Each of these filters must match a JSON object in order for the AND filter to match. If this is an empty array, then the filter will match any object.

Examples

The following is an example of an AND filter that will match any JSON object:

   { "filterType" : "and",
     "andFilters" : [ ] }
 

The above filter can be created with the code:

   ANDJSONObjectFilter filter = new ANDJSONObjectFilter();
 

The following is an example of an AND filter that will match any JSON object in which there is a top-level field named "firstName" with a String value of "John" and top-level field named "lastName" with a String value of "Doe":

   { "filterType" : "and",
     "andFilters" : [
       { "filterType" : "equals",
          "field" : "firstName",
          "value" : "John" },
       { "filterType" : "equals",
          "field" : "lastName",
          "value" : "Doe" } ] }
 

The above filter can be created with the code:

   ANDJSONObjectFilter filter = new ANDJSONObjectFilter(
        new EqualsJSONObjectFilter("firstName", "John"),
        new EqualsJSONObjectFilter("firstName", "Doe"));
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FIELD_AND_FILTERS The name of the JSON field that is used to specify the set of filters to include in this AND filter.
static java.lang.String	FILTER_TYPE The value that should be used for the filterType element of the JSON object that represents an "AND" 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
ANDJSONObjectFilter(java.util.Collection<JSONObjectFilter> andFilters) Creates a new instance of this filter type with the provided information.
ANDJSONObjectFilter(JSONObjectFilter... andFilters) Creates a new instance of this filter type with the provided information.

Method Summary

Methods

Modifier and Type	Method and Description
protected ANDJSONObjectFilter	decodeFilter(JSONObject filterObject) Decodes the provided JSON object as a filter of this type.
java.util.List<JSONObjectFilter>	getANDFilters() Retrieves the set of filters that must each match a JSON object in order for this AND filter to match.
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	setANDFilters(java.util.Collection<JSONObjectFilter> andFilters) Specifies the set of AND filters that must each match a JSON object in order for this AND filter to match.
void	setANDFilters(JSONObjectFilter... andFilters) Specifies the set of AND filters that must each match a JSON object in order for this AND filter to match.
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 "AND" filter.

See Also:

Constant Field Values

FIELD_AND_FILTERS

@NotNull
public static final java.lang.String FIELD_AND_FILTERS

The name of the JSON field that is used to specify the set of filters to include in this AND filter.

See Also:

Constant Field Values

Constructor Detail

ANDJSONObjectFilter

public ANDJSONObjectFilter(@Nullable
                   JSONObjectFilter... andFilters)

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

Parameters:

andFilters - The set of filters that must each match a JSON object in order for this AND filter to match. If this is null or empty, then this AND filter will match any JSON object.

ANDJSONObjectFilter

public ANDJSONObjectFilter(@Nullable
                   java.util.Collection<JSONObjectFilter> andFilters)

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

Parameters:

andFilters - The set of filters that must each match a JSON object in order for this AND filter to match. If this is null or empty, then this AND filter will match any JSON object.

Method Detail

getANDFilters

@NotNull
public java.util.List<JSONObjectFilter> getANDFilters()

Retrieves the set of filters that must each match a JSON object in order for this AND filter to match.

Returns:

The set of filters that must each match a JSON object in order for this AND filter to match, or an empty list if this AND filter should match any JSON object.

setANDFilters

public void setANDFilters(@Nullable
                 JSONObjectFilter... andFilters)

Specifies the set of AND filters that must each match a JSON object in order for this AND filter to match.

Parameters:

andFilters - The set of filters that must each match a JSON object in order for this AND filter to match. If this is null or empty, then this AND filter will match any JSON object.

setANDFilters

public void setANDFilters(@Nullable
                 java.util.Collection<JSONObjectFilter> andFilters)

Specifies the set of AND filters that must each match a JSON object in order for this AND filter to match.

Parameters:

andFilters - The set of filters that must each match a JSON object in order for this AND filter to match. If this is null or empty, then this AND filter will match any JSON object.

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