org.jfree.data.statistics

Class SimpleHistogramBin

Implemented Interfaces:
Cloneable, Comparable, PublicCloneable, Serializable

public class SimpleHistogramBin
extends java.lang.Object
implements Comparable, Cloneable, PublicCloneable, Serializable

A bin for the SimpleHistogramDataset.

Constructor Summary

SimpleHistogramBin(double lowerBound, double upperBound)
Creates a new bin.
SimpleHistogramBin(double lowerBound, double upperBound, boolean includeLowerBound, boolean includeUpperBound)
Creates a new bin.

Method Summary

boolean
accepts(double value)
Returns true if the specified value belongs in the bin, and false otherwise.
Object
clone()
Returns a clone of the bin.
int
compareTo(Object obj)
Compares the bin to an arbitrary object and returns the relative ordering.
boolean
equals(Object obj)
Tests this bin for equality with an arbitrary object.
int
getItemCount()
Returns the item count.
double
getLowerBound()
Returns the lower bound.
double
getUpperBound()
Return the upper bound.
boolean
overlapsWith(SimpleHistogramBin bin)
Returns true if this bin overlaps with the specified bin, and false otherwise.
void
setItemCount(int count)
Sets the item count.

Constructor Details

SimpleHistogramBin

public SimpleHistogramBin(double lowerBound,
                          double upperBound)
Creates a new bin.
Parameters:
lowerBound - the lower bound (inclusive).
upperBound - the upper bound (inclusive);

SimpleHistogramBin

public SimpleHistogramBin(double lowerBound,
                          double upperBound,
                          boolean includeLowerBound,
                          boolean includeUpperBound)
Creates a new bin.
Parameters:
lowerBound - the lower bound.
upperBound - the upper bound.
includeLowerBound - include the lower bound?
includeUpperBound - include the upper bound?

Method Details

accepts

public boolean accepts(double value)
Returns true if the specified value belongs in the bin, and false otherwise.
Parameters:
value - the value.
Returns:
A boolean.

clone

public Object clone()
            throws CloneNotSupportedException
Returns a clone of the bin.
Returns:
A clone.

compareTo

public int compareTo(Object obj)
Compares the bin to an arbitrary object and returns the relative ordering.
Parameters:
obj - the object.
Returns:
An integer indicating the relative ordering of the this bin and the given object.

equals

public boolean equals(Object obj)
Tests this bin for equality with an arbitrary object.
Parameters:
obj - the object (null permitted).
Returns:
A boolean.

getItemCount

public int getItemCount()
Returns the item count.
Returns:
The item count.

getLowerBound

public double getLowerBound()
Returns the lower bound.
Returns:
The lower bound.

getUpperBound

public double getUpperBound()
Return the upper bound.
Returns:
The upper bound.

overlapsWith

public boolean overlapsWith(SimpleHistogramBin bin)
Returns true if this bin overlaps with the specified bin, and false otherwise.
Parameters:
bin - the other bin (null not permitted).
Returns:
A boolean.

setItemCount

public void setItemCount(int count)
Sets the item count.
Parameters:
count - the item count.