de.smartics.tagcloud
Interface TagCloudFactory

All Known Implementing Classes:

AbstractTagCloudFactory

public interface TagCloudFactory

Creates instances of tag clouds.

Author:

Robert Reiner

Method Summary

TagCloud	createJavaCloud() Creates an instance of the tag cloud for Java source code.
TagCloud	createTextCloud() Creates an instance of the tag cloud for arbitrary texts.
void	setMaxTagsToDisplay(int maxTagsToDisplay) The maximum number of tags to display.
void	setMaxWeight(double maxWeight) Sets the maximum weight for the font.
void	setMinWeight(double minWeight) Sets the minimum weight for the font.
void	setUseJavaReservedWordsFilter(boolean useJavaReservedWordsFilter) Activates the filter that removes Java reserved words from the tag cloud.
void	setUseUsualWordsFilter(boolean useUsualWordsFilter) Activates the filter that removes usual Java words from the tag cloud.
void	setWordsToFilter(String[] wordsToFilter) Sets the list of words to be removed from the tag cloud.

Method Detail

setMinWeight

void setMinWeight(double minWeight)

Sets the minimum weight for the font.

Parameters:

maxWeight - the minimum weight for the font.

setMaxWeight

void setMaxWeight(double maxWeight)

Sets the maximum weight for the font.

Parameters:

maxWeight - the maximum weight for the font.

setMaxTagsToDisplay

void setMaxTagsToDisplay(int maxTagsToDisplay)

The maximum number of tags to display.

Parameters:

maxTagsToDisplay - the maximum number of tags to display.

setUseJavaReservedWordsFilter

void setUseJavaReservedWordsFilter(boolean useJavaReservedWordsFilter)

Activates the filter that removes Java reserved words from the tag cloud.

Parameters:

useJavaReservedWordsFilter - true to activate.

setUseUsualWordsFilter

void setUseUsualWordsFilter(boolean useUsualWordsFilter)

Activates the filter that removes usual Java words from the tag cloud.

Parameters:

useUsualWordsFilter - true to activate.

setWordsToFilter

void setWordsToFilter(String[] wordsToFilter)

Sets the list of words to be removed from the tag cloud. This allows an individual configuration.

Parameters:

wordsToFilter - the list of words to be removed from the tag cloud.

createTextCloud

TagCloud createTextCloud()

Creates an instance of the tag cloud for arbitrary texts.

Returns:

an instance of the tag cloud.

createJavaCloud

TagCloud createJavaCloud()

Creates an instance of the tag cloud for Java source code.

Returns:

an instance of the tag cloud.