001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *  
010 *    https://www.apache.org/licenses/LICENSE-2.0
011 *  
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License. 
018 *  
019 */
020package org.apache.directory.api.ldap.model.schema.comparators;
021
022
023import org.apache.directory.api.i18n.I18n;
024import org.apache.directory.api.ldap.model.exception.LdapException;
025import org.apache.directory.api.ldap.model.schema.LdapComparator;
026import org.apache.directory.api.ldap.model.schema.normalizers.DeepTrimToLowerNormalizer;
027import org.slf4j.Logger;
028import org.slf4j.LoggerFactory;
029
030
031/**
032 * A comparator that uses the DeepTrimToLowerNormalizer before comparing two values
033 * 
034 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
035 */
036public class DeepTrimToLowerComparator extends LdapComparator<String>
037{
038    /** The serial version UID */
039    private static final long serialVersionUID = 2L;
040
041    /** A logger for this class */
042    private static final Logger LOG = LoggerFactory.getLogger( DeepTrimToLowerComparator.class );
043
044
045    /**
046     * The NormalizingComparator constructor. Its OID is the  matching rule OID.
047     * 
048     * @param oid The Comparator's OID
049     */
050    public DeepTrimToLowerComparator( String oid )
051    {
052        super( oid );
053        normalizer = new DeepTrimToLowerNormalizer();
054    }
055
056
057    /**
058     * {@inheritDoc}
059     */
060    public int compare( String key, String value )
061    {
062        String normalizedValue;
063
064        try
065        {
066            normalizedValue = normalizer.normalize( value );
067        }
068        catch ( LdapException e )
069        {
070            if ( LOG.isWarnEnabled() )
071            {
072                LOG.warn( I18n.msg( I18n.MSG_13700_FAILED_TO_NORMALIZE, value ), e );
073            }
074            
075            normalizedValue = value;
076        }
077
078        return key.compareTo( normalizedValue );
079    }
080}