This repository has been archived by the owner on Sep 1, 2022. It is now read-only.
/
BaseUnit.java
205 lines (193 loc) · 7.66 KB
/
BaseUnit.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
// $Id: BaseUnit.java 64 2006-07-12 22:30:50Z edavis $
/*
* Copyright 1998-2009 University Corporation for Atmospheric Research/Unidata
*
* Portions of this software were developed by the Unidata Program at the
* University Corporation for Atmospheric Research.
*
* Access and use of this software shall impose the following obligations
* and understandings on the user. The user is granted the right, without
* any fee or cost, to use, copy, modify, alter, enhance and distribute
* this software, and any derivative works thereof, and its supporting
* documentation for any purpose whatsoever, provided that this entire
* notice appears in all copies of the software, derivative works and
* supporting documentation. Further, UCAR requests that the user credit
* UCAR/Unidata in any publications that result from the use of this
* software or in any product that includes this software. The names UCAR
* and/or Unidata, however, may not be used in any advertising or publicity
* to endorse or promote any products or commercial entity unless specific
* written permission is obtained from UCAR/Unidata. The user also
* understands that UCAR/Unidata is not obligated to provide the user with
* any support, consulting, training or assistance of any kind with regard
* to the use, operation and performance of this software nor to provide
* the user with any updates, revisions, new versions or "bug fixes."
*
* THIS SOFTWARE IS PROVIDED BY UCAR/UNIDATA "AS IS" AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL UCAR/UNIDATA BE LIABLE FOR ANY SPECIAL,
* INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
* FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
* NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
* WITH THE ACCESS, USE OR PERFORMANCE OF THIS SOFTWARE.
*/
package ucar.units;
import java.util.SortedMap;
import java.util.TreeMap;
/**
* Provides support for base units.
*
* @author Steven R. Emmerson
* @version $Id: BaseUnit.java 64 2006-07-12 22:30:50Z edavis $
*/
public class BaseUnit extends DerivedUnitImpl implements Base {
private static final long serialVersionUID = 1L;
/**
* The identifier-to-unit map.
*
* @serial
*/
private static final SortedMap<UnitName, BaseUnit> nameMap = new TreeMap<UnitName, BaseUnit>();
/**
* The quantity-to-unit map.
*
* @serial
*/
private static final SortedMap<BaseQuantity, BaseUnit> quantityMap = new TreeMap<BaseQuantity, BaseUnit>();
/**
* The base quantity associated with this base unit.
*
* @serial
*/
private final BaseQuantity baseQuantity;
/**
* Constructs from identifiers and a base quantity.
*
* @param id
* The identifiers for the base unit. <code>
* id.getSymbol()</code>
* shall not return <code>
* null</code>.
* @param baseQuantity
* The base quantity of the base unit.
* @throws NameException
* <code>id.getSymbol()</code> returned <code>
* null</code>.
*/
protected BaseUnit(final UnitName id, final BaseQuantity baseQuantity)
throws NameException {
super(id);
if (id.getSymbol() == null) {
throw new NameException("Base unit must have symbol");
}
setDimension(new UnitDimension(this));
this.baseQuantity = baseQuantity;
}
/**
* Factory method for creating a new BaseUnit or obtaining a
* previously-created one.
*
* @param id
* The identifier for the base unit. <code>
* id.getSymbol()</code>
* shall not return <code>
* null</code>.
* @param baseQuantity
* The base quantity of the base unit.
* @throws NameException
* <code>id.getSymbol()</code> returned <code>
* null</code>.
* @throws UnitExistsException
* Attempt to incompatibly redefine an existing base unit.
*/
public static synchronized BaseUnit getOrCreate(final UnitName id,
final BaseQuantity baseQuantity) throws NameException,
UnitExistsException {
BaseUnit baseUnit;
final BaseUnit nameUnit = nameMap.get(id);
final BaseUnit quantityUnit = quantityMap.get(baseQuantity);
if (nameUnit != null || quantityUnit != null) {
baseUnit = nameUnit != null
? nameUnit
: quantityUnit;
if ((nameUnit != null && !baseQuantity.equals(nameUnit
.getBaseQuantity()))
|| (quantityUnit != null && !id.equals(quantityUnit
.getUnitName()))) {
throw new UnitExistsException(
"Attempt to incompatibly redefine base unit \""
+ baseUnit + '"');
}
}
else {
baseUnit = new BaseUnit(id, baseQuantity);
quantityMap.put(baseQuantity, baseUnit);
nameMap.put(id, baseUnit);
}
return baseUnit;
}
/**
* Returns the base quantity associated with this base unit.
*
* @return The base quantity associated with this base unit.
*/
public final BaseQuantity getBaseQuantity() {
return baseQuantity;
}
/**
* Returns the identifier for this base unit. This is identical to
* <code>getSymbol()</code>.
*
* @return The identifier for this base unit.
*/
public final String getID() {
return getSymbol();
}
/**
* Returns the string representation of this base unit. This is identical to
* <code>getID()</code>.
*
* @return The string representation of this base unit.
*/
@Override
public final String toString() {
return getID();
}
/**
* Indicates if this base unit is dimensionless.
*
* @return <code>true</code> if and only if this base unit is dimensionless
* (e.g. "radian").
*/
@Override
public boolean isDimensionless() {
return baseQuantity.isDimensionless();
}
/**
* Tests this class.
*/
public static void main(final String[] args) throws Exception {
final BaseUnit meter = new BaseUnit(UnitName.newUnitName("meter", null,
"m"), BaseQuantity.LENGTH);
System.out
.println("meter.getBaseQuantity()=" + meter.getBaseQuantity());
System.out
.println("meter.toDerivedUnit(1.)=" + meter.toDerivedUnit(1.));
System.out.println("meter.toDerivedUnit(new float[] {2})[0]="
+ meter.toDerivedUnit(new float[] { 2 }, new float[1])[0]);
System.out.println("meter.fromDerivedUnit(1.)="
+ meter.fromDerivedUnit(1.));
System.out.println("meter.fromDerivedUnit(new float[] {3})[0]="
+ meter.fromDerivedUnit(new float[] { 3 }, new float[1])[0]);
System.out.println("meter.isCompatible(meter)="
+ meter.isCompatible(meter));
final BaseUnit radian = new BaseUnit(UnitName.newUnitName("radian",
null, "rad"), BaseQuantity.PLANE_ANGLE);
System.out.println("meter.isCompatible(radian)="
+ meter.isCompatible(radian));
System.out
.println("meter.isDimensionless()=" + meter.isDimensionless());
System.out.println("radian.isDimensionless()="
+ radian.isDimensionless());
}
}