Package com.unboundid.directory.sdk.common.schema

Interface SubstringMatchingRule

All Superinterfaces:

MatchingRule

@NotExtensible
@ThreadSafety(level=INTERFACE_THREADSAFE)
public interface SubstringMatchingRule
extends MatchingRule

This interface provides an API for interacting with substring matching rules, which can be used to determine whether a given value matches a provided substring assertion.

Method Summary

Modifier and Type	Method	Description
ByteString	normalizeSubstring(AttributeType type, ByteString substring)	Normalizes the provided value fragment into a form that can be used to efficiently compare it in a substring assertion.
ByteString	normalizeSubstring(ByteString substring)	Normalizes the provided value fragment into a form that can be used to efficiently compare it in a substring assertion.
boolean	valueMatchesSubstring(ByteString normValue, ByteString normSubInitial, java.util.List<ByteString> normSubAny, ByteString normSubFinal)	Indicates whether the provided value matches the given substring assertion.

Methods inherited from interface com.unboundid.directory.sdk.common.schema.MatchingRule

equals, getDescription, getName, getNameOrOID, getOID, getSyntaxOID, hashCode, hasNameOrOID, isObsolete, normalizeValue, normalizeValue, toString, valuesMatch

Method Detail

normalizeSubstring

ByteString normalizeSubstring(ByteString substring)
                       throws LDAPException

Normalizes the provided value fragment into a form that can be used to efficiently compare it in a substring assertion.

Parameters:

substring - The substring value to be normalized.

Returns:

The normalized form of the provided substring.

Throws:

LDAPException - If a problem is encountered while attempting to normalize the provided substring.

normalizeSubstring

ByteString normalizeSubstring(AttributeType type,
                              ByteString substring)
                       throws LDAPException

Normalizes the provided value fragment into a form that can be used to efficiently compare it in a substring assertion.

Parameters:

type - The associated attribute type.

substring - The substring value to be normalized.

Returns:

The normalized form of the provided substring.

Throws:

LDAPException - If a problem is encountered while attempting to normalize the provided substring.

valueMatchesSubstring

boolean valueMatchesSubstring(ByteString normValue,
                              ByteString normSubInitial,
                              java.util.List<ByteString> normSubAny,
                              ByteString normSubFinal)

Indicates whether the provided value matches the given substring assertion.

Parameters:

normValue - The normalized form of the value to be compared.

normSubInitial - The normalized form of the subInitial element for the substring assertion. It may be null if there is no subInitial element.

normSubAny - The normalized forms of the subAny elements for the substring assertion. It may be empty or null if there is no subInitial element.

normSubFinal - The normalized form of the subFinal element for the substring assertion. It may be null if there is no subFinal element.

Returns:

true if the provided value matches the given substring assertion, or false if not.