weka.datagenerators.ClusterDefinition Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of weka-stable Show documentation
Show all versions of weka-stable Show documentation
The Waikato Environment for Knowledge Analysis (WEKA), a machine
learning workbench. This is the stable version. Apart from bugfixes, this version
does not receive any other updates.
/*
* 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 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
/*
* ClusterDefinition.java
* Copyright (C) 2005-2012 University of Waikato, Hamilton, New Zealand
*
*/
package weka.datagenerators;
import java.io.Serializable;
import java.util.Enumeration;
import weka.core.Option;
import weka.core.OptionHandler;
import weka.core.RevisionHandler;
import weka.core.Utils;
/**
* Ancestor to all ClusterDefinitions, i.e., subclasses that handle their own
* parameters that the cluster generator only passes on.
*
*
* @author FracPete (fracpete at waikato dot ac dot nz)
* @version $Revision: 10203 $
*/
public abstract class ClusterDefinition implements Serializable, OptionHandler,
RevisionHandler {
/** for serialization */
private static final long serialVersionUID = -5950001207047429961L;
/** the parent of the cluster */
protected ClusterGenerator m_Parent;
/**
* initializes the cluster, without a parent cluster (necessary for GOE)
*/
public ClusterDefinition() {
this(null);
}
/**
* initializes the cluster
*
* @param parent the datagenerator this cluster belongs to
*/
public ClusterDefinition(ClusterGenerator parent) {
m_Parent = parent;
try {
setDefaults();
} catch (Exception e) {
e.printStackTrace();
}
}
/**
* sets the default values
*
* @throws Exception if setting of defaults fails
*/
protected abstract void setDefaults() throws Exception;
/**
* Returns a string describing this data generator.
*
* @return a description of the data generator suitable for displaying in the
* explorer/experimenter gui
*/
public String globalInfo() {
return "Contains informations about a certain cluster of a cluster generator.";
}
/**
* Returns an enumeration describing the available options.
*
* @return an enumeration of all the available options
*/
@Override
public abstract Enumeration