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 *    http://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 java.io.IOException;
024import java.io.Serializable;
025import java.math.BigInteger;
026
027import org.apache.directory.api.i18n.I18n;
028import org.apache.directory.api.ldap.model.schema.LdapComparator;
029import org.apache.directory.api.ldap.model.schema.PrepareString;
030import org.slf4j.Logger;
031import org.slf4j.LoggerFactory;
032
033
034/**
035 * A class for the integerOrderingMatch matchingRule (RFC 4517, par. 4.2.20)
036 * 
037 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
038 */
039public class IntegerComparator extends LdapComparator<Object> implements Serializable
040{
041    /** The serial version UID */
042    private static final long serialVersionUID = 2L;
043
044    /** A logger for this class */
045    private static final Logger LOG = LoggerFactory.getLogger( IntegerComparator.class );
046
047
048    /**
049     * The IntegerComparator constructor. Its OID is the IntegerOrderingMatch matching
050     * rule OID.
051     * 
052     * @param oid The Comparator's OID
053     */
054    public IntegerComparator( String oid )
055    {
056        super( oid );
057    }
058
059
060    /**
061     * {@inheritDoc}
062     */
063    public int compare( Object v1, Object v2 )
064    {
065        if ( v1 instanceof String )
066        {
067            return compare( ( String ) v1, ( String ) v2 );
068        }
069        else
070        {
071            return compare( ( Long ) v1, ( Long ) v2 );
072        }
073    }
074
075
076    /**
077     * Implementation of the Compare method
078     */
079    private int compare( Long backendValue, Long assertValue )
080    {
081        LOG.debug( "comparing Integer objects '{}' with '{}'", backendValue, assertValue );
082
083        // First, shortcut the process by comparing
084        // references. If they are equals, then o1 and o2
085        // reference the same object
086        if ( backendValue == assertValue )
087        {
088            return 0;
089        }
090
091        // Then, deal with one of o1 or o2 being null
092        // Both can't be null, because then they would
093        // have been caught by the previous test
094        if ( ( backendValue == null ) || ( assertValue == null ) )
095        {
096            return ( backendValue == null ? -1 : 1 );
097        }
098
099        return backendValue.compareTo( assertValue );
100    }
101
102
103    /**
104     * Implementation of the Compare method
105     */
106    private int compare( String backendValue, String assertValue )
107    {
108        LOG.debug( "comparing Integer objects '{}' with '{}'", backendValue, assertValue );
109
110        // First, shortcut the process by comparing
111        // references. If they are equals, then o1 and o2
112        // reference the same object
113        if ( backendValue == assertValue )
114        {
115            return 0;
116        }
117
118        // Then, deal with one of o1 or o2 being null
119        // Both can't be null, because then they would
120        // have been caught by the previous test
121        if ( ( backendValue == null ) || ( assertValue == null ) )
122        {
123            return ( backendValue == null ? -1 : 1 );
124        }
125
126        // Both objects must be stored as String for numeric.
127        // But we need to normalize the values first.
128        try
129        {
130            backendValue = PrepareString.normalize( backendValue, PrepareString.StringType.NUMERIC_STRING );
131        }
132        catch ( IOException ioe )
133        {
134            throw new IllegalArgumentException( I18n.err( I18n.ERR_04224, backendValue ), ioe );
135        }
136        try
137        {
138            assertValue = PrepareString.normalize( assertValue, PrepareString.StringType.NUMERIC_STRING );
139        }
140        catch ( IOException ioe )
141        {
142            throw new IllegalArgumentException( I18n.err( I18n.ERR_04224, assertValue ), ioe );
143        }
144
145        BigInteger b1 = new BigInteger( backendValue );
146        BigInteger b2 = new BigInteger( assertValue );
147
148        return b1.compareTo( b2 );
149    }
150}