constantmeasure.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 Valentine Stepanenko ([e-mail])
 * @version 1.0
 */

package com.prudsys.pdm.Olap.Metadata.Measures;

import javax.olap.OLAPException;

import com.prudsys.pdm.Olap.Metadata.Measure;

/**
 * Measure which returns constant value.
 */
public class ConstantMeasure extends Measure
{
   // -----------------------------------------------------------------------
   //  Constants declarations
   // -----------------------------------------------------------------------
   /** User-defined value. */
   public static final int USER_DEFINED = 0;

   /** PI. */
   public static final int PI = 1;

   /** Basis of natural logarithm. */
   public static final int E = 2;

   /** Random number. */
   public static final int RANDOM = 3;

   // -----------------------------------------------------------------------
   //  Variables declarations
   // -----------------------------------------------------------------------
   /** User-defined value. */
   protected double value = 0;

   // -----------------------------------------------------------------------
   //  Constructor
   // -----------------------------------------------------------------------
   /**
    * Empty constructor.
    */
   public ConstantMeasure()
   {
   }

   /**
    * Constructor with given subtype.
    */
   public ConstantMeasure(int subtype)
   {
     this.subtype = subtype;
   }

   // -----------------------------------------------------------------------
   //  Getter and setter methods
   // -----------------------------------------------------------------------
   /**
    * Returns user-defined value.
    *
    * @return user-defines value
    */
   public double getValue() {
     return value;
   }

   /**
    * Sets user-defined value.
    *
    * @param value new user-defined value
    */
   public void setValue(double value) {
     this.value = value;
   }

   // -----------------------------------------------------------------------
   //  Method of measure value calculation
   // -----------------------------------------------------------------------
   /**
    * Calculates constant measure value.
    *
    * @return measure value
    * @throws OLAPException unknwn subtype
    */
   public double measureValue() throws OLAPException {

     if (subtype == USER_DEFINED)
       return value;
     else if (subtype == PI)
       return Math.PI;
     else if (subtype == E)
       return Math.E;
     else if (subtype == RANDOM)
       return Math.random();
     else
       throw new OLAPException("unknown subtype");
   }

}