clusterer.java

著名的开源仿真软件yale

/*
 *  YALE - Yet Another Learning Environment
 *  Copyright (C) 2002, 2003
 *      Simon Fischer, Ralf Klinkenberg, Ingo Mierswa, 
 *          Katharina Morik, Oliver Ritthoff
 *      Artificial Intelligence Unit
 *      Computer Science Department
 *      University of Dortmund
 *      44221 Dortmund,  Germany
 *  email: [e-mail]
 *  web:   http://yale.cs.uni-dortmund.de/
 *
 *  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 edu.udo.cs.yale.operator.clusterer;

import edu.udo.cs.yale.operator.parameter.*;
import edu.udo.cs.yale.operator.learner.Model;
import edu.udo.cs.yale.operator.Operator;
import edu.udo.cs.yale.operator.FatalException;
import edu.udo.cs.yale.operator.OperatorException;
import edu.udo.cs.yale.operator.IOObject;
import edu.udo.cs.yale.example.ExampleSet;
import edu.udo.cs.yale.tools.LogService;

import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

/** 
 *  <h4>Parameters:</h4>
 *  <ul>
 *    <li><b>[cluster_file]</b> If this value is set the model is saved to a file and can be used in 
 *                            another experiment using a <code>ModelLoader</code></li>
 *  </ul>
 *
 *  <h4>Operator-Input</h4>
 *  <ol>
 *    <li><tt>ExampleSet</tt></li> the example set
 *  </ol>
 *  <h4>Operator-Output</h4>
 *  <ol>
 *    <li><tt>ExampleSet</tt></li> the clustered example set
 *    <li><tt>Model</tt></li> the cluster model
 *  </ol>
 *
 *  @see edu.udo.cs.yale.operator.ModelLoader
 *  @author Ingo, Simon
 *  @version $Id: Clusterer.java,v 2.2 2003/04/04 11:59:28 fischer Exp $
 */
public abstract class Clusterer extends Operator {

    private static final Class[] INPUT_CLASSES = { ExampleSet.class };
    private static final Class[] OUTPUT_CLASSES = { ExampleSet.class, Model.class };

    private String modelFile;

    public void initApply() throws OperatorException {
	super.initApply();
	modelFile = getParameterAsString("cluster_file");
    }

    /** This method generates a cluster model. */
    public abstract Model cluster(ExampleSet exampleSet) throws OperatorException;

    /** Generates a cluster model for a given example set.
     *  The model is saved as <tt>cluster_file</tt> if the parameter is set.
     */
    public IOObject[] apply() throws OperatorException {
	ExampleSet exampleSet = (ExampleSet)getInput(ExampleSet.class);

	if (exampleSet==null) {
	    throw new FatalException("Clusterer '"+getName()+"': No input example set!");
	}

	if (exampleSet.getNumberOfAttributes()==0) {
	   throw new FatalException("Clusterer '"+getName()+"': Input example set has no attributes");
	}

	Model model = cluster(exampleSet);

	try {
	    if (modelFile != null) model.writeModel(getExperiment().resolveFileName(modelFile));
	} catch (IOException e) {
	    LogService.logMessage("Can't write cluster model file: " + modelFile, LogService.ERROR);
	}
	
	return new IOObject[] { model, exampleSet };
    }

    
    public Class[] getInputClasses() { return INPUT_CLASSES; }

    public Class[] getOutputClasses() { return OUTPUT_CLASSES;  }

    public List getParameterTypes() {
	List types = super.getParameterTypes();
	types.add(new ParameterTypeFile("cluster_file", "File to save the cluster to.", true));
	return types;
    }
}