Added basic code for the units.

5 files changed, 328 insertions, 0 deletions

diff --git a/src/unitConverter/unit/AbstractUnit.java b/src/unitConverter/unit/AbstractUnit.java
new file mode 100644
index 0000000..62c07a2
--- /dev/null
+++ b/src/unitConverter/unit/AbstractUnit.java
@@ -0,0 +1,112 @@
+/**
+ * Copyright (C) 2019 Adrien Hopkins
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+package unitConverter.unit;
+
+import java.util.Objects;
+
+import unitConverter.dimension.UnitDimension;
+
+/**
+ * The default abstract implementation of the {@code Unit} interface.
+ * 
+ * @author Adrien Hopkins
+ * @since 2019-01-25
+ */
+abstract class AbstractUnit implements Unit {
+	/**
+	 * The dimension, or what the unit measures.
+	 * 
+	 * @since 2018-12-22
+	 */
+	private final UnitDimension dimension;
+
+	/**
+	 * The unit's base unit. Values converted by {@code convertFromBase} and {@code convertToBase} are expressed in this
+	 * unit.
+	 * 
+	 * @since 2018-12-22
+	 */
+	private final BaseUnit base;
+
+	/**
+	 * The system that this unit is a part of.
+	 * 
+	 * @since 2018-12-23
+	 */
+	private final UnitSystem system;
+
+	/**
+	 * Creates the {@code AbstractUnit}.
+	 * 
+	 * @param base
+	 *            unit's base
+	 * @throws NullPointerException
+	 *             if name, symbol or base is null
+	 * @since 2018-12-22
+	 */
+	public AbstractUnit(final BaseUnit base) {
+		this.base = Objects.requireNonNull(base, "base must not be null.");
+		this.dimension = this.base.getDimension();
+		this.system = this.base.getSystem();
+	}
+
+	/**
+	 * Creates the {@code AbstractUnit} using a unique dimension. This constructor is for making base units and should
+	 * only be used by {@code BaseUnit}.
+	 * 
+	 * @param dimension
+	 *            dimension measured by unit
+	 * @param system
+	 *            system that unit is a part of
+	 * @throws AssertionError
+	 *             if this constructor is not run by {@code BaseUnit} or a subclass
+	 * @throws NullPointerException
+	 *             if name, symbol or dimension is null
+	 * @since 2018-12-23
+	 */
+	AbstractUnit(final UnitDimension dimension, final UnitSystem system) {
+		// try to set this as a base unit
+		if (this instanceof BaseUnit) {
+			this.base = (BaseUnit) this;
+		} else
+			throw new AssertionError();
+
+		this.dimension = Objects.requireNonNull(dimension, "dimension must not be null.");
+		this.system = Objects.requireNonNull(system, "system must not be null.");
+	}
+
+	@Override
+	public final BaseUnit getBase() {
+		return this.base;
+	}
+
+	@Override
+	public final UnitDimension getDimension() {
+		return this.dimension;
+	}
+
+	@Override
+	public final UnitSystem getSystem() {
+		return this.system;
+	}
+
+	// TODO document and revise units' toString methods
+	@Override
+	public String toString() {
+		return String.format("%s-derived unit of dimension %s", this.getSystem(), this.getDimension());
+	}
+}
diff --git a/src/unitConverter/unit/BaseUnit.java b/src/unitConverter/unit/BaseUnit.java
new file mode 100755
index 0000000..339b7bf
--- /dev/null
+++ b/src/unitConverter/unit/BaseUnit.java
@@ -0,0 +1,69 @@
+/**
+ * Copyright (C) 2018 Adrien Hopkins
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+package unitConverter.unit;
+
+import unitConverter.dimension.UnitDimension;
+
+/**
+ * A unit that is the base for its dimension. It does not have to be for a base dimension, so units like the Newton and
+ * Joule are still base units.
+ * 
+ * @author Adrien Hopkins
+ * @since 2018-12-23
+ */
+public final class BaseUnit extends AbstractUnit {
+	/**
+	 * Is this unit a full base (i.e. m, s, ... but not N, J, ...)
+	 * 
+	 * @since 2019-01-15
+	 */
+	private final boolean isFullBase;
+
+	/**
+	 * Creates the {@code BaseUnit}.
+	 * 
+	 * @param dimension
+	 *            dimension measured by unit
+	 * @param system
+	 *            system that unit is a part of
+	 * @param name
+	 *            name of unit
+	 * @param symbol
+	 *            symbol of unit
+	 * @since 2018-12-23
+	 */
+	BaseUnit(final UnitDimension dimension, final UnitSystem system) {
+		super(dimension, system);
+		this.isFullBase = dimension.isBase();
+	}
+
+	@Override
+	public double convertFromBase(final double value) {
+		return value;
+	}
+
+	@Override
+	public double convertToBase(final double value) {
+		return value;
+	}
+
+	@Override
+	public String toString() {
+		return String.format("%s base unit of%s dimension %s", this.getSystem(), this.isFullBase ? " base" : "",
+				this.getDimension());
+	}
+}
diff --git a/src/unitConverter/unit/LinearUnit.java b/src/unitConverter/unit/LinearUnit.java
new file mode 100644
index 0000000..229710c
--- /dev/null
+++ b/src/unitConverter/unit/LinearUnit.java
@@ -0,0 +1,86 @@
+/**
+ * Copyright (C) 2019 Adrien Hopkins
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+package unitConverter.unit;
+
+import unitConverter.dimension.UnitDimension;
+
+/**
+ * A unit that is equal to a certain number multiplied by its base.
+ * 
+ * @author Adrien Hopkins
+ * @since 2019-01-25
+ */
+public class LinearUnit extends AbstractUnit {
+	/**
+	 * The value of one of this unit in this unit's base unit
+	 * 
+	 * @since 2018-12-22
+	 */
+	private final double conversionFactor;
+
+	/**
+	 * 
+	 * Creates the {@code LinearUnit}.
+	 * 
+	 * @param base
+	 *            unit's base
+	 * @param conversionFactor
+	 *            value of one of this unit in its base
+	 * @since 2018-12-23
+	 */
+	LinearUnit(final BaseUnit base, final double conversionFactor) {
+		super(base);
+		this.conversionFactor = conversionFactor;
+	}
+
+	/**
+	 * Creates the {@code LinearUnit} as a base unit.
+	 * 
+	 * @param dimension
+	 *            dimension measured by unit
+	 * @param system
+	 *            system unit is part of
+	 * @since 2019-01-25
+	 */
+	LinearUnit(final UnitDimension dimension, final UnitSystem system, final double conversionFactor) {
+		super(dimension, system);
+		this.conversionFactor = conversionFactor;
+	}
+
+	@Override
+	public double convertFromBase(final double value) {
+		return value / this.getConversionFactor();
+	}
+
+	@Override
+	public double convertToBase(final double value) {
+		return value * this.getConversionFactor();
+	}
+
+	/**
+	 * @return conversionFactor
+	 * @since 2019-01-25
+	 */
+	public final double getConversionFactor() {
+		return this.conversionFactor;
+	}
+
+	@Override
+	public String toString() {
+		return super.toString() + String.format(" (equal to %s * base)", this.getConversionFactor());
+	}
+}
diff --git a/src/unitConverter/unit/SI.java b/src/unitConverter/unit/SI.java
new file mode 100644
index 0000000..4486bf9
--- /dev/null
+++ b/src/unitConverter/unit/SI.java
@@ -0,0 +1,49 @@
+/**
+ * Copyright (C) 2018 Adrien Hopkins
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+package unitConverter.unit;
+
+import unitConverter.dimension.StandardDimensions;
+import unitConverter.dimension.UnitDimension;
+
+/**
+ * The SI, which holds all SI units
+ * 
+ * @author Adrien Hopkins
+ * @since 2018-12-23
+ */
+public enum SI implements UnitSystem {
+	SI;
+
+	// base units
+	public static final BaseUnit METRE = SI.getBaseUnit(StandardDimensions.LENGTH);
+	public static final BaseUnit KILOGRAM = SI.getBaseUnit(StandardDimensions.MASS);
+	public static final BaseUnit SECOND = SI.getBaseUnit(StandardDimensions.TIME);
+	public static final BaseUnit AMPERE = SI.getBaseUnit(StandardDimensions.ELECTRIC_CURRENT);
+	public static final BaseUnit KELVIN = SI.getBaseUnit(StandardDimensions.TEMPERATURE);
+	public static final BaseUnit MOLE = SI.getBaseUnit(StandardDimensions.QUANTITY);
+	public static final BaseUnit CANDELA = SI.getBaseUnit(StandardDimensions.LUMINOUS_INTENSITY);
+
+	@Override
+	public BaseUnit getBaseUnit(final UnitDimension dimension) {
+		return new BaseUnit(dimension, this);
+	}
+
+	@Override
+	public String getName() {
+		return "SI";
+	}
+}
diff --git a/src/unitConverter/unit/UnitSystem.java b/src/unitConverter/unit/UnitSystem.java
index 2e3a5d8..0a50062 100755
--- a/src/unitConverter/unit/UnitSystem.java
+++ b/src/unitConverter/unit/UnitSystem.java
@@ -16,6 +16,8 @@
  */
 package unitConverter.unit;
 
+import unitConverter.dimension.UnitDimension;
+
 /**
  * A system of units. Each unit should be aware of its system.
  * 
@@ -24,6 +26,16 @@ package unitConverter.unit;
  */
 public interface UnitSystem {
 	/**
+	 * Gets a base unit for this system and the provided dimension.
+	 * 
+	 * @param dimension
+	 *            dimension used by base unit
+	 * @return base unit
+	 * @since 2019-01-25
+	 */
+	BaseUnit getBaseUnit(UnitDimension dimension);
+
+	/**
 	 * @return name of system
 	 * @since 2019-01-25
 	 */