/**
 * Copyright 2010-2013 Jingjing Li.
 *
 * This file is part of jplot2d.
 *
 * jplot2d is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or any later version.
 *
 * jplot2d 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 General Lesser Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with jplot2d. If not, see .
 */
package org.jplot2d.axtype;

import java.util.Locale;
import java.util.TimeZone;

import org.jplot2d.axtick.DateTickAlgorithm;
import org.jplot2d.axtick.TickAlgorithm;
import org.jplot2d.transform.AxisTickTransform;
import org.jplot2d.transform.TransformType;
import org.jplot2d.util.Range;

/**
 * An axis type to present data in Date/Time format. The data is in millisecond, since January 1, 1970, 00:00:00 UTC.
 * 
 * @author Jingjing Li
 * 
 */
public class DateAxisType extends AxisType {

	private static final DateAxisType DEFAULT = new DateAxisType(TimeZone.getDefault(), Locale.getDefault());

	private static final DateAxisType UTC_US = new DateAxisType(TimeZone.getTimeZone("UTC"), Locale.US);

	private static final Range DATE_BOUNDARY = new Range.Long(Long.MIN_VALUE, Long.MAX_VALUE);

	private final DateTickAlgorithm algo;

	/**
	 * Returns a DateAxisType with default zone and local
	 * 
	 * @return
	 */
	public static DateAxisType getDefault() {
		return DEFAULT;
	}

	/**
	 * Returns a DateAxisType with UTC zone and US local
	 * 
	 * @return
	 */
	public static DateAxisType getUTC() {
		return UTC_US;
	}

	public static DateAxisType getInstance(TimeZone zone, Locale aLocale) {
		return new DateAxisType(zone, aLocale);
	}

	private DateAxisType(TimeZone zone, Locale locale) {
		super("DATE-" + zone.getID() + "-" + locale.toString());
		algo = new DateTickAlgorithm(zone, locale);
	}

	@Override
	public boolean canSupport(TransformType txfType) {
		if (txfType == TransformType.LINEAR) {
			return true;
		}
		return false;
	}

	@Override
	public TransformType getDefaultTransformType() {
		return TransformType.LINEAR;
	}

	@Override
	public Range getBoundary(TransformType txfType) {
		return DATE_BOUNDARY;
	}

	@Override
	public Range getDefaultWorldRange(TransformType txfType) {
		long now = System.currentTimeMillis();
		return new Range.Long(now, now + 1);
	}

	@Override
	public TickAlgorithm getTickAlgorithm(TransformType txfType, AxisTickTransform tickTransform) {
		if (tickTransform != null) {
			return null;
		}

		return algo;
	}

}