org.TagCloud

Class WeightedWord

java.lang.Object

org.TagCloud.WeightedWord

All Implemented Interfaces:

WeightedWordInterface

public class WeightedWord
extends java.lang.Object
implements WeightedWordInterface

Stores the attributes of a word for the Tag Cloud. Each word has a positive integer value for the weight of the font and the weight of the color. They can be the same but don't have to. The WordAnalyser figures out the maximum and minimum values and calculates a weight from 0 to 1.

Constructor Summary

Constructors

Constructor and Description
WeightedWord(java.lang.String word, int value) Constructs a word with the same value for the size and color
WeightedWord(java.lang.String word, int sizeValue, int colorValue) Constructs the word

Method Summary

Methods

Modifier and Type	Method and Description
int	getColorValue() Returns the value for the color
float	getColorWeight() Returns the colorWeight
int	getSizeValue() Returns the value for the size
float	getSizeWeight() Returns the sizeWeight
java.lang.String	getWord() Returns the String of the word
void	setColorWeight(float colorWeight) Sets the colorWeight
void	setSizeWeight(float sizeWeight) Sets the sizeWeight

Methods inherited from class java.lang.Object

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

Constructor Detail

WeightedWord

public WeightedWord(java.lang.String word,
            int value)

Constructs a word with the same value for the size and color

Parameters:

word - the word

value - the value, any positive integer

WeightedWord

public WeightedWord(java.lang.String word,
            int sizeValue,
            int colorValue)

Constructs the word

Parameters:

word - the word

sizeValue - the value for the size weighting, any positive integer

colorValue - the value for the color weighting, any positive integer

Method Detail

getWord

public java.lang.String getWord()

Returns the String of the word

Specified by:

getWord in interface WeightedWordInterface

Returns:

the word

getSizeValue

public int getSizeValue()

Returns the value for the size

Specified by:

getSizeValue in interface WeightedWordInterface

Returns:

the value for the size

getColorValue

public int getColorValue()

Returns the value for the color

Specified by:

getColorValue in interface WeightedWordInterface

Returns:

the value for the color

setSizeWeight

public void setSizeWeight(float sizeWeight)

Sets the sizeWeight

Specified by:

setSizeWeight in interface WeightedWordInterface

Parameters:

sizeWeight - the new sizeWeight

getSizeWeight

public float getSizeWeight()

Returns the sizeWeight

Specified by:

getSizeWeight in interface WeightedWordInterface

Returns:

the sizeWeight

setColorWeight

public void setColorWeight(float colorWeight)

Sets the colorWeight

Specified by:

setColorWeight in interface WeightedWordInterface

Parameters:

colorWeight - the new sizeWeight

getColorWeight

public float getColorWeight()

Returns the colorWeight

Specified by:

getColorWeight in interface WeightedWordInterface

Returns:

the colorWeight