Save This Page
Home » jcommon-1.0.13 » org.jfree » data » statistics » [javadoc | source]
org.jfree.data.statistics
public class: DefaultBoxAndWhiskerXYDataset [javadoc | source]
java.lang.Object
   org.jfree.data.general.AbstractDataset
      org.jfree.data.general.AbstractSeriesDataset
         org.jfree.data.xy.AbstractXYDataset
            org.jfree.data.statistics.DefaultBoxAndWhiskerXYDataset

All Implemented Interfaces:
    RangeInfo, BoxAndWhiskerXYDataset, XYDataset, SeriesDataset, Serializable, SeriesChangeListener, Cloneable, Dataset, ObjectInputValidation

A simple implementation of the BoxAndWhiskerXYDataset interface. This dataset implementation can hold only one series.
Constructor:
 public DefaultBoxAndWhiskerXYDataset(Comparable seriesKey) 
    Constructs a new box and whisker dataset.

    The current implementation allows only one series in the dataset. This may be extended in a future version.

    Parameters:
    seriesKey - the key for the series.
Method from org.jfree.data.statistics.DefaultBoxAndWhiskerXYDataset Summary:
add,   clone,   equals,   getFaroutCoefficient,   getItem,   getItemCount,   getMaxOutlier,   getMaxRegularValue,   getMeanValue,   getMedianValue,   getMinOutlier,   getMinRegularValue,   getOutlierCoefficient,   getOutliers,   getQ1Value,   getQ3Value,   getRangeBounds,   getRangeLowerBound,   getRangeUpperBound,   getSeriesCount,   getSeriesKey,   getX,   getXDate,   getY,   setFaroutCoefficient,   setOutlierCoefficient
Methods from org.jfree.data.xy.AbstractXYDataset:
getDomainOrder,   getXValue,   getYValue
Methods from org.jfree.data.general.AbstractSeriesDataset:
getSeriesCount,   getSeriesKey,   indexOf,   seriesChanged
Methods from org.jfree.data.general.AbstractDataset:
addChangeListener,   clone,   fireDatasetChanged,   getGroup,   hasListener,   notifyListeners,   removeChangeListener,   setGroup,   validateObject
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.jfree.data.statistics.DefaultBoxAndWhiskerXYDataset Detail:
 public  void add(Date date,
    BoxAndWhiskerItem item) 
 public Object clone() throws CloneNotSupportedException 
    Returns a clone of the plot.
 public boolean equals(Object obj) 
    Tests this dataset for equality with an arbitrary object.
 public double getFaroutCoefficient() 
    Returns the value used as the farout coefficient. The farout coefficient allows the calculation of which values will be off the graph.
 public BoxAndWhiskerItem getItem(int series,
    int item) 
    Return an item from within the dataset.
 public int getItemCount(int series) 
    Returns the number of items in the specified series.
 public Number getMaxOutlier(int series,
    int item) 
    Returns the maximum value which is not a farout, ie Q3 + (interquartile range * farout coefficient).
 public Number getMaxRegularValue(int series,
    int item) 
    Returns the max-value for the specified series and item.
 public Number getMeanValue(int series,
    int item) 
    Returns the mean for the specified series and item.
 public Number getMedianValue(int series,
    int item) 
    Returns the median-value for the specified series and item.
 public Number getMinOutlier(int series,
    int item) 
    Returns the minimum value which is not a farout.
 public Number getMinRegularValue(int series,
    int item) 
    Returns the min-value for the specified series and item.
 public double getOutlierCoefficient() 
    Returns the value used as the outlier coefficient. The outlier coefficient gives an indication of the degree of certainty in an unskewed distribution. Increasing the coefficient increases the number of values included. Currently only used to ensure farout coefficient is greater than the outlier coefficient
 public List getOutliers(int series,
    int item) 
    Returns an array of outliers for the specified series and item.
 public Number getQ1Value(int series,
    int item) 
    Returns the Q1 median-value for the specified series and item.
 public Number getQ3Value(int series,
    int item) 
    Returns the Q3 median-value for the specified series and item.
 public Range getRangeBounds(boolean includeInterval) 
    Returns the range of the values in this dataset's range.
 public double getRangeLowerBound(boolean includeInterval) 
    Returns the minimum y-value in the dataset.
 public double getRangeUpperBound(boolean includeInterval) 
    Returns the maximum y-value in the dataset.
 public int getSeriesCount() 
    Returns the number of series in the dataset.

    This implementation only allows one series.

 public Comparable getSeriesKey(int i) 
    Returns the name of the series stored in this dataset.
 public Number getX(int series,
    int item) 
    Returns the x-value for one item in a series.

    The value returned is a Long object generated from the underlying Date object.

 public Date getXDate(int series,
    int item) 
    Returns the x-value for one item in a series, as a Date.

    This method is provided for convenience only.

 public Number getY(int series,
    int item) 
    Returns the y-value for one item in a series.

    This method (from the XYDataset interface) is mapped to the getMeanValue() method.

 public  void setFaroutCoefficient(double faroutCoefficient) 
    Sets the value used as the farouts coefficient. The farout coefficient must b greater than the outlier coefficient.
 public  void setOutlierCoefficient(double outlierCoefficient) 
    Sets the value used as the outlier coefficient