WordEqualityMatchingRule.java revision 00870f7dc92907ec0b59c43b783cde7367071ff0
/*
* 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 implements the wordMatch matching rule defined in X.520. That
* document defines "word" as implementation-specific, but in this case we will
* consider it a match if the assertion value is contained within the attribute
* value and is bounded by the edge of the value or any of the following
* characters:
* <BR>
* <UL>
* <LI>A space</LI>
* <LI>A period</LI>
* <LI>A comma</LI>
* <LI>A slash</LI>
* <LI>A dollar sign</LI>
* <LI>A plus sign</LI>
* <LI>A dash</LI>
* <LI>An underscore</LI>
* <LI>An octothorpe</LI>
* <LI>An equal sign</LI>
* </UL>
*/
public class WordEqualityMatchingRule
extends EqualityMatchingRule
{
/**
* Creates a new instance of this wordMatch matching rule.
*/
public WordEqualityMatchingRule()
{
super();
}
/**
* {@inheritDoc}
*/
{
// No initialization is required.
}
/**
* 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.
*/
{
return EMR_WORD_NAME;
}
/**
* Retrieves the OID for this matching rule.
*
* @return The OID for this matching rule.
*/
{
return EMR_WORD_OID;
}
/**
* Retrieves the description for this matching rule.
*
* @return The description for this matching rule, or <CODE>null</CODE> if
* there is none.
*/
public String getDescription()
{
// There is no standard description for this matching rule.
return null;
}
/**
* 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 String getSyntaxOID()
{
return SYNTAX_DIRECTORY_STRING_OID;
}
/**
* Retrieves the normalized form of the provided value, which is best suited
* 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
{
if (bufferLength == 0)
{
{
// This should only happen if the value is composed entirely of spaces.
// In that case, the normalized value is a single space.
return new ASN1OctetString(" ");
}
else
{
// The value is empty, so it is already normalized.
return new ASN1OctetString();
}
}
// Replace any consecutive spaces with a single space.
{
{
{
}
}
}
}
/**
* Indicates whether the two provided normalized values are equal to each
* other.
*
* @param value1 The normalized form of the first value to compare.
* @param value2 The normalized form of the second value to compare.
*
* @return <CODE>true</CODE> if the provided values are equal, or
* <CODE>false</CODE> if not.
*/
{
// For this purpose, the first value will be considered the attribute value,
// and the second the assertion value. See if the second value is contained
// in the first. If not, then it isn't a match.
if (pos < 0)
{
return false;
}
if (pos > 0)
{
switch (c)
{
case ' ':
case '.':
case ',':
case '/':
case '$':
case '+':
case '-':
case '_':
case '#':
case '=':
// These are all acceptable.
break;
default:
// Anything else is not.
return false;
}
}
{
switch (c)
{
case ' ':
case '.':
case ',':
case '/':
case '$':
case '+':
case '-':
case '_':
case '#':
case '=':
// These are all acceptable.
break;
default:
// Anything else is not.
return false;
}
}
// If we've gotten here, then we can assume it is a match.
return true;
}
/**
* Generates a hash code for the provided attribute value. This version of
* the method will simply create a hash code from the normalized form of the
* attribute value. For matching rules explicitly designed to work in cases
* where byte-for-byte comparisons of normalized values is not sufficient for
* determining equality (e.g., if the associated attribute syntax is based on
* hashed or encrypted values), then this method must be overridden to provide
* an appropriate implementation for that case.
*
* @param attributeValue The attribute value for which to generate the hash
* code.
*
* @return The hash code generated for the provided attribute value.*/
{
// In this case, we'll always return the same value because the matching
// isn't based on the entire value.
return 1;
}
}