tec.units.ri.AbstractSystemOfUnits Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of unit-ri Show documentation
Show all versions of unit-ri Show documentation
Unit Standard (JSR 363) Reference Implementation.
/*
* Unit-API - Units of Measurement API for Java
* Copyright (c) 2005-2015, Jean-Marie Dautelle, Werner Keil, V2COM.
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
*
* 3. Neither the name of JSR-363 nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package tec.units.ri;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import javax.measure.Dimension;
import javax.measure.Quantity;
import javax.measure.Unit;
import javax.measure.spi.SystemOfUnits;
/**
* An abstract base class for unit systems.
*
* @author Werner Keil
* @version 2.3, $Date: 2015-07-11 $
*/
public abstract class AbstractSystemOfUnits implements SystemOfUnits {
/**
* Holds the units.
*/
protected final Set> units = new HashSet>();
/**
* Holds the mapping quantity to unit.
*/
@SuppressWarnings("rawtypes")
protected final Map, Unit>
quantityToUnit = new HashMap, Unit>();
/**
* The natural logarithm.
**/
protected static final double E = 2.71828182845904523536028747135266;
/*
* (non-Javadoc)
*
* @see SystemOfUnits#getName()
*/
public abstract String getName();
// ///////////////////
// Collection View //
// ///////////////////
@Override
public Set> getUnits() {
return Collections.unmodifiableSet(units);
}
@Override
public Set> getUnits(Dimension dimension) {
final Set> set = new HashSet>();
for (Unit unit : this.getUnits()) {
if (dimension.equals(unit.getDimension())) {
set.add(unit);
}
}
return set;
}
@SuppressWarnings("unchecked")
@Override
public > Unit getUnit(Class quantityType) {
return quantityToUnit.get(quantityType);
}
/**
* Adds a new named unit to the collection.
*
* @param unit the unit being added.
* @param name the name of the unit.
* @param name the symbol of the unit.
* @return unit.
*/
@SuppressWarnings("unchecked")
protected > U addUnit(U unit, String name, String symbol) {
if (name != null && symbol!= null && unit instanceof AbstractUnit) {
AbstractUnit aUnit = (AbstractUnit)unit;
aUnit.setName(name);
aUnit.setSymbol(symbol);
units.add(aUnit);
return (U) aUnit;
}
if (name != null && unit instanceof AbstractUnit) {
AbstractUnit aUnit = (AbstractUnit)unit;
aUnit.setName(name);
units.add(aUnit);
return (U) aUnit;
}
units.add(unit);
return unit;
}
/**
* Adds a new named unit to the collection.
*
* @param unit the unit being added.
* @param name the name of the unit.
* @return unit.
*/
@SuppressWarnings("unchecked")
protected > U addUnit(U unit, String name) {
if (name != null && unit instanceof AbstractUnit) {
AbstractUnit aUnit = (AbstractUnit)unit;
aUnit.setName(name);
units.add(aUnit);
return (U) aUnit;
}
units.add(unit);
return unit;
}
protected static class Helper {
static Set> getUnitsOfDimension(final Set> units,
Dimension dimension) {
if (dimension != null) {
Set>dimSet = new HashSet>();
for (Unit u : units) {
if (dimension.equals(u.getDimension())) {
dimSet.add(u);
}
}
return dimSet;
}
return null;
}
/**
* Adds a new named unit to the collection.
*
* @param unit the unit being added.
* @param name the name of the unit.
* @return unit.
*/
@SuppressWarnings("unchecked")
public static > U addUnit(Set> units, U unit, String name) {
if (name != null && unit instanceof AbstractUnit) {
AbstractUnit aUnit = (AbstractUnit)unit;
aUnit.setName(name);
units.add(aUnit);
return (U) aUnit;
}
units.add(unit);
return unit;
}
/**
* Adds a new named unit to the collection.
*
* @param unit the unit being added.
* @param name the name of the unit.
* @param name the symbol of the unit.
* @return unit.
*/
@SuppressWarnings("unchecked")
public static > U addUnit(Set> units, U unit, String name, String symbol) {
if (name != null && symbol!= null && unit instanceof AbstractUnit) {
AbstractUnit aUnit = (AbstractUnit)unit;
aUnit.setName(name);
aUnit.setSymbol(symbol);
units.add(aUnit);
return (U) aUnit;
}
if (name != null && unit instanceof AbstractUnit) {
AbstractUnit aUnit = (AbstractUnit)unit;
aUnit.setName(name);
units.add(aUnit);
return (U) aUnit;
}
units.add(unit);
return unit;
}
}
}