CaseIgnoreOrderingMatchingRule.java revision f71f7a61dec7c9089378d14493ad564a1dedf0b5
/*
* 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 caseIgnoreOrderingMatch matching rule defined in X.520
* and referenced in RFC 2252.
*/
public class CaseIgnoreOrderingMatchingRule
extends OrderingMatchingRule
{
/**
* The serial version identifier required to satisfy the compiler because this
* class implements the <CODE>java.io.Serializable</CODE> interface. This
* value was generated using the <CODE>serialver</CODE> command-line utility
* included with the Java SDK.
*/
private static final long serialVersionUID = -8992263058903266096L;
/**
* Creates a new instance of this caseIgnoreOrderingMatch matching rule.
*/
public CaseIgnoreOrderingMatchingRule()
{
super();
}
/**
* 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.
*/
{
// 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 OMR_CASE_IGNORE_NAME;
}
/**
* Retrieves the OID for this matching rule.
*
* @return The OID for this matching rule.
*/
{
return OMR_CASE_IGNORE_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.
{
{
{
}
}
}
}
/**
* Compares the first value to the second and returns a value that indicates
* their relative order.
*
* @param value1 The normalized form of the first value to compare.
* @param value2 The normalized form of the second value to compare.
*
* @return A negative integer if <CODE>value1</CODE> should come before
* <CODE>value2</CODE> in ascending order, a positive integer if
* <CODE>value1</CODE> should come after <CODE>value2</CODE> in
* ascending order, or zero if there is no difference between the
* values with regard to ordering.
*/
{
}
/**
* Compares the contents of the provided byte arrays to determine their
* relative order.
*
* @param b1 The first byte array to use in the comparison.
* @param b2 The second byte array to use in the comparison.
*
* @return A negative integer if <CODE>b1</CODE> should come before
* <CODE>b2</CODE> in ascending order, a positive integer if
* <CODE>b1</CODE> should come after <CODE>b2</CODE> in ascending
* order, or zero if there is no difference between the values with
* regard to ordering.
*/
{
for (int i=0; i < minLength; i++)
{
{
continue;
}
{
return -1;
}
{
return 1;
}
}
{
return 0;
}
{
return -1;
}
else
{
return 1;
}
}
}