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.DeepTrimNormalizer;
027import org.slf4j.Logger;
028import org.slf4j.LoggerFactory;
029
030
031/**
032 * A comparator that uses the DeepTrimNormalizer before comparing two values
033 * 
034 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
035 */
036public class DeepTrimComparator 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( DeepTrimComparator.class );
043    
044    /**
045     * The NormalizingComparator constructor. Its OID is the  matching rule OID.
046     * 
047     * @param oid The Comparator's OID
048     */
049    public DeepTrimComparator( String oid )
050    {
051        super( oid );
052        normalizer = new DeepTrimNormalizer();
053    }
054
055
056    /**
057     * {@inheritDoc}
058     */
059    public int compare( String o1, String o2 )
060    {
061        String n1 = o1;
062        String n2;
063
064        try
065        {
066            n1 = normalizer.normalize( o1 );
067        }
068        catch ( LdapException e )
069        {
070            if ( LOG.isWarnEnabled() )
071            {
072                LOG.warn( I18n.msg( I18n.MSG_13700_FAILED_TO_NORMALIZE, o1 ), e );
073            }
074            
075            n1 = o1;
076        }
077
078        try
079        {
080            n2 = normalizer.normalize( o2 );
081        }
082        catch ( LdapException e )
083        {
084            if ( LOG.isWarnEnabled() )
085            {
086                LOG.warn( I18n.msg( I18n.MSG_13700_FAILED_TO_NORMALIZE, o2 ), e );
087            }
088            
089            n2 = o2;
090        }
091
092        return n1.compareTo( n2 );
093    }
094}