com.unboundid.ldap.sdk.unboundidds.jsonfilter
Class SubstringJSONObjectFilter

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.jsonfilter.JSONObjectFilter
      extended by com.unboundid.ldap.sdk.unboundidds.jsonfilter.SubstringJSONObjectFilter
All Implemented Interfaces:
java.io.Serializable

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

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This class provides an implementation of a JSON object filter that can be used to identify JSON objects that have string value that matches a specified substring. At least one of the startsWith, contains, and endsWith components must be included in the filter. If multiple substring components are present, then any matching value must contain all of those components, and the components must not overlap.

The fields that are required to be included in a "substring" filter are: The fields that may optionally be included in a "substring" filter are:

Examples

The following is an example of a substring filter that will match any JSON object with a top-level field named "accountCreateTime" with a string value that starts with "2015":
   { "filterType" : "substring",
     "field" : "accountCreateTime",
     "startsWith" : "2015" }
 
The above filter can be created with the code:
   SubstringJSONObjectFilter filter =
        new SubstringJSONObjectFilter("accountCreateTime", "2015", null,
             null);
 


The following is an example of a substring filter that will match any JSON object with a top-level field named "fullName" that contains the substrings "John" and "Doe", in that order, somewhere in the value:
   { "filterType" : "substring",
     "field" : "fullName",
     "contains" : [ "John", "Doe" ] }
 
The above filter can be created with the code:
   SubstringJSONObjectFilter filter =
        new SubstringJSONObjectFilter(Collections.singletonList("fullName"),
             null, Arrays.asList("John", "Doe"), null);
 

See Also:
Serialized Form

Field Summary
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_CONTAINS
          The name of the JSON field that is used to specify one or more strings that must appear somewhere in a matching value.
static java.lang.String FIELD_ENDS_WITH
          The name of the JSON field that is used to specify a string that must appear at the end of a matching value.
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_STARTS_WITH
          The name of the JSON field that is used to specify a string that must appear at the beginning of a matching value.
static java.lang.String FILTER_TYPE
          The value that should be used for the filterType element of the JSON object that represents a "substring" 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
SubstringJSONObjectFilter(java.util.List<java.lang.String> field, java.lang.String startsWith, java.util.List<java.lang.String> contains, java.lang.String endsWith)
          Creates a new instance of this filter type with the provided information.
SubstringJSONObjectFilter(java.lang.String field, java.lang.String startsWith, java.lang.String contains, java.lang.String endsWith)
          Creates a new instance of this filter type with the provided information.
 
Method Summary
 boolean caseSensitive()
          Indicates whether string matching should be performed in a case-sensitive manner.
protected  SubstringJSONObjectFilter decodeFilter(JSONObject filterObject)
          Decodes the provided JSON object as a filter of this type.
 java.util.List<java.lang.String> getContains()
          Retrieves the list of strings that must appear somewhere in the value (after any defined "starts with" value, and before any defined "ends with" value).
 java.lang.String getEndsWith()
          Retrieves the substring that must appear at the end of matching values, if defined.
 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.lang.String getStartsWith()
          Retrieves the substring that must appear at the beginning of matching values, if defined.
 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 setSubstringComponents(java.lang.String startsWith, java.util.List<java.lang.String> contains, java.lang.String endsWith)
          Specifies the substring components that must be present in matching values.
 void setSubstringComponents(java.lang.String startsWith, java.lang.String contains, java.lang.String endsWith)
          Specifies the substring components that must be present in matching values.
 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

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 "substring" filter.

See Also:
Constant Field Values

FIELD_FIELD_PATH

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_STARTS_WITH

public static final java.lang.String FIELD_STARTS_WITH
The name of the JSON field that is used to specify a string that must appear at the beginning of a matching value.

See Also:
Constant Field Values

FIELD_CONTAINS

public static final java.lang.String FIELD_CONTAINS
The name of the JSON field that is used to specify one or more strings that must appear somewhere in a matching value.

See Also:
Constant Field Values

FIELD_ENDS_WITH

public static final java.lang.String FIELD_ENDS_WITH
The name of the JSON field that is used to specify a string that must appear at the end of a matching value.

See Also:
Constant Field Values

FIELD_CASE_SENSITIVE

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

SubstringJSONObjectFilter

public SubstringJSONObjectFilter(java.lang.String field,
                                 java.lang.String startsWith,
                                 java.lang.String contains,
                                 java.lang.String endsWith)
Creates a new instance of this filter type with the provided information. At least one startsWith, contains, or endsWith value must be present.

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.
startsWith - An optional substring that must appear at the beginning of matching values. This may be null if matching will be performed using only contains and/or endsWith substrings.
contains - An optional substring that must appear somewhere in matching values. This may be null if matching will be performed using only startsWith and/or endsWith substrings.
endsWith - An optional substring that must appear at the end of matching values. This may be null if matching will be performed using only startsWith and/or contains substrings.

SubstringJSONObjectFilter

public SubstringJSONObjectFilter(java.util.List<java.lang.String> field,
                                 java.lang.String startsWith,
                                 java.util.List<java.lang.String> contains,
                                 java.lang.String endsWith)
Creates a new instance of this filter type with the provided information. At least one startsWith, contains, or endsWith value must be present.

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.
startsWith - An optional substring that must appear at the beginning of matching values. This may be null if matching will be performed using only contains and/or endsWith substrings.
contains - An optional set of substrings that must appear somewhere in matching values. This may be null or empty if matching will be performed using only startsWith and/or endsWith substrings.
endsWith - An optional substring that must appear at the end of matching values. This may be null if matching will be performed using only startsWith and/or contains substrings.
Method Detail

getField

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

getStartsWith

public java.lang.String getStartsWith()
Retrieves the substring that must appear at the beginning of matching values, if defined.

Returns:
The substring that must appear at the beginning of matching values, or null if no "starts with" substring has been defined.

getContains

public java.util.List<java.lang.String> getContains()
Retrieves the list of strings that must appear somewhere in the value (after any defined "starts with" value, and before any defined "ends with" value).

Returns:
The list of strings that must appear somewhere in the value, or an empty list if no "contains" substrings have been defined.

getEndsWith

public java.lang.String getEndsWith()
Retrieves the substring that must appear at the end of matching values, if defined.

Returns:
The substring that must appear at the end of matching values, or null if no "starts with" substring has been defined.

setSubstringComponents

public void setSubstringComponents(java.lang.String startsWith,
                                   java.lang.String contains,
                                   java.lang.String endsWith)
Specifies the substring components that must be present in matching values. At least one startsWith, contains, or endsWith value must be present.

Parameters:
startsWith - An optional substring that must appear at the beginning of matching values. This may be null if matching will be performed using only contains and/or endsWith substrings.
contains - An optional substring that must appear somewhere in matching values. This may be null if matching will be performed using only startsWith and/or endsWith substrings.
endsWith - An optional substring that must appear at the end of matching values. This may be null if matching will be performed using only startsWith and/or contains substrings.

setSubstringComponents

public void setSubstringComponents(java.lang.String startsWith,
                                   java.util.List<java.lang.String> contains,
                                   java.lang.String endsWith)
Specifies the substring components that must be present in matching values. At least one startsWith, contains, or endsWith value must be present.

Parameters:
startsWith - An optional substring that must appear at the beginning of matching values. This may be null if matching will be performed using only contains and/or endsWith substrings.
contains - An optional set of substrings that must appear somewhere in matching values. This may be null or empty if matching will be performed using only startsWith and/or endsWith substrings.
endsWith - An optional substring that must appear at the end of matching values. This may be null if matching will be performed using only startsWith and/or contains substrings.

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

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

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

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(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

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

protected SubstringJSONObjectFilter decodeFilter(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.