|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.matchingrules.MatchingRule
com.unboundid.ldap.matchingrules.SimpleMatchingRule
com.unboundid.ldap.matchingrules.NumericStringMatchingRule
public final class NumericStringMatchingRule
This class provides an implementation of a matching rule that allows strings consisting of numeric digits and spaces. Spaces will be considered insignificant for matching purposes.
Field Summary | |
---|---|
static java.lang.String |
EQUALITY_RULE_NAME
The name for the numericStringMatch equality matching rule. |
static java.lang.String |
EQUALITY_RULE_OID
The OID for the numericStringMatch equality matching rule. |
static java.lang.String |
ORDERING_RULE_NAME
The name for the numericStringOrderingMatch ordering matching rule. |
static java.lang.String |
ORDERING_RULE_OID
The OID for the numericStringOrderingMatch ordering matching rule. |
static java.lang.String |
SUBSTRING_RULE_NAME
The name for the numericStringSubstringsMatch substring matching rule. |
static java.lang.String |
SUBSTRING_RULE_OID
The OID for the numericStringSubstringsMatch substring matching rule. |
Fields inherited from class com.unboundid.ldap.matchingrules.MatchingRule |
---|
SUBSTRING_TYPE_SUBANY, SUBSTRING_TYPE_SUBFINAL, SUBSTRING_TYPE_SUBINITIAL |
Constructor Summary | |
---|---|
NumericStringMatchingRule()
Creates a new instance of this numeric string matching rule. |
Method Summary | |
---|---|
java.lang.String |
getEqualityMatchingRuleName()
Retrieves the name for this matching rule when used to perform equality matching, if appropriate. |
java.lang.String |
getEqualityMatchingRuleOID()
Retrieves the OID for this matching rule when used to perform equality matching, if appropriate. |
static NumericStringMatchingRule |
getInstance()
Retrieves a singleton instance of this matching rule. |
java.lang.String |
getOrderingMatchingRuleName()
Retrieves the name for this matching rule when used to perform ordering matching, if appropriate. |
java.lang.String |
getOrderingMatchingRuleOID()
Retrieves the OID for this matching rule when used to perform ordering matching, if appropriate. |
java.lang.String |
getSubstringMatchingRuleName()
Retrieves the name for this matching rule when used to perform substring matching, if appropriate. |
java.lang.String |
getSubstringMatchingRuleOID()
Retrieves the OID for this matching rule when used to perform substring matching, if appropriate. |
ASN1OctetString |
normalize(ASN1OctetString value)
Normalizes the provided value for easier matching. |
ASN1OctetString |
normalizeSubstring(ASN1OctetString value,
byte substringType)
Normalizes the provided value for use as part of a substring assertion. |
Methods inherited from class com.unboundid.ldap.matchingrules.SimpleMatchingRule |
---|
compareValues, matchesSubstring, valuesMatch |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String EQUALITY_RULE_NAME
public static final java.lang.String EQUALITY_RULE_OID
public static final java.lang.String ORDERING_RULE_NAME
public static final java.lang.String ORDERING_RULE_OID
public static final java.lang.String SUBSTRING_RULE_NAME
public static final java.lang.String SUBSTRING_RULE_OID
Constructor Detail |
---|
public NumericStringMatchingRule()
Method Detail |
---|
public static NumericStringMatchingRule getInstance()
public java.lang.String getEqualityMatchingRuleName()
getEqualityMatchingRuleName
in class MatchingRule
null
if this matching rule is not intended
to be used for equality matching.public java.lang.String getEqualityMatchingRuleOID()
getEqualityMatchingRuleOID
in class MatchingRule
null
if this matching rule is not intended
to be used for equality matching.public java.lang.String getOrderingMatchingRuleName()
getOrderingMatchingRuleName
in class MatchingRule
null
if this matching rule is not intended
to be used for ordering matching.public java.lang.String getOrderingMatchingRuleOID()
getOrderingMatchingRuleOID
in class MatchingRule
null
if this matching rule is not intended
to be used for ordering matching.public java.lang.String getSubstringMatchingRuleName()
getSubstringMatchingRuleName
in class MatchingRule
null
if this matching rule is not intended
to be used for substring matching.public java.lang.String getSubstringMatchingRuleOID()
getSubstringMatchingRuleOID
in class MatchingRule
null
if this matching rule is not intended
to be used for substring matching.public ASN1OctetString normalize(ASN1OctetString value) throws LDAPException
normalize
in class MatchingRule
value
- The value to be normalized.
LDAPException
- If a problem occurs while normalizing the provided
value.public ASN1OctetString normalizeSubstring(ASN1OctetString value, byte substringType) throws LDAPException
normalizeSubstring
in class MatchingRule
value
- The value to be normalized for use as part of a
substring assertion.substringType
- The substring assertion component type for the
provided value. It should be one of
SUBSTRING_TYPE_SUBINITIAL
,
SUBSTRING_TYPE_SUBANY
, or
SUBSTRING_TYPE_SUBFINAL
.
LDAPException
- If a problem occurs while normalizing the provided
value.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |