com.jivesoftware.base.stats
Interface BinSequence

All Known Implementing Classes:

CyclicSequence, DateSequence, DefaultBinSequence, RegularSequence, SigFigSequence, TimeSigFigSequence, VariableStepSequence

public interface BinSequence

The BinSequence object serves a two-fold purpose. First, it is used by the Histogram object to map incoming Elements to Bins. Second, it is used to generate a sequence of Bins for use in displaying results for a Report.

Method Summary

Bin	getBin(Element element) Map an Element to a Bin.
Bin[]	getBins(Element minElement, Element maxElement) Get a sequence of Bins.
Bin[]	getBins(Element minElement, Element maxElement, boolean containsMin, boolean containsMax) Get a sequence of Bins.
Bin	getNext(Bin bin) Get the next Bin in the sequence.

Method Detail

getBin

Bin getBin(Element element)

Map an Element to a Bin.

Parameters:

element - The element to be mapped to a Bin

Returns:

The resulting Bin

getNext

Bin getNext(Bin bin)

Get the next Bin in the sequence.

Parameters:

bin - The current Bin

Returns:

The next Bin

getBins

Bin[] getBins(Element minElement,
              Element maxElement)

Get a sequence of Bins.

Parameters:

minElement - An element that should be contained in the first Bin.

maxElement - An element that should be contained in the last Bin.

Returns:

The resulting array of Bins

getBins

Bin[] getBins(Element minElement,
              Element maxElement,
              boolean containsMin,
              boolean containsMax)

Get a sequence of Bins.

Parameters:

minElement - An element that defines the first Bin.

maxElement - An element that defines the last Bin.

containsMin - Should the list contain the first Bin?

containsMax - Should the list contain the last Bin?

Returns:

The resulting array of Bins