AbstractParameter.java

/**
 * Copyright (C) 2008-2010 Daniel Senff
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * 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 General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
package de.danielsenff.imageflow.models.parameter;

import java.util.HashMap;
import java.util.Vector;

/**
 * Parameter is a defined variable in the ImageJ-syntax, which has an expected type
 * @author Daniel Senff
 * @param <T> Class of the value stored in the Parameter
 *
 */
public abstract class AbstractParameter<T> implements Parameter<T> {
	
	/**
	 * Index of the parameter in the Unit.
	 */
	protected int parameterNumber;
	/**
	 * Parameter name that is shown in the unit
	 */
	protected String displayName; 
	/**
	 * Value of this Parameter
	 */
	protected T value;
	/**
	 * Default value of this Parameter
	 */
	protected T defaultValue;
	
	/**
	 * Name of the parameter type
	 */
	protected String paraType;

	/**
	 * help text describing the functionality of this parameter
	 */
	protected String helpString;

	/**
	 * Hide this parameter in the generated parameter forms.
	 */
	protected boolean hidden = false;
	
	/**
	 * Disable this parameter in the generated parameter forms.
	 */
	protected boolean readOnly = false;
	
	/**
	 * HashMap of optional values required for certain functionalities of a Parameter.
	 */
	protected HashMap<String, Object> options;
	
	/**
	 * Registered {@link ParamChangeListener}s
	 */
	protected Vector<ParamChangeListener> changeListener = new Vector<ParamChangeListener>();
	
	/**
	 * @param paraType 
	 * @param displayName 
	 * @param helpString 
	 * @param options
	 */
	public AbstractParameter(String paraType, 
			String displayName, 
			String helpString, 
			HashMap<String, Object> options) {
		this.displayName = displayName;
		this.paraType = paraType;
		this.helpString = helpString;
		this.options = options;
		
	}

	/**
	 * @param parameterNumber
	 */
	public AbstractParameter(final int parameterNumber) {
		this.parameterNumber = parameterNumber;
	}

	public T getValue() {
		return this.value;
	}

	/**
	 * @param value
	 */
	public void setValue(final T value) {
		this.value = value;
		notifyParamChangeListener();
	}
	
	public T getDefaultValue() {
		return this.defaultValue;
	}
	
	//public void onChange();
	
	/**
	 * Returns the name of the Parameter. 
	 * @return
	 */
	public String getDisplayName() {
		return displayName;
	}
	
	public String getParaType() {
		return paraType;
	}
	/**
	 * Get the help description of this Parameter.
	 * @return
	 */
	public String getHelpString() {
		return helpString;
	}

	
	/**
	 * @param parameterNumber
	 */
	public void setParameterNumber(final int parameterNumber) {
		this.parameterNumber = parameterNumber;
	}
	
	public boolean isReadOnly() {
		return this.readOnly;
	}
	
	/**
	 * Set the value of the readOnly-member.
	 * @param value
	 */
	public void setReadOnly(boolean value) {
		this.readOnly = value;
	}
	
	public boolean isHidden() {
		return this.hidden;
	}
	
	/**
	 * Set the value of the hidden-member.
	 * @param value
	 */
	public void setHidden(boolean value) {
		this.hidden = value;
	}
	
	public HashMap<String, Object> getOptions() {
		return this.options;
	}
	
	public void addParamChangeListener(ParamChangeListener listener) {
		changeListener.add(listener);
	}

	public void removeParamChangeListener(ParamChangeListener listener) {
		changeListener.remove(listener);
	}
	
	protected void notifyParamChangeListener() {
		for (int i = 0; i < changeListener.size(); i++) {
			changeListener.get(i).parameterChanged(this);
		}
	}
}