mininggraphnode.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])
  * @author Michael Thess
  * @version 1.0
  */

package com.prudsys.pdm.Core;

import java.util.Arrays;
import java.util.Enumeration;
import java.util.Vector;

/**
 * Node of an arbitrary graph. <p>
 *
 * The node may contain any object (Category for example). <p>
 *
 * From PDM CWM extension.
 *
 * @see MiningTreeNode
 */
public class MiningGraphNode extends com.prudsys.pdm.Cwm.Core.Class
{
    // -----------------------------------------------------------------------
    //  Variables declarations
    // -----------------------------------------------------------------------
    /** Array of neighbours of the node. */
    public MiningGraphNode[] neighbours;

    /** Value object of the node. */
    protected Object nodeValue;

    // -----------------------------------------------------------------------
    //  Methods of node manipulation
    // -----------------------------------------------------------------------
    /**
     * Get number of neighbours.
     *
     * @return number of neighbours
     */
    public int getNeighbCount()
    {
        return ( neighbours != null ) ? neighbours.length : 0;
    }

    /**
     * Get neighbour node at specified index.
     *
     * @param neighbIndex index of neighb
     * @return neighb at specified index, null if not found
     */
    public MiningGraphNode getNeighbAt( int neighbIndex )
    {
        return ( neighbours != null ) ? neighbours[neighbIndex] : null;
    }

    /**
     * Get index of neighb node.
     *
     * @param neighbNode neighb node
     * @return index neighb index, -1 if not found
     */
    public int getNeighbIndex( MiningGraphNode neighbNode )
    {
        int index = -1;
        if( neighbours == null )
        {
            index = -1;
        }
        else
        {
            for( int i = 0; i < neighbours.length; i++ )
            {
                if( neighbours[i].equals( neighbNode ) )
                {
                    index = i;
                }
            }
        }
        return index;
    }

    /**
     * Return list of all neighbours
     *
     * @return all neighbours
     */
    public Enumeration neighbours()
    {
        if( neighbours != null )
        {
            Vector v = new Vector( Arrays.asList( neighbours ) );
            return v.elements();
        }
        else
        {
            return null;
        }
    }

    /**
    * Add neighb node to neighbours list.
    *
    * @param neighb neighb node to add
    */
    public void addNeighbNode(MiningGraphNode neighb)
    {
        int nneighb = getNeighbCount();
        MiningGraphNode[] neighb2 = new MiningGraphNode[nneighb];

        for (int i = 0; i < nneighb; i++)
          neighb2[i] = (MiningGraphNode) neighbours[i];

        neighbours = new MiningGraphNode[nneighb+1];

        for (int i = 0; i < nneighb; i++)
          neighbours[i] = neighb2[i];

        neighbours[nneighb] = neighb;
    }

    /**
    * Remove neighb node from neighbours list.
    *
    * @param neighb neighb node to be removed
    */
    public void removeNeighbNode(MiningGraphNode neighb)
    {
        int nneighb = getNeighbCount();
        MiningGraphNode[] neighb2 = new MiningGraphNode[nneighb];

        for (int i = 0; i < nneighb; i++)
          neighb2[i] = (MiningGraphNode) neighbours[i];

        neighbours = new MiningGraphNode[nneighb-1];

        int ind = 0;
        for (int i = 0; i < nneighb; i++)
          if (neighb2[i] != neighb) neighbours[ind++] = neighb2[i];
    }

    /**
     * Get value of node.
     *
     * @return node value
     */
    public Object getNodeValue()
    {
        return nodeValue;
    }

    /**
     * Sets value of node.
     *
     * @param nodeValue new value of node
     */
    public void setNodeValue(Object nodeValue)
    {
        this.nodeValue = nodeValue;
    }
}