edu.northwestern.at.monk.model
Class SummaryCounts

java.lang.Object
  edu.northwestern.at.monk.model.SummaryCounts

public class SummaryCounts
extends java.lang.Object

A collection of summary counts.

See Also:

MONK Datastore Overview, Licensing Agreement

Constructor Summary

SummaryCounts()
Creates a new collection of zeroed summary counts.

SummaryCounts(long numWords, long numWordsMain, long numWordParts, long numWordPartsMain, long numSentences, long numSentencesMain)
Creates a new collection of summary counts.

Method Summary

void	add(SummaryCounts other) Adds another set of counts to this set.
long	getNumSentences() Gets the number of sentences.
long	getNumSentencesMain() Gets the number of sentences in main text.
long	getNumWordBigrams() Gets the number of word bigrams.
long	getNumWordBigramsMain() Gets the number of word bigrams in main text.
long	getNumWordPartBigrams() Gets the number of word part bigrams.
long	getNumWordPartBigramsMain() Gets the number of word part bigrams in main text.
long	getNumWordParts() Gets the number of word parts.
long	getNumWordPartsMain() Gets the number of word parts in main text.
long	getNumWordPartTrigrams() Gets the number of word part trigrams.
long	getNumWordPartTrigramsMain() Gets the number of word part trigrams in main text.
long	getNumWords() Gets the number of words.
long	getNumWordsMain() Gets the number of words in main text.
long	getNumWordTrigrams() Gets the number of word trigrams.
long	getNumWordTrigramsMain() Gets the number of word trigrams in main text.
long	getSummaryCount(FeatureKind featureKind, Arity arity, MainKind mainKind) Gets a count.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SummaryCounts

public SummaryCounts()

Creates a new collection of zeroed summary counts.

SummaryCounts

public SummaryCounts(long numWords,
                     long numWordsMain,
                     long numWordParts,
                     long numWordPartsMain,
                     long numSentences,
                     long numSentencesMain)

Creates a new collection of summary counts.

The counts are all cumulative counts, and the non-cumulative counts are set to 0.

Parameters:

numWords - Number of words.

numWordsMain - Number of words in main text.

numWordParts - Number of word parts.

numWordPartsMain - Number of word parts in main text.

numSentences - Number of sentences.

numSentencesMain - Number of sentences in main text.

Method Detail

getSummaryCount

public long getSummaryCount(FeatureKind featureKind,
                            Arity arity,
                            MainKind mainKind)

Gets a count.

Parameters:

featureKind - Feature kind: word, word part, or sentence.

arity - Arity: unigram, bigram, or trigram.

mainKind - All text or main text.

Returns:

Summary count.

getNumWords

public long getNumWords()

Gets the number of words.

Returns:

The number of words.

getNumWordsMain

public long getNumWordsMain()

Gets the number of words in main text.

Returns:

The number of words in main text.

getNumWordBigrams

public long getNumWordBigrams()

Gets the number of word bigrams.

Returns:

The number of word bigrams.

getNumWordBigramsMain

public long getNumWordBigramsMain()

Gets the number of word bigrams in main text.

Returns:

The number of word bigrams in main text.

getNumWordTrigrams

public long getNumWordTrigrams()

Gets the number of word trigrams.

Returns:

The number of word trigrams.

getNumWordTrigramsMain

public long getNumWordTrigramsMain()

Gets the number of word trigrams in main text.

Returns:

The number of word trigrams in main text.

getNumWordParts

public long getNumWordParts()

Gets the number of word parts.

Returns:

The number of word parts.

getNumWordPartsMain

public long getNumWordPartsMain()

Gets the number of word parts in main text.

Returns:

The number of word parts in main text.

getNumWordPartBigrams

public long getNumWordPartBigrams()

Gets the number of word part bigrams.

Returns:

The number of word part bigrams.

getNumWordPartBigramsMain

public long getNumWordPartBigramsMain()

Gets the number of word part bigrams in main text.

Returns:

The number of word part bigrams in main text.

getNumWordPartTrigrams

public long getNumWordPartTrigrams()

Gets the number of word part trigrams.

Returns:

The number of word part trigrams.

getNumWordPartTrigramsMain

public long getNumWordPartTrigramsMain()

Gets the number of word part trigrams in main text.

Returns:

The number of word part trigrams in main text.

getNumSentences

public long getNumSentences()

Gets the number of sentences.

Returns:

The number of sentences.

getNumSentencesMain

public long getNumSentencesMain()

Gets the number of sentences in main text.

Returns:

The number of sentences in main text.

add

public void add(SummaryCounts other)

Adds another set of counts to this set.

Parameters:

other - The other set of counts.