4544 |
25 Sep 08 |
nicklas |
1 |
/** |
4544 |
25 Sep 08 |
nicklas |
$Id$ |
4544 |
25 Sep 08 |
nicklas |
3 |
|
4544 |
25 Sep 08 |
nicklas |
Copyright (C) 2008 Nicklas Nordborg |
4544 |
25 Sep 08 |
nicklas |
5 |
|
4544 |
25 Sep 08 |
nicklas |
This file is part of BASE - BioArray Software Environment. |
4544 |
25 Sep 08 |
nicklas |
Available at http://base.thep.lu.se/ |
4544 |
25 Sep 08 |
nicklas |
8 |
|
4544 |
25 Sep 08 |
nicklas |
BASE is free software; you can redistribute it and/or |
4544 |
25 Sep 08 |
nicklas |
modify it under the terms of the GNU General Public License |
4544 |
25 Sep 08 |
nicklas |
as published by the Free Software Foundation; either version 3 |
4544 |
25 Sep 08 |
nicklas |
of the License, or (at your option) any later version. |
4544 |
25 Sep 08 |
nicklas |
13 |
|
4544 |
25 Sep 08 |
nicklas |
BASE is distributed in the hope that it will be useful, |
4544 |
25 Sep 08 |
nicklas |
but WITHOUT ANY WARRANTY; without even the implied warranty of |
4544 |
25 Sep 08 |
nicklas |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
4544 |
25 Sep 08 |
nicklas |
GNU General Public License for more details. |
4544 |
25 Sep 08 |
nicklas |
18 |
|
4544 |
25 Sep 08 |
nicklas |
You should have received a copy of the GNU General Public License |
4544 |
25 Sep 08 |
nicklas |
along with BASE. If not, see <http://www.gnu.org/licenses/>. |
4544 |
25 Sep 08 |
nicklas |
21 |
*/ |
4544 |
25 Sep 08 |
nicklas |
22 |
package net.sf.basedb.util.units; |
4544 |
25 Sep 08 |
nicklas |
23 |
|
4544 |
25 Sep 08 |
nicklas |
24 |
/** |
4544 |
25 Sep 08 |
nicklas |
Interface for converting values between two units. A unit converter |
4544 |
25 Sep 08 |
nicklas |
implemenation usually has a notion of a <i>specific unit</i> and |
4544 |
25 Sep 08 |
nicklas |
a <i>reference unit</i>, which are the two units the converter can |
4544 |
25 Sep 08 |
nicklas |
convert values from. |
4544 |
25 Sep 08 |
nicklas |
<p> |
4544 |
25 Sep 08 |
nicklas |
If rounding errors and truncation is ignored the following should |
4544 |
25 Sep 08 |
nicklas |
hold for any implementation: |
4544 |
25 Sep 08 |
nicklas |
<code>value == converter.convertFrom(converter.convertTo(value))</code> |
4544 |
25 Sep 08 |
nicklas |
33 |
|
4544 |
25 Sep 08 |
nicklas |
@author Nicklas |
4544 |
25 Sep 08 |
nicklas |
@version 2.9 |
4544 |
25 Sep 08 |
nicklas |
@base.modified $Date$ |
4544 |
25 Sep 08 |
nicklas |
37 |
*/ |
4544 |
25 Sep 08 |
nicklas |
38 |
public interface UnitConverter |
4544 |
25 Sep 08 |
nicklas |
39 |
{ |
4544 |
25 Sep 08 |
nicklas |
40 |
/** |
4544 |
25 Sep 08 |
nicklas |
Convert a value from the specific unit to the reference unit. |
4544 |
25 Sep 08 |
nicklas |
@param specificValue The value to convert |
4544 |
25 Sep 08 |
nicklas |
@return The converted value |
4544 |
25 Sep 08 |
nicklas |
44 |
*/ |
4544 |
25 Sep 08 |
nicklas |
45 |
public double convertToReferenceUnit(double specificValue); |
4544 |
25 Sep 08 |
nicklas |
46 |
|
4544 |
25 Sep 08 |
nicklas |
47 |
/** |
4544 |
25 Sep 08 |
nicklas |
Convert a value from the reference unit to the specific unit. |
4544 |
25 Sep 08 |
nicklas |
@param referenceValue The reference value |
4544 |
25 Sep 08 |
nicklas |
@return The converted value |
4544 |
25 Sep 08 |
nicklas |
51 |
*/ |
4544 |
25 Sep 08 |
nicklas |
52 |
public double convertToSpecificUnit(double referenceValue); |
4544 |
25 Sep 08 |
nicklas |
53 |
|
4544 |
25 Sep 08 |
nicklas |
54 |
|
4544 |
25 Sep 08 |
nicklas |
55 |
} |