/* -------------------------------------------------------------------------- */
/*                                                                            */
/*                           POTENTIAL SIGNIFICANT WORD                       */
/*                                                                            */
/*                                Frans Coenen                                */
/*                                                                            */
/*                              Monday 3 July 2006                            */
/*                                                                            */
/*                         Department of Computer Science                     */
/*                          The University of Liverpool                       */
/*                                                                            */
/* -------------------------------------------------------------------------- */

//package lucsKDD_ARM;

/** Contains stucture to store a potential significant word woth respect to a
particular class. Note a word can be significant with respect to more than one
class. Also the final set of significant words will be some subset of the set ]
of potential significant words.
@author Frans Coenen
@version 3 July 2006   */

public class PotentialSigWord {
    /** Reference to a specific word bin tree node */
    public WordBinTreeNode wordBinTreeNode = null;
    /** Class number of the primary class which the word is significant (the
    word may be significant for more than one class). The class number 
    will be the index+1. */
    public short classIndex; 
    
    /* ------------------------------------ */
    /*                                      */
    /*              CONSTRUCTORS            */
    /*                                      */
    /* ------------------------------------ */

    /** Two argument constructor. 
    @param wbtNode the given worod bin tree node.
    @prama cIndex the class index into the contribution array contained in the
    referenced word bin tree node.	*/
    
    public PotentialSigWord(WordBinTreeNode wbtNode, short cIndex) {
        wordBinTreeNode = wbtNode;
        classIndex      = cIndex;   
	}    
    
    /* ------------------------------- */
    /*                                 */
    /*              METHODS            */
    /*                                 */
    /* ------------------------------- */
    
    /** To string standard method.
    @return the output string.              */

    public String toString() {
        int length = 15;
	
        // Generate string
	String s = wordBinTreeNode.word;
	for (int index=wordBinTreeNode.word.length();index<length;index++)
		s = s +" ";
	s = s + "| " + (((double)
	           wordBinTreeNode.contribution[classIndex])/100.0) + "\t| " +
	                   (classIndex+1)+ "\t| " + wordBinTreeNode.isSigWord;

        // Return
	return(s);
	}
    }