tec.uom.se.quantity.QuantityDimension Maven / Gradle / Ivy
/*
* Units of Measurement Implementation for Java SE
* Copyright (c) 2005-2018, Jean-Marie Dautelle, Werner Keil, Otavio Santana.
*
* 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.uom.se.quantity;
import tec.uom.se.AbstractUnit;
import tec.uom.se.unit.BaseUnit;
import tec.uom.se.unit.Units;
import javax.measure.Dimension;
import javax.measure.Quantity;
import javax.measure.Unit;
import java.io.Serializable;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
*
* This class represents a quantity dimension (dimension of a physical
* quantity).
*
*
*
* The dimension associated to any given quantity are given by the published
* {@link DimensionService} instances. For convenience, a static method
* {@link QuantityDimension#of(Class) aggregating the results of all
*
* @link DimensionService} instances is provided.
*
*
* QuantityDimension speedDimension
* = QuantityDimension.of(Speed.class);
*
*
*
* @author Jean-Marie Dautelle
* @author Werner Keil
* @version 1.0, $Date: 2016-10-18 $
*/
public final class QuantityDimension implements Dimension, Serializable {
private static final Logger logger = Logger.getLogger(QuantityDimension.class.getName());
/**
*
*/
private static final long serialVersionUID = 123289037718650030L;
/**
* Holds dimensionless.
*
* @since 1.0
*/
public static final Dimension NONE = new QuantityDimension(AbstractUnit.ONE);
/**
* Holds length dimension (L).
*
* @since 1.0
*/
public static final Dimension LENGTH = new QuantityDimension('L');
/**
* Holds mass dimension (M).
*
* @since 1.0
*/
public static final Dimension MASS = new QuantityDimension('M');
/**
* Holds time dimension (T).
*
* @since 1.0
*/
public static final Dimension TIME = new QuantityDimension('T');
/**
* Holds electric current dimension (I).
*
* @since 1.0
*/
public static final Dimension ELECTRIC_CURRENT = new QuantityDimension('I');
/**
* Holds temperature dimension (Θ).
*
* @since 1.0
*/
public static final Dimension TEMPERATURE = new QuantityDimension('\u0398');
/**
* Holds amount of substance dimension (N).
*
* @since 1.0
*/
public static final Dimension AMOUNT_OF_SUBSTANCE = new QuantityDimension('N');
/**
* Holds luminous intensity dimension (J).
*/
public static final Dimension LUMINOUS_INTENSITY = new QuantityDimension('J');
/**
* Holds the pseudo unit associated to this dimension.
*/
private final Unit pseudoUnit;
/**
* Returns the dimension for the specified quantity type by aggregating the results of {@link DimensionService} or null if the
* specified quantity is unknown.
*
* @param quantityType
* the quantity type.
* @return the dimension for the quantity type or null.
* @since 1.0
* @deprecated use of()
*/
public static > Dimension getInstance(Class quantityType) {
return of(quantityType);
}
/**
* Returns the dimension for the specified quantity type by aggregating the results of {@link DimensionService} or null if the
* specified quantity is unknown.
*
* @param quantityType
* the quantity type.
* @return the dimension for the quantity type or null.
* @since 1.0.1
*/
public static > Dimension of(Class quantityType) {
// TODO: Track services and aggregate results (register custom
// types)
Unit siUnit = Units.getInstance().getUnit(quantityType);
if (siUnit == null)
logger.log(Level.FINER, "Quantity type: " + quantityType + " unknown"); // we're
// logging
// but
// probably
// FINER
// is
// enough?
return (siUnit != null) ? siUnit.getDimension() : null;
}
/**
* Returns the dimension for the specified symbol.
*
* @param sambol
* the quantity symbol.
* @return the dimension for the given symbol.
* @since 1.0.1
*/
public static Dimension parse(char symbol) {
return new QuantityDimension(symbol);
}
/**
* Returns the physical dimension having the specified symbol.
*
* @param symbol
* the associated symbol.
*/
@SuppressWarnings("rawtypes")
QuantityDimension(char symbol) {
pseudoUnit = new BaseUnit("[" + symbol + ']', NONE);
}
/**
* Constructor from pseudo-unit (not visible).
*
* @param pseudoUnit
* the pseudo-unit.
*/
private QuantityDimension(Unit pseudoUnit) {
this.pseudoUnit = pseudoUnit;
}
/**
* Returns the product of this dimension with the one specified. If the specified dimension is not a physics dimension, then
* that.multiply(this) is returned.
*
* @param that
* the dimension multiplicand.
* @return this * that
* @since 1.0
*/
public Dimension multiply(Dimension that) {
return (that instanceof QuantityDimension) ? this.multiply((QuantityDimension) that) : this.multiply(that);
}
/**
* Returns the product of this dimension with the one specified.
*
* @param that
* the dimension multiplicand.
* @return this * that
* @since 1.0
*/
public QuantityDimension multiply(QuantityDimension that) {
return new QuantityDimension(this.pseudoUnit.multiply(that.pseudoUnit));
}
/**
* Returns the quotient of this dimension with the one specified.
*
* @param that
* the dimension divisor.
* @return this.multiply(that.pow(-1))
* @since 1.0
*/
public Dimension divide(Dimension that) {
return this.multiply(that.pow(-1));
}
/**
* Returns the quotient of this dimension with the one specified.
*
* @param that
* the dimension divisor.
* @return this.multiply(that.pow(-1))
* @since 1.0
*/
public QuantityDimension divide(QuantityDimension that) {
return this.multiply(that.pow(-1));
}
/**
* Returns this dimension raised to an exponent.
*
* @param n
* the exponent.
* @return the result of raising this dimension to the exponent.
* @since 1.0
*/
public final QuantityDimension pow(int n) {
return new QuantityDimension(this.pseudoUnit.pow(n));
}
/**
* Returns the given root of this dimension.
*
* @param n
* the root's order.
* @return the result of taking the given root of this dimension.
* @throws ArithmeticException
* if n == 0.
* @since 1.0
*/
public final QuantityDimension root(int n) {
return new QuantityDimension(this.pseudoUnit.root(n));
}
/**
* Returns the fundamental (base) dimensions and their exponent whose product is this dimension or null if this dimension is a
* fundamental dimension.
*
* @return the mapping between the base dimensions and their exponent.
* @since 1.0
*/
@SuppressWarnings("rawtypes")
public Map getBaseDimensions() {
Map pseudoUnits = pseudoUnit.getBaseUnits();
if (pseudoUnits == null)
return null;
final Map baseDimensions = new HashMap<>();
for (Map.Entry entry : pseudoUnits.entrySet()) {
baseDimensions.put(new QuantityDimension(entry.getKey()), entry.getValue());
}
return baseDimensions;
}
@Override
public String toString() {
return pseudoUnit.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj instanceof QuantityDimension) {
QuantityDimension other = (QuantityDimension) obj;
return Objects.equals(pseudoUnit, other.pseudoUnit);
}
return false;
}
@Override
public int hashCode() {
return Objects.hashCode(pseudoUnit);
}
}