SimpleFormatRawDataColumnInfoSource.java

/**
 * VStar: a statistical analysis tool for variable star data.
 * Copyright (C) 2009  AAVSO (http://www.aavso.org/)
 *
 * 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 <http://www.gnu.org/licenses/>. 
 */
package org.aavso.tools.vstar.ui.model.list;

import java.util.Collection;
import java.util.HashMap;
import java.util.Map;

import org.aavso.tools.vstar.data.ValidObservation;
import org.aavso.tools.vstar.util.locale.LocaleProps;
import org.aavso.tools.vstar.util.prefs.NumericPrecisionPrefs;

/**
 * Simple file format raw data table column information source.
 */
public class SimpleFormatRawDataColumnInfoSource implements
		ITableColumnInfoSource {

	// Table columns.
	private static final int TIME_COLUMN = 0;
	private static final int CALENDAR_DATE_COLUMN = 1;
	private static final int MAGNITUDE_COLUMN = 2;
	private static final int UNCERTAINTY_COLUMN = 3;
	private static final int OBSERVER_CODE_COLUMN = 4;
	private static final int LINE_NUM_COLUMN = 5;
	private static final int DISCREPANT_COLUMN = 6;

	private static final String TIME_COLUMN_NAME = LocaleProps.get("TIME");
	private static final String CALENDAR_DATE_COLUMN_NAME = "Calendar Date";
	private static final String MAGNITUDE_COLUMN_NAME = "Magnitude";
	private static final String UNCERTAINTY_COLUMN_NAME = "Uncertainty";
	private static final String OBSERVER_CODE_COLUMN_NAME = "Observer Code";
	private static final String LINE_NUM_COLUMN_NAME = "Line";
	private static final String DISCREPANT_COLUMN_NAME = "Discrepant?";

	protected static final Map<String, Integer> COLUMN_NAMES = new HashMap<String, Integer>();

	static {
		COLUMN_NAMES.put(TIME_COLUMN_NAME, TIME_COLUMN);
		COLUMN_NAMES.put(CALENDAR_DATE_COLUMN_NAME, CALENDAR_DATE_COLUMN);
		COLUMN_NAMES.put(MAGNITUDE_COLUMN_NAME, MAGNITUDE_COLUMN);
		COLUMN_NAMES.put(UNCERTAINTY_COLUMN_NAME, UNCERTAINTY_COLUMN);
		COLUMN_NAMES.put(OBSERVER_CODE_COLUMN_NAME, OBSERVER_CODE_COLUMN);
		COLUMN_NAMES.put(LINE_NUM_COLUMN_NAME, LINE_NUM_COLUMN);
		COLUMN_NAMES.put(DISCREPANT_COLUMN_NAME, DISCREPANT_COLUMN);
	}

	@Override
	public int getColumnCount() {
		return DISCREPANT_COLUMN + 1;
	}

	@Override
	public Collection<String> getColumnNames() {
		return COLUMN_NAMES.keySet();
	}

	@Override
	public int getDiscrepantColumnIndex() {
		return DISCREPANT_COLUMN;
	}

	@Override
	public String getTableColumnTitle(int index) {
		String columnName = null;

		switch (index) {
		case TIME_COLUMN:
			columnName = TIME_COLUMN_NAME;
			break;
		case CALENDAR_DATE_COLUMN:
			columnName = CALENDAR_DATE_COLUMN_NAME;
			break;
		case MAGNITUDE_COLUMN:
			columnName = MAGNITUDE_COLUMN_NAME;
			break;
		case UNCERTAINTY_COLUMN:
			columnName = UNCERTAINTY_COLUMN_NAME;
			break;
		case OBSERVER_CODE_COLUMN:
			columnName = OBSERVER_CODE_COLUMN_NAME;
			break;
		case LINE_NUM_COLUMN:
			columnName = LINE_NUM_COLUMN_NAME;
			break;
		case DISCREPANT_COLUMN:
			columnName = DISCREPANT_COLUMN_NAME;
			break;
		}

		return columnName;
	}

	@Override
	public Class<?> getTableColumnClass(int index) {
		Class<?> clazz = String.class;

		switch (index) {
		case TIME_COLUMN:
			break;
		case CALENDAR_DATE_COLUMN:
			break;
		case MAGNITUDE_COLUMN:
			break;
		case UNCERTAINTY_COLUMN:
			break;
		case OBSERVER_CODE_COLUMN:
			break;
		case LINE_NUM_COLUMN:
			clazz = Integer.class;
			break;
		case DISCREPANT_COLUMN:
			clazz = Boolean.class;
			break;
		}

		return clazz;
	}

	@Override
	public Object getTableColumnValue(int index, ValidObservation ob) {
		Object value = null;

		switch (index) {
		case TIME_COLUMN:
			value = NumericPrecisionPrefs.formatTime(ob.getDateInfo()
					.getJulianDay());
			break;
		case CALENDAR_DATE_COLUMN:
			value = ob.getDateInfo().getCalendarDate();
			break;
		case MAGNITUDE_COLUMN:
			value = NumericPrecisionPrefs.formatMag(ob.getMagnitude()
					.getMagValue());
			break;
		case UNCERTAINTY_COLUMN:
			value = NumericPrecisionPrefs.formatMag(ob.getMagnitude()
					.getUncertainty());
			break;
		case OBSERVER_CODE_COLUMN:
			value = ob.getObsCode();
			break;
		case LINE_NUM_COLUMN:
			value = ob.getRecordNumber();
			break;
		case DISCREPANT_COLUMN:
			value = ob.isDiscrepant();
			break;
		}

		return value;
	}

	@Override
	public int getColumnIndexByName(String name)
			throws IllegalArgumentException {
		if (name == null || !COLUMN_NAMES.containsKey(name)) {
			throw new IllegalArgumentException("No column name: " + name);
		} else {
			return COLUMN_NAMES.get(name);
		}
	}
}