Class SimpleHistogramBin

java.lang.Object
org.jfree.data.statistics.SimpleHistogramBin
All Implemented Interfaces:
Serializable, Cloneable, Comparable, PublicCloneable

public class SimpleHistogramBin extends Object implements Comparable, Cloneable, PublicCloneable, Serializable
A bin for the SimpleHistogramDataset.
See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private boolean
    A flag that controls whether the lower bound is included in the bin range.
    private boolean
    A flag that controls whether the upper bound is included in the bin range.
    private int
    The item count.
    private double
    The lower bound for the bin.
    private static final long
    For serialization.
    private double
    The upper bound for the bin.
  • Constructor Summary

    Constructors
    Constructor
    Description
    SimpleHistogramBin(double lowerBound, double upperBound)
    Creates a new bin.
    SimpleHistogramBin(double lowerBound, double upperBound, boolean includeLowerBound, boolean includeUpperBound)
    Creates a new bin.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    accepts(double value)
    Returns true if the specified value belongs in the bin, and false otherwise.
    Returns a clone of the bin.
    int
    Compares the bin to an arbitrary object and returns the relative ordering.
    boolean
    Tests this bin for equality with an arbitrary object.
    int
    Returns the item count.
    double
    Returns the lower bound.
    double
    Return the upper bound.
    boolean
    Returns true if this bin overlaps with the specified bin, and false otherwise.
    void
    setItemCount(int count)
    Sets the item count.

    Methods inherited from class java.lang.Object

    finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      For serialization.
      See Also:
    • lowerBound

      private double lowerBound
      The lower bound for the bin.
    • upperBound

      private double upperBound
      The upper bound for the bin.
    • includeLowerBound

      private boolean includeLowerBound
      A flag that controls whether the lower bound is included in the bin range.
    • includeUpperBound

      private boolean includeUpperBound
      A flag that controls whether the upper bound is included in the bin range.
    • itemCount

      private int itemCount
      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

    • getLowerBound

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

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

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

      public void setItemCount(int count)
      Sets the item count.
      Parameters:
      count - the item count.
    • 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.
    • 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.
    • compareTo

      public int compareTo(Object obj)
      Compares the bin to an arbitrary object and returns the relative ordering.
      Specified by:
      compareTo in interface Comparable
      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.
      Overrides:
      equals in class Object
      Parameters:
      obj - the object (null permitted).
      Returns:
      A boolean.
    • clone

      public Object clone() throws CloneNotSupportedException
      Returns a clone of the bin.
      Specified by:
      clone in interface PublicCloneable
      Overrides:
      clone in class Object
      Returns:
      A clone.
      Throws:
      CloneNotSupportedException - not thrown by this class.