predicate.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.*;

/**
  * It corresponds to the PMML element Predicate. <p>
  *
  * Abstract class for evaluating predicates in decision trees. <p>
  *
  * From PMML. (PMML entity PREDICATES.)
  */
public abstract class Predicate extends com.prudsys.pdm.Cwm.Core.BooleanExpression implements PmmlPresentable
{
  // -----------------------------------------------------------------------
  //  Variables declarations
  // -----------------------------------------------------------------------
  /** Meta data of predicate. */
  protected MiningDataSpecification metaData;

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

  /**
   * Predicate with given meta data.
   *
   * @param metaData meta data of predicate
   */
  public Predicate(MiningDataSpecification metaData) {

    this.metaData = metaData;
  }

  // -----------------------------------------------------------------------
  //  Getter and setter methods
  // -----------------------------------------------------------------------
  /**
   * Sets meta data for predicate.
   *
   * @param metaData new meta data of predicate
   */
  public void setMetaData(MiningDataSpecification metaData) {
    this.metaData = metaData;
  }

  /**
   * Returns meta data for predicate.
   *
   * @return meta data of predicate
   */
  public MiningDataSpecification getMetaData() {
    return metaData;
  }

  // -----------------------------------------------------------------------
  //  Evaluate predicate
  // -----------------------------------------------------------------------
  /**
   * Evaluates predicates for mining vector.
   *
   * @param miningVector mining vector for predicate evaluation
   * @return evaluation result
   * @exception MiningException can't evaluate mining vector
   */
  public abstract boolean evaluate(MiningVector miningVector)
    throws MiningException;

  /**
   * Returns string representation of predicate (few words).
   *
   * @return string representation of predicate
   */
  public String toString() {
    return "abstract predicate";
  }
}