net.seninp.jmotif.text

Class WordBag

java.lang.Object

net.seninp.jmotif.text.WordBag

All Implemented Interfaces:

Cloneable

public class WordBag
extends Object
implements Cloneable

Implements a word bag. Word bag is the container for pairs word-frequency. It is not text, it is usually a processed text.

Author:

psenin

Constructor Summary

Constructors

Constructor and Description
WordBag(String bagLabel) Constructor.
WordBag(String bagName, HashMap<String,Integer> words) Constructor

Method Summary

Modifier and Type	Method and Description
void	addWord(String word) Add the word into the bag.
void	addWord(String word, Integer frequency) Add the word into the dictionary.
WordBag	clone()
boolean	contains(String word) Quick check if the word is in the text.
double	getAverageFrequency() Get the maximal observed frequency.
HashMap<String,AtomicInteger>	getInternalWords() Get the words collection along with frequencies.
String	getLabel() Get the wordbag id or name.
int	getMaxFrequency() Get the maximal observed frequency.
int	getTotalWordCount() Integral of all frequency values.
Integer	getWordFrequency(String word) Get the word occurrence frequency, if word is not in returns 0.
HashMap<String,Integer>	getWords() Get the words collection along with frequencies.
HashMap<String,Double>	getWordsAsDoubles() Get the words collection along with frequencies.
Collection<String>	getWordSet() Get the words set.
void	mergeWith(WordBag otherBag) Implements merge operation for this bag with some other bag.
void	setLabel(String newBagLabel) Set the new label on this bag.
String	toColumn()
String	toString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WordBag

public WordBag(String bagLabel)

Constructor.

Parameters:

bagLabel - The name for the collection.

WordBag

public WordBag(String bagName,
               HashMap<String,Integer> words)

Constructor

Parameters:

bagName - The name for the collection.

words - The words data for the collection.

Method Detail

setLabel

public void setLabel(String newBagLabel)

Set the new label on this bag.

Parameters:

newBagLabel - The new label.

getLabel

public String getLabel()

Get the wordbag id or name.

Returns:

the label string.

addWord

public void addWord(String word)

Add the word into the bag.

Parameters:

word - The word to add.

addWord

public void addWord(String word,
                    Integer frequency)

Add the word into the dictionary.

Parameters:

word - The word.

frequency - Word's frequency.

getWordFrequency

public Integer getWordFrequency(String word)

Get the word occurrence frequency, if word is not in returns 0.

Parameters:

word - The word to look for.

Returns:

The word frequency.

contains

public boolean contains(String word)

Quick check if the word is in the text.

Parameters:

word - The word to check for.

Returns:

True if the word seen in text.

getWordSet

public Collection<String> getWordSet()

Get the words set.

Returns:

The words set.

getWordsAsDoubles

public HashMap<String,Double> getWordsAsDoubles()

Get the words collection along with frequencies.

Returns:

The map of words as keys with frequencies as values.

getWords

public HashMap<String,Integer> getWords()

Get the words collection along with frequencies.

Returns:

The map of words as keys with frequencies as values.

getInternalWords

public HashMap<String,AtomicInteger> getInternalWords()

Get the words collection along with frequencies.

Returns:

The map of words as keys with frequencies as values.

getTotalWordCount

public int getTotalWordCount()

Integral of all frequency values.

Returns:

sum of all frequency values.

mergeWith

public void mergeWith(WordBag otherBag)

Implements merge operation for this bag with some other bag. Resulting words set is the union of words from two bags, and resulting frequencies are the sum of two frequencies.

Parameters:

otherBag - The bag to merge with.

toString

public String toString()

Overrides:

toString in class Object

toColumn

public String toColumn()

getMaxFrequency

public int getMaxFrequency()

Get the maximal observed frequency. Useful for normalized tf.

Returns:

the maximal observed frequency in the bag.

getAverageFrequency

public double getAverageFrequency()

Get the maximal observed frequency. Useful for averaged tf.

Returns:

the average frequency in the bag.

clone

public WordBag clone()

Overrides:

clone in class Object