timeseriesminingsettings.java

一个数据挖掘软件ALPHAMINERR的整个过程的JAVA版源代码

/*
 *    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., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

/**
 * Title: XELOPES Data Mining Library
 * Description: The XELOPES library is an open platform-independent and data-source-independent library for Embedded Data Mining.
 * Copyright: Copyright (c) 2002 Prudential Systems Software GmbH
 * Company: ZSoft (www.zsoft.ru), Prudsys (www.prudsys.com)
 * @author Michael Thess
 * @version 1.0
 */
package com.prudsys.pdm.Models.TimeSeriesPredict;

import com.prudsys.pdm.Core.*;

/**
 * Settings for multivariate time series prediction.
 */
public class TimeSeriesMiningSettings extends MiningSettings
{
    private int embeddingDimension = 5;

    private int stepSize = 1;   // currently always 1

    private boolean singleApproximator = true;

    /**
     * Empty constructor.
     */
    public TimeSeriesMiningSettings()
    {
      this.setFunction( MiningModel.TIME_SERIES_PREDICTION_FUNCTION );
    }

    /**
     * Verify settings. Call super class method (of MiningSettings) for
     * verifying settings and checks whether the target attribute
     * is defined. If settings are incomplete an illegal argument exception
     * is thrown.
     *
     * @exception IllegalArgumentException exception that is thrown for incomplete settings
     */
    public void verifySettings() throws IllegalArgumentException
    {
        super.verifySettings();
    }

    /**
     * Sets new embedding dimension.
     *
     * @param embeddingDimension new enbedding dimension
     */
    public void setEmbeddingDimension(int embeddingDimension)
   {
      this.embeddingDimension = embeddingDimension;
   }

   /**
    * Returns embedding dimension.
    *
    * @return embedding dimension
    */
    public int getEmbeddingDimension()
   {
     return embeddingDimension;
   }

   /**
    * Returns step size.
    *
    * @return step size
    */
   public int getStepSize()
   {
     return stepSize;
   }

   /**
    * Sets new step size. Step size currently not supported
    * (in calculations always 1 is used).
    *
    * @param stepSize new step size
    */
   public void setStepSize(int stepSize)
   {
     this.stepSize = stepSize;
   }

    /**
     * Returns string representation of time series mining settings.
     *
     * @return string representation of time series mining settings
     */
    public String toString()
    {
        return "Time series prediction";
    }

    /**
     * Returns HTML string representation of time series mining settings.
     *
     * @return HTML string representation of time series mining settings
     */
    public String toHtmlString()
    {
        return toString();
    }

    /**
     * Use one approximator for all attributes.
     *
     * @return true if one approximator, false if multiple approximators
     */
    public boolean isSingleApproximator()
    {
      return singleApproximator;
    }

    /**
     * Set use of one or multiple approximators for all attributes.
     *
     * @param singleApproximator true if one approximator, false if multiple approximators
     */
    public void setSingleApproximator(boolean singleApproximator)
    {
      this.singleApproximator = singleApproximator;
    }
}