ArbitraryFormatPhasePlotColumnInfoSource.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 org.aavso.tools.vstar.data.ValidObservation;
import org.aavso.tools.vstar.util.prefs.NumericPrecisionPrefs;

/**
 * Arbitrary format phase plot table column information source, associated with
 * observation source plugins.
 * 
 * This class exploits the knowledge that its base class's column indices are
 * offset by one compared to its. Yes, this breaks encapsulation but promotes
 * reuse and easier maintainability in a controlled manner.
 */
public class ArbitraryFormatPhasePlotColumnInfoSource extends
		ArbitraryFormatRawDataColumnInfoSource {

	private static final int PHASE_COLUMN = 0;
	private static final String PHASE_COLUMN_NAME = "Phase";
	
	static {
		COLUMN_NAMES.put(PHASE_COLUMN_NAME, PHASE_COLUMN);
	}

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

	@Override
	public int getDiscrepantColumnIndex() {
		return super.getDiscrepantColumnIndex() + 1;
	}

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

		switch (index) {
		case PHASE_COLUMN:
			columnName = PHASE_COLUMN_NAME;
			break;
		default:
			columnName = super.getTableColumnTitle(index - 1);
			break;
		}

		return columnName;
	}

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

		switch (index) {
		case PHASE_COLUMN:
			clazz = String.class;
			break;
		default:
			clazz = super.getTableColumnClass(index - 1);
			break;
		}

		return clazz;
	}

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

		switch (index) {
		case PHASE_COLUMN:
			value = NumericPrecisionPrefs.formatTime(ob.getStandardPhase());
			break;
		default:
			value = super.getTableColumnValue(index - 1, ob);
			break;
		}

		return value;
	}
	
	@Override
	public int getColumnIndexByName(String name) throws IllegalArgumentException {
		if (PHASE_COLUMN_NAME.equals(name)) {
			return COLUMN_NAMES.get(name);
		} else {
			return super.getColumnIndexByName(name)+1;
		}
	}
}