|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.unboundidds.jsonfilter.JSONObjectFilter
com.unboundid.ldap.sdk.unboundidds.jsonfilter.SubstringJSONObjectFilter
@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class SubstringJSONObjectFilter
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.
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
.
startsWith
-- A string that must appear at the beginning of
matching values.
contains
-- A string, or an array of strings, that must appear in
matching values. If this is an array of strings, then a matching value
must contain all of these strings in the order provided in the array.
endsWith
-- A string that must appear at the end of matching
values.
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.
{ "filterType" : "substring", "field" : "accountCreateTime", "startsWith" : "2015" }The above filter can be created with the code:
SubstringJSONObjectFilter filter = new SubstringJSONObjectFilter("accountCreateTime", "2015", null, null);
{ "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);
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 |
---|
public static final java.lang.String FILTER_TYPE
public static final java.lang.String FIELD_FIELD_PATH
public static final java.lang.String FIELD_STARTS_WITH
public static final java.lang.String FIELD_CONTAINS
public static final java.lang.String FIELD_ENDS_WITH
public static final java.lang.String FIELD_CASE_SENSITIVE
Constructor Detail |
---|
public SubstringJSONObjectFilter(java.lang.String field, java.lang.String startsWith, java.lang.String contains, java.lang.String endsWith)
startsWith
, contains
, or endsWith
value must be present.
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.public SubstringJSONObjectFilter(java.util.List<java.lang.String> field, java.lang.String startsWith, java.util.List<java.lang.String> contains, java.lang.String endsWith)
startsWith
, contains
, or endsWith
value must be present.
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 |
---|
public java.util.List<java.lang.String> getField()
public void setField(java.lang.String... field)
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.public void setField(java.util.List<java.lang.String> field)
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.public java.lang.String getStartsWith()
null
if no "starts with" substring has been
defined.public java.util.List<java.lang.String> getContains()
public java.lang.String getEndsWith()
null
if no "starts with" substring has been defined.public void setSubstringComponents(java.lang.String startsWith, java.lang.String contains, java.lang.String endsWith)
startsWith
, contains
, or endsWith
value must be present.
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.public void setSubstringComponents(java.lang.String startsWith, java.util.List<java.lang.String> contains, java.lang.String endsWith)
startsWith
, contains
, or endsWith
value must be present.
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.public boolean caseSensitive()
true
if string matching should be case sensitive, or
false
if not.public void setCaseSensitive(boolean caseSensitive)
caseSensitive
- Indicates whether string matching should be
case sensitive.public java.lang.String getFilterType()
filterType
field for
this filter.
getFilterType
in class JSONObjectFilter
filterType
field for
this filter.protected java.util.Set<java.lang.String> getRequiredFieldNames()
filterType
field)
that must be present in the JSON object representing a filter of this type.
getRequiredFieldNames
in class JSONObjectFilter
filterType
field)
that must be present in the JSON object representing a filter of
this type.protected java.util.Set<java.lang.String> getOptionalFieldNames()
getOptionalFieldNames
in class JSONObjectFilter
public boolean matchesJSONObject(JSONObject o)
matchesJSONObject
in class JSONObjectFilter
o
- The JSON object for which to make the determination.
true
if this JSON object filter matches the provided JSON
object, or false
if not.public JSONObject toJSONObject()
toJSONObject
in class JSONObjectFilter
protected SubstringJSONObjectFilter decodeFilter(JSONObject filterObject) throws JSONException
decodeFilter
in class JSONObjectFilter
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.
JSONException
- If the provided JSON object cannot be decoded as a
valid filter of this type.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |