com.randomcoder.tag
Class TagCloudEntry

java.lang.Object
  com.randomcoder.tag.TagStatistics
      com.randomcoder.tag.TagCloudEntry

All Implemented Interfaces:

Serializable

public class TagCloudEntry
extends TagStatistics

Statisitics for Tag instances with extensions for creating tag clouds.

 Copyright (c) 2006, Craig Condit. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
   * Redistributions of source code must retain the above copyright notice,
     this list of conditions and the following disclaimer.
   * Redistributions in binary form must reproduce the above copyright notice,
     this list of conditions and the following disclaimer in the documentation
     and/or other materials provided with the distribution.
     
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGE.
 

See Also:

Serialized Form

Constructor Summary

TagCloudEntry()
Constructs an empty TagCloudEntry.

TagCloudEntry(TagStatistics stat, int maximumArticleCount)
Creates a Tag cloud entry from the given statistics

Method Summary

int	getScale() Gets the scale factor (0-9) for this tag.
void	setScale(int scale) Sets the scale factor (0-9) for this tag.

Methods inherited from class com.randomcoder.tag.TagStatistics

getArticleCount, getTag, setArticleCount, setTag

Methods inherited from class java.lang.Object

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

Constructor Detail

TagCloudEntry

public TagCloudEntry()

Constructs an empty TagCloudEntry.

TagCloudEntry

public TagCloudEntry(TagStatistics stat,
                     int maximumArticleCount)

Creates a Tag cloud entry from the given statistics

Parameters:

stat - Tag statistics

maximumArticleCount - ceiling value for article count

Method Detail

getScale

public int getScale()

Gets the scale factor (0-9) for this tag.

Returns:

scale factor

setScale

public void setScale(int scale)

Sets the scale factor (0-9) for this tag.

A scale factor of 0 indicates the minimum size. A scale factor of 9 indicates the largest size (most popular). Negative values will be translated to zero; Values greater than 9 will become 9.

Parameters:

scale - scale factor