|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.api.MatchingRule<SubstringMatchingRuleCfg>
org.opends.server.api.SubstringMatchingRule
org.opends.server.schema.CaseIgnoreListSubstringMatchingRule
public class CaseIgnoreListSubstringMatchingRule
This class implements the caseIgnoreListSubstringsMatch matching rule defined in X.520 and referenced in RFC 2252.
Constructor Summary | |
---|---|
CaseIgnoreListSubstringMatchingRule()
Creates a new instance of this caseIgnoreSubstringsMatch matching rule. |
Method Summary | |
---|---|
java.lang.String |
getDescription()
Retrieves the description for this matching rule. |
java.lang.String |
getName()
Retrieves the common name for this matching rule. |
java.lang.String |
getOID()
Retrieves the OID for this matching rule. |
java.lang.String |
getSyntaxOID()
Retrieves the OID of the syntax with which this matching rule is associated. |
void |
initializeMatchingRule(SubstringMatchingRuleCfg configuration)
Initializes this matching rule based on the information in the provided configuration entry. |
ByteString |
normalizeSubstring(ByteString substring)
Normalizes the provided value fragment into a form that can be used to efficiently compare values. |
ByteString |
normalizeValue(ByteString value)
Retrieves the normalized form of the provided value, which is best suited for efficiently performing matching operations on that value. |
boolean |
valueMatchesSubstring(ByteString value,
ByteString subInitial,
java.util.List<ByteString> subAnyElements,
ByteString subFinal)
Determines whether the provided value matches the given substring filter components. |
Methods inherited from class org.opends.server.api.SubstringMatchingRule |
---|
valuesMatch |
Methods inherited from class org.opends.server.api.MatchingRule |
---|
equals, finalizeMatchingRule, getNameOrOID, hashCode, isConfigurationAcceptable, isObsolete, toString, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public CaseIgnoreListSubstringMatchingRule()
Method Detail |
---|
public void initializeMatchingRule(SubstringMatchingRuleCfg configuration) throws ConfigException, InitializationException
initializeMatchingRule
in class MatchingRule<SubstringMatchingRuleCfg>
configuration
- The configuration to use to intialize this
matching rule.
ConfigException
- If an unrecoverable problem arises in
the process of performing the
initialization.
InitializationException
- If a problem that is not
configuration-related occurs
during initialization.public java.lang.String getName()
getName
in class MatchingRule<SubstringMatchingRuleCfg>
null
if
it does not have a name.public java.lang.String getOID()
getOID
in class MatchingRule<SubstringMatchingRuleCfg>
public java.lang.String getDescription()
getDescription
in class MatchingRule<SubstringMatchingRuleCfg>
null
if
there is none.public java.lang.String getSyntaxOID()
getSyntaxOID
in class MatchingRule<SubstringMatchingRuleCfg>
public ByteString normalizeValue(ByteString value) throws DirectoryException
normalizeValue
in class MatchingRule<SubstringMatchingRuleCfg>
value
- The value to be normalized.
DirectoryException
- If the provided value is invalid according to
the associated attribute syntax.public ByteString normalizeSubstring(ByteString substring) throws DirectoryException
normalizeSubstring
in class SubstringMatchingRule
substring
- The value fragment to be normalized.
DirectoryException
- If the provided value fragment is not
acceptable according to the associated syntax.public boolean valueMatchesSubstring(ByteString value, ByteString subInitial, java.util.List<ByteString> subAnyElements, ByteString subFinal)
null
but at least one of them must be non-null
.
valueMatchesSubstring
in class SubstringMatchingRule
value
- The normalized value against which to compare the
substring components.subInitial
- The normalized substring value fragment that should
appear at the beginning of the target value.subAnyElements
- The normalized substring value fragments that
should appear in the middle of the target value.subFinal
- The normalized substring value fragment that should
appear at the end of the target value.
true
if the provided value does match the given
substring components, or false
if not.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |