org.xmlcml.cml.tools.AmountTool Maven / Gradle / Ivy

Go to download
/**
 *    Copyright 2011 Peter Murray-Rust et. al.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

package org.xmlcml.cml.tools;

import org.apache.log4j.Logger;
import org.xmlcml.cml.base.AbstractTool;
import org.xmlcml.cml.base.CMLConstants.Units;
import org.xmlcml.cml.element.CMLAmount;

/**
 * tool for managing amounts
 *
 * @author pmr
 *
 */
public class AmountTool extends AbstractTool {
	final static Logger LOG = Logger.getLogger(AmountTool.class);

	CMLAmount amount = null;

	/** constructor.
	 */
	public AmountTool(CMLAmount amount) throws RuntimeException {
		init();
		this.amount = amount;
	}


	void init() {
	}


	/**
	 * get amount.
	 *
	 * @return the amount or null
	 */
	public CMLAmount getAmount() {
		return this.amount;
	}

    
	/** gets AmountTool associated with amount.
	 * if null creates one and sets it in amount
	 * @param amount
	 * @return tool
	 */
	public static AmountTool getOrCreateTool(CMLAmount amount) {
		AmountTool amountTool = (amount == null) ? null : (AmountTool) amount.getTool();
		if (amountTool == null) {
			amountTool = new AmountTool(amount);
			amount.setTool(amountTool);
		}
		return amountTool;
	}

	public static CMLAmount createMolarAmount(double mol) {
		CMLAmount amount = new CMLAmount();
		amount.setXMLContent(mol);
		amount.setUnits(Units.MOL.toString());
		return amount;
	}
	

	public static CMLAmount createMilliMolarAmount(double mmol) {
		return createMolarAmount(0.001 * mmol);
	}
};