constantpredicate.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.Input.Predicates;

import com.prudsys.pdm.Core.*;
import com.prudsys.pdm.Input.*;
import com.prudsys.pdm.Adapters.PmmlVersion20.True;
import com.prudsys.pdm.Adapters.PmmlVersion20.False;

/**
  * It corresponds to the PMML elements True and False. <p>
  *
  * Extends Predicate for constant boolean value. <p>
  *
  * From PMML. <p>
  *
  * Superclasses:
  * <ul>
  *   <li> Predicate
  * </ul>
  *
  * @see com.prudsys.pdm.Adapters.PmmlVersion20.ConstantPredicate
  * @see com.prudsys.pdm.Adapters.PmmlVersion20.Predicate
  */
public class ConstantPredicate extends Predicate implements PmmlPresentable
{
  // -----------------------------------------------------------------------
  //  Variables declarations
  // -----------------------------------------------------------------------
  /** Constant to use. */
  protected boolean constant;

  // -----------------------------------------------------------------------
  //  Constructors
  // -----------------------------------------------------------------------
  /**
   * Empty constructor.
   */
  public ConstantPredicate()
  {
  }

  /**
   * Set constant predicate.
   *
   * @param constant is predicate constant
   */
  public ConstantPredicate(boolean constant)
  {
    this.constant = constant;
  }

  // -----------------------------------------------------------------------
  //  Getter and setter methods
  // -----------------------------------------------------------------------
  /**
   * Is constant predicate?
   *
   * @return true if constant predicate, otherwise false
   */
  public boolean getConstant() {
    return constant;
  }

  /**
   * Sets predicate constant.
   *
   * @param constant new constant
   */
  public void setConstant(boolean constant) {
    this.constant = constant;
  }

  // -----------------------------------------------------------------------
  //  Evaluate predicate
  // -----------------------------------------------------------------------
  /**
   * Predicate evaluation of given mining vector.
   *
   * @param miningVector vector for evaluation
   * @return predicate evaluation result
   * @exception MiningException can't evaluate mining vector
   */
  public boolean evaluate(MiningVector miningVector) throws MiningException {

    return constant;
  }

  // -----------------------------------------------------------------------
  //  Methods of PMML handling
  // -----------------------------------------------------------------------
  /**
   * Create PMML object ConstantPredicate.
   *
   * @return PMML Object Constant predicate
   * @exception MiningException can't create PMML object
   * @see com.prudsys.pdm.Adapters.PmmlVersion20.ConstantPredicate
   */
  public Object createPmmlObject() throws MiningException {

    if(constant) return new True();
    else return new False();
  }

  /**
   * Read PMML object ConstantPredicate.
   *
   * @param pmmlObject Constant predicate to read
   * @exception MiningException can't parse PMML object
   * @see com.prudsys.pdm.Adapters.PmmlVersion20.ConstantPredicate
   */
  public void parsePmmlObject(Object pmmlObject) throws MiningException {

    if(pmmlObject instanceof True) constant = true;
    else if(pmmlObject instanceof False) constant = false;
    else throw new MiningException("Can't parse constant predicate");
  }

  /**
   * Create string representation of constant predicate.
   *
   * @return PMML representation of predicate
   */
  public String toString() {
    return constant?"true":"false";
  }
}