/*
 * Copyright (C) 2008-2015 by Holger Arndt
 *
 * This file is part of the Java Data Mining Package (JDMP).
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership and licensing.
 *
 * JDMP 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 2
 * of the License, or (at your option) any later version.
 *
 * JDMP 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with JDMP; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA  02110-1301  USA
 */

package org.jdmp.core.algorithm.basic;

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

import org.jdmp.core.algorithm.AbstractAlgorithm;
import org.jdmp.core.variable.Variable;

public class Help extends AbstractAlgorithm {
	private static final long serialVersionUID = 8419287687514349926L;

	public static final String DESCRIPTION = "displays a help message";

	public Help(Variable... variables) {
		super();
		setDescription(DESCRIPTION);
	}

	public Map calculateObjects(Map input) {
		Map result = new HashMap();
		String s = "\n";
		s += "Please visit http://www.jdmp.org/ for more information.\n";
		s += "You can get a list of available commands with 'info'.\n";
		s += "\n";
		result.put(TARGET, s);
		return result;
	}

}