identity.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.Transform.OneToOne;

import com.prudsys.pdm.Core.MiningAttribute;
import com.prudsys.pdm.Core.MiningException;
import com.prudsys.pdm.Transform.OneToOneMapping;

/**
 * Realization of identical transformation. The attribute object
 * remains the same. Hence the "new" attribute cannot be changed in
 * any way, even not the name (target name = source name) and hence
 * target name is ignored. Self-Inverse.
 */
public class Identity extends OneToOneMapping
{
  // -----------------------------------------------------------------------
  //  Constructor
  // -----------------------------------------------------------------------
  /**
   * Empty constructor.
   */
  public Identity()
  {
  }

  /**
   * Sets new target name. Since source and target name
   * must be identical, this method does nothing.
   *
   * @param targetName new name of target attribute (ignored)
   */
  public void setTargetName(String targetName)
  {

  }

  // -----------------------------------------------------------------------
  //  Transformation methods
  // -----------------------------------------------------------------------
  /**
   * Transforms the source attribute. The result is the target attribute.
   *
   * @return transformed (identical) attribute
   * @exception MiningException could not transform attribute
   */
  public MiningAttribute transformAttribute() throws MiningException
  {
    if (getSourceAttribute() == null)
        throw new MiningException("Could not find source attribute: " + sourceName);

    return getSourceAttribute();
  }

  /**
   * Transforms attribute value. The result is also a value.
   *
   * @param attributeValue value of attribute to be transformed
   * @return tranformed (identical) value
   * @exception MiningException could not transform attribute value
   */
  public double transformAttributeValue( double attributeValue ) throws MiningException
  {
      double transformedValue = attributeValue;

      return transformedValue;
  }

  // -----------------------------------------------------------------------
  //  Methods of PMML handling
  // -----------------------------------------------------------------------
  /**
   * Creates PMML object DerivedField of this object of Identical type.
   * Not supported since identical transformation is just the reference
   * of original attribute contained in DataField element.
   *
   * @return DerivedField element
   * @exception MiningException always thrown
   */
  public Object createPmmlObject() throws MiningException
  {
      throw new java.lang.UnsupportedOperationException("Method createPmmlObject() not implemented.");
  }

  /**
   * Creates this object from PMML.
   * Not supported.
   *
   * @param pmml pmml element
   * @exception MiningException always thrown
   */
  public void parsePmmlObject(Object pmml) throws MiningException
  {
      throw new java.lang.UnsupportedOperationException("Method parsePmmlObject() not implemented.");
  }

}