GreaterThanJSONObjectFilter (UnboundID LDAP SDK for Java 7.0.0)

java.lang.Object
- com.unboundid.ldap.sdk.unboundidds.jsonfilter.JSONObjectFilter
- - com.unboundid.ldap.sdk.unboundidds.jsonfilter.GreaterThanJSONObjectFilter

All Implemented Interfaces:

java.io.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:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`FIELD_ALLOW_EQUALS` The name of the JSON field that is used to indicate whether to match JSON objects with a value that is considered equal to the provided value.
`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_MATCH_ALL_ELEMENTS` The name of the JSON field that is used to indicate whether to match all elements of an array rather than just one or more.
`static java.lang.String`	`FIELD_VALUE` The name of the JSON field that is used to specify the value 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 a "greater than" 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
`GreaterThanJSONObjectFilter(java.util.List<java.lang.String> field, JSONValue value)` Creates a new instance of this filter type with the provided information.
`GreaterThanJSONObjectFilter(java.lang.String field, double value)` Creates a new instance of this filter type with the provided information.
`GreaterThanJSONObjectFilter(java.lang.String field, JSONValue value)` Creates a new instance of this filter type with the provided information.
`GreaterThanJSONObjectFilter(java.lang.String field, long value)` Creates a new instance of this filter type with the provided information.
`GreaterThanJSONObjectFilter(java.lang.String field, java.lang.String value)` Creates a new instance of this filter type with the provided information.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`boolean`	`caseSensitive()` Indicates whether string matching should be performed in a case-sensitive manner.
`protected GreaterThanJSONObjectFilter`	`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.
`JSONValue`	`getValue()` Retrieves the target value for this filter.
`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.
`boolean`	`matchesJSONObject(JSONObject o)` Indicates whether this JSON object filter matches the provided JSON object.
`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.
`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`	`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.
`void`	`setValue(double value)` Specifies the target value for this filter.
`void`	`setValue(JSONValue value)` Specifies the target value for this filter.
`void`	`setValue(long value)` Specifies the target value for this filter.
`void`	`setValue(java.lang.String value)` Specifies the target value for this filter.
`JSONObject`	`toJSONObject()` Retrieves a JSON object that represents this filter.
`JSONObject`	`toNormalizedJSONObject()` Retrieves a JSON object that represents a normalized version of this filter.

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.jsonfilter.JSONObjectFilter
decode, equals, getBoolean, getFilters, getString, getStrings, getValues, hashCode, registerFilterType, toLDAPFilter, toNormalizedString, toNormalizedString, 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 a "greater than" 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_VALUE
```
@NotNull
public static final java.lang.String FIELD_VALUE
```
    The name of the JSON field that is used to specify the value to use for the matching.
    
    See Also:
    
    Constant Field Values
  - FIELD_ALLOW_EQUALS
```
@NotNull
public static final java.lang.String FIELD_ALLOW_EQUALS
```
    The name of the JSON field that is used to indicate whether to match JSON objects with a value that is considered equal to the provided value.
    
    See Also:
    
    Constant Field Values
  - FIELD_MATCH_ALL_ELEMENTS
```
@NotNull
public static final java.lang.String FIELD_MATCH_ALL_ELEMENTS
```
    The name of the JSON field that is used to indicate whether to match all elements of an array rather than just one or more.
    
    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
  - GreaterThanJSONObjectFilter
```
public GreaterThanJSONObjectFilter(@NotNull
                                   java.lang.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
                                   java.lang.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
                                   java.lang.String field,
                                   @NotNull
                                   java.lang.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
                                   java.lang.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
                                   java.util.List<java.lang.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 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.
  - 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
                     java.lang.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 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.
  - 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.

Class GreaterThanJSONObjectFilter

Example

Field Summary

Fields inherited from class com.unboundid.ldap.sdk.unboundidds.jsonfilter.JSONObjectFilter

Constructor Summary

Method Summary

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.jsonfilter.JSONObjectFilter

Methods inherited from class java.lang.Object

Field Detail

FILTER_TYPE

FIELD_FIELD_PATH

FIELD_VALUE

FIELD_ALLOW_EQUALS

FIELD_MATCH_ALL_ELEMENTS

FIELD_CASE_SENSITIVE

Constructor Detail

GreaterThanJSONObjectFilter

GreaterThanJSONObjectFilter

GreaterThanJSONObjectFilter

GreaterThanJSONObjectFilter

GreaterThanJSONObjectFilter

Method Detail

getField

setField

setField

getValue

setValue

setValue

setValue

setValue

allowEquals

setAllowEquals

matchAllElements

setMatchAllElements

caseSensitive

setCaseSensitive

getFilterType

getRequiredFieldNames

getOptionalFieldNames

matchesJSONObject

toJSONObject

toNormalizedJSONObject

decodeFilter