NumericStringOrderingMatchingRule.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
* trunk/opends/resource/legal-notices/OpenDS.LICENSE
* or https://OpenDS.dev.java.net/OpenDS.LICENSE.
* 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.
*/
package org.opends.server.schema;
import org.opends.server.admin.std.server.OrderingMatchingRuleCfg;
import org.opends.server.api.OrderingMatchingRule;
import org.opends.server.config.ConfigException;
import org.opends.server.core.DirectoryServer;
import org.opends.server.protocols.asn1.ASN1OctetString;
import org.opends.server.types.ByteString;
import org.opends.server.types.DirectoryException;
import org.opends.server.types.ErrorLogCategory;
import org.opends.server.types.ErrorLogSeverity;
import org.opends.server.types.InitializationException;
import org.opends.server.types.ResultCode;
import static org.opends.server.loggers.ErrorLogger.*;
import static org.opends.server.messages.MessageHandler.*;
import static org.opends.server.messages.SchemaMessages.*;
import static org.opends.server.schema.SchemaConstants.*;
import static org.opends.server.util.StaticUtils.*;
/**
* This implements defines the numericStringOrderingMatch matching rule defined
* in X.520 and referenced in RFC 2252.
*/
public class NumericStringOrderingMatchingRule
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 = 388436004219363604L;
/**
* Creates a new instance of this numericStringOrderingMatch matching rule.
*/
public NumericStringOrderingMatchingRule()
{
super();
}
/**
* {@inheritDoc}
*/
public void initializeMatchingRule(OrderingMatchingRuleCfg configuration)
throws ConfigException, InitializationException
{
// 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.
*/
public String getName()
{
return OMR_NUMERIC_STRING_NAME;
}
/**
* Retrieves the OID for this matching rule.
*
* @return The OID for this matching rule.
*/
public String getOID()
{
return OMR_NUMERIC_STRING_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_NUMERIC_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.
*/
public ByteString normalizeValue(ByteString value)
throws DirectoryException
{
String valueString = value.stringValue();
int valueLength = valueString.length();
StringBuilder valueBuffer = new StringBuilder(valueLength);
boolean logged = false;
for (int i=0; i < valueLength; i++)
{
char c = valueString.charAt(i);
if (isDigit(c))
{
valueBuffer.append(c);
}
else if (c != ' ')
{
// This is an illegal character. Either log it or reject it.
int msgID = MSGID_ATTR_SYNTAX_NUMERIC_STRING_ILLEGAL_CHAR;
String message = getMessage(msgID, valueString, c, i);
switch (DirectoryServer.getSyntaxEnforcementPolicy())
{
case REJECT:
throw new DirectoryException(ResultCode.INVALID_ATTRIBUTE_SYNTAX,
message, msgID);
case WARN:
if (! logged)
{
logError(ErrorLogCategory.SCHEMA, ErrorLogSeverity.SEVERE_WARNING,
message, msgID);
logged = true;
}
}
}
}
return new ASN1OctetString(getBytes(valueBuffer.toString()));
}
/**
* 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.
*/
public int compareValues(ByteString value1, ByteString value2)
{
return compare(value1.value(), value2.value());
}
/**
* 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.
*/
public int compare(byte[] b1, byte[] b2)
{
int minLength = Math.min(b1.length, b2.length);
for (int i=0; i < minLength; i++)
{
if (b1[i] == b2[i])
{
continue;
}
else if (b1[i] < b2[i])
{
return -1;
}
else if (b1[i] > b2[i])
{
return 1;
}
}
if (b1.length == b2.length)
{
return 0;
}
else if (b1.length < b2.length)
{
return -1;
}
else
{
return 1;
}
}
}