ExpFormat.java

/*******************************************************************************
 * Mission Control Technologies, Copyright (c) 2009-2012, United States Government
 * as represented by the Administrator of the National Aeronautics and Space 
 * Administration. All rights reserved.
 *
 * The MCT platform is 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.
 *
 * MCT includes source code licensed under additional open source licenses. See 
 * the MCT Open Source Licenses file included with this distribution or the About 
 * MCT Licenses dialog available at runtime from the MCT Help menu for additional 
 * information. 
 *******************************************************************************/
package plotter;

import java.text.FieldPosition;
import java.text.NumberFormat;
import java.text.ParsePosition;

/**
 * Formats 10^x when given x.
 * Takes the logarithm (base 10) of a number when parsing.
 * Useful for log plots.
 * @author Adam Crume
 */
public class ExpFormat extends NumberFormat {
	private static final long serialVersionUID = 1L;

	/** Does the actual formatting. */
	private NumberFormat baseFormat;


	/**
	 * Creates a log format.
	 * @param baseFormat used to do the actual formatting
	 */
	public ExpFormat(NumberFormat baseFormat) {
		this.baseFormat = baseFormat;
	}


	@Override
	public Number parse(String source, ParsePosition parsePosition) {
		return Math.log10(baseFormat.parse(source, parsePosition).doubleValue());
	}


	@Override
	public StringBuffer format(long number, StringBuffer toAppendTo, FieldPosition pos) {
		return baseFormat.format(Math.pow(10, number), toAppendTo, pos);
	}


	@Override
	public StringBuffer format(double number, StringBuffer toAppendTo, FieldPosition pos) {
		return baseFormat.format(Math.pow(10, number), toAppendTo, pos);
	}


	/**
	 * Returns the base format.
	 * @return the base format
	 */
	public NumberFormat getBaseFormat() {
		return baseFormat;
	}
}