Package com.unboundid.ldap.sdk.unboundidds.jsonfilter

Class ORJSONObjectFilter

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.jsonfilter.JSONObjectFilter
com.unboundid.ldap.sdk.unboundidds.jsonfilter.ORJSONObjectFilter
All Implemented Interfaces:
Serializable
@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class ORJSONObjectFilter extends JSONObjectFilter
This class provides an implementation of a JSON object filter that can perform a logical OR across the result obtained from a number of filters. The OR filter will match an object only if at least one (and optionally, exactly one) of the filters contained in it matches that object. An OR filter with an empty set of embedded filters will never 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 "OR" filter are:
  • 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.
The fields that may optionally be included in an "OR" filter are:
  • 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.

Examples

The following is an example of an OR filter that will never match any JSON object: 
   { "filterType" : "or",
     "orFilters" : [ ] }
The above filter can be created with the code: 
   ORJSONObjectFilter filter = new ORJSONObjectFilter();


The following is an example of an OR filter that will match any JSON object that contains either a top-level field named "homePhone" or a top-level field named "workPhone": 
   { "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"));
See Also:

  • Field Details

  • Constructor Details

    • ORJSONObjectFilter

      public ORJSONObjectFilter(@Nullable JSONObjectFilter... orFilters)
      Creates a new instance of this filter type with the provided information.
      Parameters:
      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.

    • ORJSONObjectFilter

      public ORJSONObjectFilter(@Nullable Collection<JSONObjectFilter> orFilters)
      Creates a new instance of this filter type with the provided information.
      Parameters:
      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.

  • Method Details

    • getORFilters

      @NotNull public List<JSONObjectFilter> getORFilters()
      Retrieves the set of filters for this OR filter. At least one of these filters must match a JSON object in order fro this OR filter to match that object.
      Returns:
      The set of filters for this OR filter.

    • setORFilters

      public void setORFilters(@Nullable JSONObjectFilter... orFilters)
      Specifies 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.
      Parameters:
      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.

    • setORFilters

      public void setORFilters(@Nullable Collection<JSONObjectFilter> orFilters)
      Specifies 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.
      Parameters:
      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.

    • exclusive

      public 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.
      Returns:
      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.

    • setExclusive

      public 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.
      Parameters:
      exclusive - Indicates whether this filter should be treated as an exclusive OR.

    • getFilterType

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

    • toNormalizedJSONObject

      @NotNull public JSONObject toNormalizedJSONObject()
      Retrieves a JSON object that represents a normalized version of this filter.
      Specified by:
      toNormalizedJSONObject in class JSONObjectFilter
      Returns:
      A JSON object that represents a normalized version of this filter.

    • decodeFilter

      @NotNull protected ORJSONObjectFilter 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.