MatchingRule.java revision 99faa045b6241c1d2843cce1b7a9d9c97055beae
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at
* trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
* add the following below this CDDL HEADER, with the fields enclosed
* by brackets "[]" replaced with your own identifying information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Portions Copyright 2006-2007 Sun Microsystems, Inc.
*/
/**
* This class defines the set of methods and structures that must be
* implemented by a Directory Server module that implements a matching
* rule.
*/
public abstract class MatchingRule
{
/**
* Initializes this matching rule based on the information in the
* provided configuration entry.
*
* @param configEntry The configuration entry that contains the
* information to use to initialize this
* matching rule.
*
* @throws ConfigException If an unrecoverable problem arises in
* the process of performing the
* initialization.
*
* @throws InitializationException If a problem that is not
* configuration-related occurs
* during initialization.
*/
throws ConfigException, InitializationException;
/**
* Retrieves the common name for this matching rule.
*
* @return The common name for this matching rule, or
* <CODE>null</CODE> if it does not have a name.
*/
/**
* Retrieves the OID for this matching rule.
*
* @return The OID for this matching rule.
*/
/**
* Retrieves the name or OID for this matching rule. If it has a
* name, then it will be returned. Otherwise, the OID will be
* returned.
*
* @return The name or OID for this matching rule.
*/
public String getNameOrOID()
{
{
return getOID();
}
else
{
return name;
}
}
/**
* Retrieves the description for this matching rule.
*
* @return The description for this matching rule, or
* <CODE>null</CODE> if there is none.
*/
public abstract String getDescription();
/**
* Retrieves the OID of the syntax with which this matching rule is
* associated.
*
* @return The OID of the syntax with which this matching rule is
* associated.
*/
public abstract String getSyntaxOID();
/**
* Indicates whether this matching rule is declared "OBSOLETE".
* The default implementation will always return <CODE>false</CODE>.
* If that is not acceptable for a particular matching rule
* implementation, then it should override this method and perform
* the appropriate processing to return the correct value.
*
* @return <CODE>true</CODE> if this matching rule is declared
* "OBSOLETE", or <CODE>false</CODE> if not.
*/
public boolean isObsolete()
{
return false;
}
/**
* Retrieves the normalized form of the provided value, which is
* best suite for efficiently performing matching operations on that
* value.
*
* @param value The value to be normalized.
*
* @return The normalized version of the provided value.
*
* @throws DirectoryException If the provided value is invalid
* according to the associated
* attribute syntax.
*/
throws DirectoryException;
/**
* Indicates whether the provided attribute value should be
* considered a match for the given assertion value. This will only
* be used for the purpose of extensible matching. Subclasses
* should define more specific methods that are appropriate to the
* matching rule type.
*
* @param attributeValue The attribute value in a form that has
* been normalized according to this
* matching rule.
* @param assertionValue The assertion value in a form that has
* been normalized according to this
* matching rule.
*
* @return <CODE>TRUE</CODE> if the attribute value should be
* considered a match for the provided assertion value,
* <CODE>FALSE</CODE> if it does not match, or
* <CODE>UNDEFINED</CODE> if the result is undefined.
*/
public abstract ConditionResult
/**
* Retrieves the hash code for this matching rule. It will be
* calculated as the sum of the characters in the OID.
*
* @return The hash code for this matching rule.
*/
public int hashCode()
{
int hashCode = 0;
for (int i=0; i < oidLength; i++)
{
}
return hashCode;
}
/**
* Indicates whether the provided object is equal to this matching
* rule. The provided object will be considered equal to this
* matching rule only if it is a matching rule with the same OID.
*
* @param o The object for which to make the determination.
*
* @return <CODE>true</CODE> if the provided object is equal to
* this matching rule, or <CODE>false</CODE> if it is not.
*/
{
if (o == null)
{
return false;
}
if (this == o)
{
return true;
}
if (! (o instanceof MatchingRule))
{
return false;
}
}
/**
* Retrieves a string representation of this matching rule in the
* format defined in RFC 2252.
*
* @return A string representation of this matching rule in the
* format defined in RFC 2252.
*/
{
}
/**
* Appends a string representation of this matching rule in the
* format defined in RFC 2252 to the provided buffer.
*
* @param buffer The buffer to which the information should be
* appended.
*/
{
{
}
if (isObsolete())
{
}
else
{
}
}
}