org.TagCloud

Class WordAnalyser

java.lang.Object

org.TagCloud.WordAnalyser

public class WordAnalyser
extends java.lang.Object

This class does the processing and filtering of the words

Constructor Summary

Constructors

Constructor and Description
WordAnalyser(java.util.List<WeightedWordInterface> weightedWords) Creates a new WordAnalyzer with the supplied list of WeightedWords.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.TreeSet<java.lang.Integer>	getColorValueSortedTreeSet() This method returns a TreeSet of the index numbers of the weightedWords list where the indexes are sorted by the colorValue of the weighted word.
float	getColorWeight(int value) Figures out the weight from 0 to 1 based on the supplied color value
int	getMaxColorValue() Returns the highest value of the color value
int	getMaxSizeValue() Returns the highest value of the size values
int	getMinColorValue() Returns the lowest value of the color value
int	getMinSizeValue() Returns the lowest value of the size values
java.util.TreeSet<java.lang.Integer>	getSizeValueSortedTreeSet() This method returns a TreeSet of the index numbers of the weightedWords list where the indexes are sorted by the sizeValue of the weighted word.
float	getSizeWeight(int value) Returns the weight from 0 to 1 for a given size value
java.util.List<WeightedWordInterface>	getTopWordsColorWeighted(int limit) Returns an alphabetical List of the the first n words as per the ColorValue order
java.util.List<WeightedWordInterface>	getTopWordsSizeWeighted(int limit) Returns an alphabetical List of the the first n words as per the SizeValue order
java.util.List<WeightedWordInterface>	getWeightedWords() Returns the list of WeightedWords
WeightedWordInterface	getWord(int i) Returns the word for the index

Methods inherited from class java.lang.Object

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

Constructor Detail

WordAnalyser

public WordAnalyser(java.util.List<WeightedWordInterface> weightedWords)

Creates a new WordAnalyzer with the supplied list of WeightedWords. Figures out the minimum and maximum values and can calculate the weigth from 0 to 1 for the font weight and color weight.

Parameters:

weightedWords - The list of weightedWords

Method Detail

getWord

public WeightedWordInterface getWord(int i)

Returns the word for the index

Parameters:

i - the word index, 0 to size() - 1

Returns:

the weighted word

getWeightedWords

public java.util.List<WeightedWordInterface> getWeightedWords()

Returns the list of WeightedWords

Returns:

the weighted words

getSizeValueSortedTreeSet

public java.util.TreeSet<java.lang.Integer> getSizeValueSortedTreeSet()

This method returns a TreeSet of the index numbers of the weightedWords list where the indexes are sorted by the sizeValue of the weighted word. If two values are identical the alphabetically smaller word will come first.

Returns:

The TreeSet of index values

getMaxSizeValue

public int getMaxSizeValue()

Returns the highest value of the size values

Returns:

the highest value of the size weights

getMinSizeValue

public int getMinSizeValue()

Returns the lowest value of the size values

Returns:

the lowest value of the size weights

getSizeWeight

public float getSizeWeight(int value)

Returns the weight from 0 to 1 for a given size value

Parameters:

value - the value for which to figure out the weight

Returns:

the weight in the range 0..1

getTopWordsSizeWeighted

public java.util.List<WeightedWordInterface> getTopWordsSizeWeighted(int limit)

Returns an alphabetical List of the the first n words as per the SizeValue order

Parameters:

limit - The maximum words to return

Returns:

an alphabetical set of the highest ranking n words

getColorValueSortedTreeSet

public java.util.TreeSet<java.lang.Integer> getColorValueSortedTreeSet()

This method returns a TreeSet of the index numbers of the weightedWords list where the indexes are sorted by the colorValue of the weighted word.

Returns:

The TreeSet of index values

getMaxColorValue

public int getMaxColorValue()

Returns the highest value of the color value

Returns:

the highest color value

getMinColorValue

public int getMinColorValue()

Returns the lowest value of the color value

Returns:

the lowest color value

getColorWeight

public float getColorWeight(int value)

Figures out the weight from 0 to 1 based on the supplied color value

Parameters:

value - the value for which to figure out the weight

Returns:

the weight

getTopWordsColorWeighted

public java.util.List<WeightedWordInterface> getTopWordsColorWeighted(int limit)

Returns an alphabetical List of the the first n words as per the ColorValue order

Parameters:

limit - The maximum words to return

Returns:

an alphabetical set of the highest ranking n words