vardwrapper
Class NormalisationStats

java.lang.Object
  extended by vardwrapper.NormalisationStats

public class NormalisationStats
extends java.lang.Object

Stats produced from normalising a whole text (file).


Constructor Summary
NormalisationStats(java.lang.String fileName, int typeCount, int variantTypeCount, int replacedTypeCount, int correctTypeCount, int tokenCount, int variantTokenCount, int replacedTokenCount, int correctTokenCount)
          Instantiates new normalisation stats, token and type counts.
 
Method Summary
 int getCorrectTokenCount()
          Gets the number of tokens which are considered 'correct', i.e.
 int getCorrectTypeCount()
          Gets the number of word types which are considered 'correct', i.e.
 java.lang.String getFileName()
          Gets the file name.
 int getReplacedTokenCount()
          Gets the number of tokens which have been normalised.
 int getReplacedTypeCount()
          Gets the number of word types which have been normalised.
 int getTokenCount()
          Gets the total token count.
 int getTypeCount()
          Gets the total types count.
 int getVariantTokenCount()
          Gets the variant token count, that is those tokens which are still considered variants after normalisation, hence those variants for which an appropriate normalisation wasn't found.
 int getVariantTypeCount()
          Gets the variant type count, that is those word types which are still considered variants after normalisation, hence those variants for which an appropriate normalisation wasn't found.
static java.lang.String headerString()
          Header string for print out (R).
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

NormalisationStats

public NormalisationStats(java.lang.String fileName,
                          int typeCount,
                          int variantTypeCount,
                          int replacedTypeCount,
                          int correctTypeCount,
                          int tokenCount,
                          int variantTokenCount,
                          int replacedTokenCount,
                          int correctTokenCount)
Instantiates new normalisation stats, token and type counts.

Parameters:
fileName - the file name
typeCount - the total type count
variantTypeCount - the variant type count
replacedTypeCount - the replaced type count
correctTypeCount - the correct type count
tokenCount - the total token count
variantTokenCount - the variant token count
replacedTokenCount - the replaced token count
correctTokenCount - the correct token count
Method Detail

getFileName

public java.lang.String getFileName()
Gets the file name.

Returns:
the file name

getTypeCount

public int getTypeCount()
Gets the total types count.

Returns:
the total types count

getVariantTypeCount

public int getVariantTypeCount()
Gets the variant type count, that is those word types which are still considered variants after normalisation, hence those variants for which an appropriate normalisation wasn't found.

Returns:
the variant type count.

getReplacedTypeCount

public int getReplacedTypeCount()
Gets the number of word types which have been normalised.

Returns:
the replaced type count

getCorrectTypeCount

public int getCorrectTypeCount()
Gets the number of word types which are considered 'correct', i.e. shouldn't be normalised.

Returns:
the correct type count

getTokenCount

public int getTokenCount()
Gets the total token count.

Returns:
the total token count

getVariantTokenCount

public int getVariantTokenCount()
Gets the variant token count, that is those tokens which are still considered variants after normalisation, hence those variants for which an appropriate normalisation wasn't found.

Returns:
the variant token count

getReplacedTokenCount

public int getReplacedTokenCount()
Gets the number of tokens which have been normalised.

Returns:
the replaced token count

getCorrectTokenCount

public int getCorrectTokenCount()
Gets the number of tokens which are considered 'correct', i.e. shouldn't be normalised.

Returns:
the correct token count

headerString

public static java.lang.String headerString()
Header string for print out (R).

Returns:
"File\tTotal Types\tVariant Types\tNormalised Types\tNon-variants Types\tTotal Tokens\tVariant Tokens\tNormalised Tokens\tNon-variant Tokens"

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object
Returns:
file name, total types, variant types, normalised types, non-variant ('correct') types, total tokens, variant tokens, normalised tokens, non-variant ('correct') tokens. Separated by tabs.