ParameterFactory.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.ArrayList;
import java.util.HashMap;

/**
 * @author danielsenff
 *
 */
public class ParameterFactory {

	/**
	 * Creates the right UnitElement based on the given parameters.
	 * @param displayName 
	 * @param dataTypeName 
	 * @param value 
	 * @param parameter 
	 * @param helpString 
	 * @return 
	 */
	public static Parameter createParameter(final String displayName, 
			final String dataTypeName,
			final Object value, 
			final String helpString, 
			HashMap<String, Object> options) {
		return createParameter(displayName, dataTypeName, value, helpString, null, options);
	}
	
	/**
	 * Create a new ChoiceParameter.
	 * @param displayName
	 * @param dataTypeName
	 * @param value
	 * @param helpString
	 * @param choiceIndex
	 * @return
	 * @throws IllegalArgumentException
	 */
	public static ChoiceParameter createChoiceParameter(final String displayName, 
			final String dataTypeName,
			final ArrayList<String> value,
			final String helpString, 
			final HashMap<String, Object> options) throws IllegalArgumentException {
		ArrayList<String> values = (ArrayList<String>) value; // bah, what a construct
		return new ChoiceParameter(displayName, values, helpString, options);
	}
	
	public static Parameter createParameter(final String displayName, 
			final String dataTypeName,
			final Object value,
			final String helpString) throws IllegalArgumentException {
		return createParameter(displayName, dataTypeName, value, helpString, new HashMap<String, Object>());
	}
	
	public static Parameter createParameter(final String displayName, 
			final String dataTypeName,
			final Object value,
			final String helpString, 
			final String boolTrueString) throws IllegalArgumentException {
		return createParameter(displayName, dataTypeName, value, helpString, new HashMap<String, Object>());
	}
	
	/**
	 * Creates a {@link Parameter}-Implementation for the Type of the value.
	 * Certain Parameters require additional arguments.
	 * BooleanParameter: String used when condition/value is true.
	 * ChoiceParameter: List of choices
	 * @param displayName
	 * @param dataTypeName 
	 * @param value
	 * @param chosenValue 
	 * @param helpString
	 * @param boolTrueString	This can be any other type that maybe required for certain parameters, like TrueString or chosenValue
	 * @param options Optional options hash
	 * @return
	 * @throws IllegalArgumentException 
	 */
	public static Parameter createParameter(final String displayName, 
			final String dataTypeName,
			final Object value,
			final String helpString, 
			final String boolTrueString,
			HashMap<String, Object> options) throws IllegalArgumentException {
		
		if (options == null)
			options = new HashMap<String, Object>(); 
		
		// see what parameter instance has to be created
		if(value instanceof String) {
			return new StringParameter(displayName, (String) value, helpString, options);
		} else if(value instanceof String && dataTypeName.equalsIgnoreCase("text")) { //TODO use string as text
			return new TextParameter(displayName, (String) value, helpString, options);
		} else if (value instanceof Double ) {
			return new DoubleParameter(displayName, (Double) value, helpString, options);
		} else if (value instanceof Integer) {
			return new IntegerParameter(displayName, (Integer) value, helpString, options);
		} else if (value instanceof Boolean && boolTrueString != null) {
			return new BooleanParameter(displayName, (Boolean) value, boolTrueString, helpString);
		} else if (value instanceof ArrayList) {
			ArrayList<String> values = (ArrayList) value; // bah, what a construct
			return new ChoiceParameter(displayName, values, helpString, options);
			
		} else throw new IllegalArgumentException(
				"Parameter "+value+" of type not recognized or not all required arguments");

	}
	
}