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

Class GreaterThanJSONObjectFilter

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.jsonfilter.JSONObjectFilter
com.unboundid.ldap.sdk.unboundidds.jsonfilter.GreaterThanJSONObjectFilter
All Implemented Interfaces:
Serializable
@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class GreaterThanJSONObjectFilter extends JSONObjectFilter
This class provides an implementation of a JSON object filter that can be used to identify JSON objects that have at least one value for a specified field that is greater than a given value.
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 a "greater than" 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.
  • value -- The value to use in the matching. It must be either a string (which will be compared against other strings using lexicographic comparison) or a number.
The fields that may optionally be included in a "greater than" filter are:
  • allowEquals -- Indicates whether to match JSON objects that have a value for the specified field that matches the provided value. If present, this field must have a Boolean value of either true (to indicate that it should be a "greater-than or equal to" filter) or false (to indicate that it should be a strict "greater-than" filter). If this is not specified, then the default behavior will be to perform a strict "greater-than" evaluation.
  • matchAllElements -- Indicates whether all elements of an array must be greater than (or possibly equal to) the specified value. If present, this field must have a Boolean value of true (to indicate that all elements of the array must match the criteria for this filter) or false (to indicate that at least one element of the array must match the criteria for this filter). If this is not specified, then the default behavior will be to require only at least one matching element. This field will be ignored for JSON objects in which the specified field has a value that is not an array.
  • 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 a "greater than" filter that will match any JSON object with a top-level field named "salary" with a value that is greater than or equal to 50000: 
   { "filterType" : "greaterThan",
     "field" : "salary",
     "value" : 50000,
     "allowEquals" : true }
The above filter can be created with the code: 
   GreaterThanJSONObjectFilter filter =
        new GreaterThanJSONObjectFilter("salary", 50000);
   filter.setAllowEquals(true);
See Also:

  • Field Details

  • Constructor Details

    • GreaterThanJSONObjectFilter

      public GreaterThanJSONObjectFilter(@NotNull String field, long value)
      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.
      value - The target value for this filter.

    • GreaterThanJSONObjectFilter

      public GreaterThanJSONObjectFilter(@NotNull String field, double value)
      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.
      value - The target value for this filter.

    • GreaterThanJSONObjectFilter

      public GreaterThanJSONObjectFilter(@NotNull String field, @NotNull String value)
      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.
      value - The target value for this filter. It must not be null.

    • GreaterThanJSONObjectFilter

      public GreaterThanJSONObjectFilter(@NotNull String field, @NotNull JSONValue value)
      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.
      value - The target value for this filter. It must not be null, and it must be either a JSONNumber or a JSONString.

    • GreaterThanJSONObjectFilter

      public GreaterThanJSONObjectFilter(@NotNull List<String> field, @NotNull JSONValue value)
      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.
      value - The target value for this filter. It must not be null, and it must be either a JSONNumber or a JSONString.

  • Method Details

    • getField

      @NotNull public List<String> getField()
      Retrieves the field path specifier for this filter.
      Returns:
      The field path specifier for this filter.

    • setField

      public void setField(@NotNull 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 List<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.

    • getValue

      @NotNull public JSONValue getValue()
      Retrieves the target value for this filter.
      Returns:
      The target value for this filter.

    • setValue

      public void setValue(long value)
      Specifies the target value for this filter.
      Parameters:
      value - The target value for this filter.

    • setValue

      public void setValue(double value)
      Specifies the target value for this filter.
      Parameters:
      value - The target value for this filter.

    • setValue

      public void setValue(@NotNull String value)
      Specifies the target value for this filter.
      Parameters:
      value - The target value for this filter. It must not be null.

    • setValue

      public void setValue(@NotNull JSONValue value)
      Specifies the target value for this filter.
      Parameters:
      value - The target value for this filter. It must not be null, and it must be either a JSONNumber or a JSONString.

    • allowEquals

      public boolean allowEquals()
      Indicates whether this filter will match values that are considered equal to the provided value in addition to those that are strictly greater than that value.
      Returns:
      true if this filter should behave like a "greater than or equal to" filter, or false if it should behave strictly like a "greater than" filter.

    • setAllowEquals

      public void setAllowEquals(boolean allowEquals)
      Specifies whether this filter should match values that are considered equal to the provided value in addition to those that are strictly greater than that value.
      Parameters:
      allowEquals - Indicates whether this filter should match values that are considered equal to the provided value in addition to those that are strictly greater than this value.

    • matchAllElements

      public boolean matchAllElements()
      Indicates whether, if the specified field has a value that is an array, to require all elements of that array to match the criteria for this filter rather than merely requiring at least one value to match.
      Returns:
      true if the criteria contained in this filter will be required to match all elements of an array, or false if merely one or more values will be required to match.

    • setMatchAllElements

      public void setMatchAllElements(boolean matchAllElements)
      Specifies whether, if the value of the target field is an array, all elements of that array will be required to match the criteria of this filter. This will be ignored if the value of the target field is not an array.
      Parameters:
      matchAllElements - true to indicate that all elements of an array will be required to match the criteria of this filter, or false to indicate that merely one or more values will be required to match.

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