/*
  File: FlatInterpolator.java

  Copyright (c) 2006, The Cytoscape Consortium (www.cytoscape.org)

  The Cytoscape Consortium is:
  - Institute for Systems Biology
  - University of California San Diego
  - Memorial Sloan-Kettering Cancer Center
  - Institut Pasteur
  - Agilent Technologies

  This library is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published
  by the Free Software Foundation; either version 2.1 of the License, or
  any later version.

  This library is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY, WITHOUT EVEN THE IMPLIED WARRANTY OF
  MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  The software and
  documentation provided hereunder is on an "as is" basis, and the
  Institute for Systems Biology and the Whitehead Institute
  have no obligations to provide maintenance, support,
  updates, enhancements or modifications.  In no event shall the
  Institute for Systems Biology and the Whitehead Institute
  be liable to any party for direct, indirect, special,
  incidental or consequential damages, including lost profits, arising
  out of the use of this software and its documentation, even if the
  Institute for Systems Biology and the Whitehead Institute
  have been advised of the possibility of such damage.  See
  the GNU Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with this library; if not, write to the Free Software Foundation,
  Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
*/

//FlatInterpolator.java

//----------------------------------------------------------------------------
// $Revision: 10005 $
// $Date: 2007-04-17 21:50:13 -0500 (Tue, 17 Apr 2007) $
// $Author: kono $
//----------------------------------------------------------------------------
package cytoscape.visual.mappings;


//----------------------------------------------------------------------------
/**
 * This simple Interpolator returns the value at either the lower or upper
 * boundary of the domain. Note that no check is made whether the supplied
 * domainValue is actually within the boundaries.
 */
public class FlatInterpolator
    implements Interpolator {
    /**
     *
     */
    public static final Integer LOWER = new Integer(0);

    /**
     *
     */
    public static final Integer UPPER = new Integer(1);
    private boolean useLower;

    /**
     * The default FlatInterpolator returns the range value at the lower boundary.
     */
    public FlatInterpolator() {
        useLower = true;
    }

    /**
     * Constructs a FlatInterpolator which returns the range value at the lower
     * boundary unless the argument 'mode' is equal to FlatInterpolator.UPPER.
     */
    public FlatInterpolator(Integer mode) {
        if (mode.equals(this.UPPER))
            useLower = false;
        else
            useLower = true;
    }

    /**
     *  DOCUMENT ME!
     *
     * @param lowerDomain DOCUMENT ME!
     * @param lowerRange DOCUMENT ME!
     * @param upperDomain DOCUMENT ME!
     * @param upperRange DOCUMENT ME!
     * @param domainValue DOCUMENT ME!
     *
     * @return  DOCUMENT ME!
     */
    public Object getRangeValue(Object lowerDomain, Object lowerRange,
        Object upperDomain, Object upperRange, Object domainValue) {
        return ((useLower) ? lowerRange : upperRange);
    }
}