org.crosswire.common.util

Class Histogram

java.lang.Object

org.crosswire.common.util.Histogram

public class Histogram
extends Object

A simple implementation of a histogram. It would be nice to enhance it to order on frequency.

Author:

DM Smith

See Also:

The GNU Lesser General Public License for details.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	Histogram.Counter Trivial mutable counting integer class.

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,Histogram.Counter>	hist

Constructor Summary

Constructors

Constructor and Description
Histogram() Create an empty histogram

Method Summary

Methods

Modifier and Type	Method and Description
void	clear()
void	increment(String key) Note that this key has been seen one time more than before.
String	toString() The format of the histogram is an unordered list of string and the counts of the number of times it has been seen.

Methods inherited from class java.lang.Object

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

Field Detail

hist

private Map<String,Histogram.Counter> hist

Constructor Detail

Histogram

public Histogram()

Create an empty histogram

Method Detail

increment

public void increment(String key)

Note that this key has been seen one time more than before.

Parameters:

key - the key to increment

clear

public void clear()

toString

public String toString()

The format of the histogram is an unordered list of string and the counts of the number of times it has been seen.

Overrides:

toString in class Object

Returns:

the resultant histogram

See Also:

Object.toString()