org.jfree.data.statistics

Interface BoxAndWhiskerCategoryDataset

public interface BoxAndWhiskerCategoryDataset extends CategoryDataset

A category dataset that defines various medians, outliers and an average value for each item.
Method Summary
NumbergetMaxOutlier(int row, int column)
Returns the maximum outlier (non-farout) for an item.
NumbergetMaxOutlier(Comparable rowKey, Comparable columnKey)
Returns the maximum outlier (non-farout) for an item.
NumbergetMaxRegularValue(int row, int column)
Returns the maximum regular (non-outlier) value for an item.
NumbergetMaxRegularValue(Comparable rowKey, Comparable columnKey)
Returns the maximum regular (non-outlier) value for an item.
NumbergetMeanValue(int row, int column)
Returns the mean value for an item.
NumbergetMeanValue(Comparable rowKey, Comparable columnKey)
Returns the average value for an item.
NumbergetMedianValue(int row, int column)
Returns the median value for an item.
NumbergetMedianValue(Comparable rowKey, Comparable columnKey)
Returns the median value for an item.
NumbergetMinOutlier(int row, int column)
Returns the minimum outlier (non-farout) for an item.
NumbergetMinOutlier(Comparable rowKey, Comparable columnKey)
Returns the minimum outlier (non-farout) for an item.
NumbergetMinRegularValue(int row, int column)
Returns the minimum regular (non-outlier) value for an item.
NumbergetMinRegularValue(Comparable rowKey, Comparable columnKey)
Returns the minimum regular (non-outlier) value for an item.
ListgetOutliers(int row, int column)
Returns a list of outlier values for an item.
ListgetOutliers(Comparable rowKey, Comparable columnKey)
Returns a list of outlier values for an item.
NumbergetQ1Value(int row, int column)
Returns the q1median value for an item.
NumbergetQ1Value(Comparable rowKey, Comparable columnKey)
Returns the q1median value for an item.
NumbergetQ3Value(int row, int column)
Returns the q3median value for an item.
NumbergetQ3Value(Comparable rowKey, Comparable columnKey)
Returns the q3median value for an item.

Method Detail

getMaxOutlier

public Number getMaxOutlier(int row, int column)
Returns the maximum outlier (non-farout) for an item.

Parameters: row the row index (zero-based). column the column index (zero-based).

Returns: The maximum outlier.

getMaxOutlier

public Number getMaxOutlier(Comparable rowKey, Comparable columnKey)
Returns the maximum outlier (non-farout) for an item.

Parameters: rowKey the row key. columnKey the columnKey.

Returns: The maximum outlier.

getMaxRegularValue

public Number getMaxRegularValue(int row, int column)
Returns the maximum regular (non-outlier) value for an item.

Parameters: row the row index (zero-based). column the column index (zero-based).

Returns: The maximum regular value.

getMaxRegularValue

public Number getMaxRegularValue(Comparable rowKey, Comparable columnKey)
Returns the maximum regular (non-outlier) value for an item.

Parameters: rowKey the row key. columnKey the columnKey.

Returns: The maximum regular value.

getMeanValue

public Number getMeanValue(int row, int column)
Returns the mean value for an item.

Parameters: row the row index (zero-based). column the column index (zero-based).

Returns: The mean value.

getMeanValue

public Number getMeanValue(Comparable rowKey, Comparable columnKey)
Returns the average value for an item.

Parameters: rowKey the row key. columnKey the columnKey.

Returns: The average value.

getMedianValue

public Number getMedianValue(int row, int column)
Returns the median value for an item.

Parameters: row the row index (zero-based). column the column index (zero-based).

Returns: The median value.

getMedianValue

public Number getMedianValue(Comparable rowKey, Comparable columnKey)
Returns the median value for an item.

Parameters: rowKey the row key. columnKey the columnKey.

Returns: The median value.

getMinOutlier

public Number getMinOutlier(int row, int column)
Returns the minimum outlier (non-farout) for an item.

Parameters: row the row index (zero-based). column the column index (zero-based).

Returns: The minimum outlier.

getMinOutlier

public Number getMinOutlier(Comparable rowKey, Comparable columnKey)
Returns the minimum outlier (non-farout) for an item.

Parameters: rowKey the row key. columnKey the columnKey.

Returns: The minimum outlier.

getMinRegularValue

public Number getMinRegularValue(int row, int column)
Returns the minimum regular (non-outlier) value for an item.

Parameters: row the row index (zero-based). column the column index (zero-based).

Returns: The minimum regular value.

getMinRegularValue

public Number getMinRegularValue(Comparable rowKey, Comparable columnKey)
Returns the minimum regular (non-outlier) value for an item.

Parameters: rowKey the row key. columnKey the columnKey.

Returns: The minimum regular value.

getOutliers

public List getOutliers(int row, int column)
Returns a list of outlier values for an item. The list may be empty, but should never be null.

Parameters: row the row index (zero-based). column the column index (zero-based).

Returns: A list of outliers for an item.

getOutliers

public List getOutliers(Comparable rowKey, Comparable columnKey)
Returns a list of outlier values for an item. The list may be empty, but should never be null.

Parameters: rowKey the row key. columnKey the columnKey.

Returns: A list of outlier values for an item.

getQ1Value

public Number getQ1Value(int row, int column)
Returns the q1median value for an item.

Parameters: row the row index (zero-based). column the column index (zero-based).

Returns: The q1median value.

getQ1Value

public Number getQ1Value(Comparable rowKey, Comparable columnKey)
Returns the q1median value for an item.

Parameters: rowKey the row key. columnKey the columnKey.

Returns: The q1median value.

getQ3Value

public Number getQ3Value(int row, int column)
Returns the q3median value for an item.

Parameters: row the row index (zero-based). column the column index (zero-based).

Returns: The q3median value.

getQ3Value

public Number getQ3Value(Comparable rowKey, Comparable columnKey)
Returns the q3median value for an item.

Parameters: rowKey the row key. columnKey the columnKey.

Returns: The q3median value.