attributeusagerelation.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.Core;

/**
  * Parameters for mining activities that are specific for an attribute. Mining
  * attribute usage is intended as a specification apart from the mining input
  * specification itself to enable reuse of the mining input specification for
  * different mining settings. <p>
  *
  * From CWM Data Mining. <p>
  *
  * Superclass:
  * <ul>
  *   <li> ModelElement
  * </ul>
  * Attributes:
  * <ul>
  *   <li> <i>usageType</i>: Indicates whether attribute was actively used
  *   when the model was generated. <br>
  *       - type: AttributeUsage (active | inactive | supplementary) <br>
  *       - multiplicity: exactly one
  *   <li> <i>includeInApplyResult</i>: Indicates whether the attribute is included in
  *     the output. <br>
  *       - type: Boolean <br>
  *       - multiplicity: exactly one
  *   <li> <i>weight</i>:Relative weight of the attribute. <br>
  *       - type: Float <br>
  *       - multiplicity: exactly one
  *   <li> <i>suppressNormalization</i>: Indicates whether normalization is to be
  *     suppressed. <br>
  *       - type: Boolean <br>
  *       - multiplicity: exactly one
  * </ul>
  * References:
  * <ul>
  *   <li> <i>attribute</i>: Reference to the MiningAttribute. <br>
  *       - class: MiningAttribute <br>
  *       - defined by: PertainsToAttribute::attribute <br>
  *       - multiplicity: exactly one
  * </ul>
  *
  * @see AttributeUsage
  * @see MiningAttribute
  */
public class AttributeUsageRelation extends com.prudsys.pdm.Cwm.Core.ModelElement
{
    // -----------------------------------------------------------------------
    //  Variables declarations
    // -----------------------------------------------------------------------
    /** Indicates how the attribute is used by the mining function. */
    public AttributeUsage usageType;

    /** Indicates whether the attribute is included in the output. */
    public Boolean includeInApplyResult;

    /** Relative weight of the attribute. */
    public Float weight;

    /** Indicates whether normalization is to be suppressed. */
    public Boolean suppressNormalization;

    /** Reference to mining settings. */
    public MiningSettings settings;

    /** Reference to the attribute. */
    public MiningAttribute attribute;

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

    // -----------------------------------------------------------------------
    //  Getter and setter methods
    // -----------------------------------------------------------------------
    /**
     * Returns attribute usage type.
     *
     * @return attribute usage type
     */
    public AttributeUsage getUsageType() {
      return usageType;
    }

    /**
     * Sets attribute usage type.
     *
     * @param usageType new attribute usage type
     */
    public void setUsageType(AttributeUsage usageType) {
      this.usageType = usageType;
    }

    /**
     * Returns associated mining attribute.
     *
     * @return associated mining attribute
     */
    public MiningAttribute getAttribute() {

      return attribute;
    }

    /**
     * Sets associated mining attribute.
     *
     * @param attribute new associated mining attribute
     */
    public void setAttribute(MiningAttribute attribute) {

      this.attribute = attribute;
    }

    /**
     * Returns mining settings of relation.
     *
     * @return mining settings of relation
     */
    public MiningSettings getSettings() {

      return settings;
    }

    /**
     * Sets mining settings of relation.
     *
     * @param settings new mining settings of relation
     */
    public void setSettings(MiningSettings settings) {

      this.settings = settings;
    }
}