org.opends.server.schema
Class KeywordEqualityMatchingRule

java.lang.Object
  extended by org.opends.server.api.MatchingRule<EqualityMatchingRuleCfg>
      extended by org.opends.server.api.EqualityMatchingRule
          extended by org.opends.server.schema.WordEqualityMatchingRule
              extended by org.opends.server.schema.KeywordEqualityMatchingRule

public class KeywordEqualityMatchingRule
extends WordEqualityMatchingRule

This class implements the keywordMatch matching rule defined in X.520. That document defines "keyword" as implementation-specific, but in this case we will interpret it in the same way as "word" for the wordMatch rule.


Constructor Summary
KeywordEqualityMatchingRule()
          Creates a new instance of this wordMatch matching rule.
 
Method Summary
 java.lang.String getName()
          Retrieves the common name for this matching rule.
 java.lang.String getOID()
          Retrieves the OID for this matching rule.
 void initializeMatchingRule(EqualityMatchingRuleCfg configuration)
          Initializes this matching rule based on the information in the provided configuration entry.
 
Methods inherited from class org.opends.server.schema.WordEqualityMatchingRule
areEqual, generateHashCode, getDescription, getSyntaxOID, normalizeValue
 
Methods inherited from class org.opends.server.api.EqualityMatchingRule
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

KeywordEqualityMatchingRule

public KeywordEqualityMatchingRule()
Creates a new instance of this wordMatch matching rule.

Method Detail

initializeMatchingRule

public void initializeMatchingRule(EqualityMatchingRuleCfg configuration)
                            throws ConfigException,
                                   InitializationException
Initializes this matching rule based on the information in the provided configuration entry.

Overrides:
initializeMatchingRule in class WordEqualityMatchingRule
Parameters:
configuration - The configuration to use to intialize this matching rule.
Throws:
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.

getName

public java.lang.String getName()
Retrieves the common name for this matching rule.

Overrides:
getName in class WordEqualityMatchingRule
Returns:
The common name for this matching rule, or null if it does not have a name.

getOID

public java.lang.String getOID()
Retrieves the OID for this matching rule.

Overrides:
getOID in class WordEqualityMatchingRule
Returns:
The OID for this matching rule.