public class

OutlierListCollection

extends Object
java.lang.Object
   ↳ org.jfree.chart.renderer.OutlierListCollection

Class Overview

A collection of outlier lists for a box and whisker plot. Each collection is associated with a single box and whisker entity. Outliers are grouped in lists for each entity. Lists contain one or more outliers, determined by whether overlaps have occurred. Overlapping outliers are grouped in the same list.

See Also

Summary

Public Constructors
OutlierListCollection()
Creates a new empty collection.
Public Methods
boolean add(Outlier outlier)
Appends the specified element as a new OutlierList to the end of this list if it does not overlap an outlier in an existing list.
boolean isHighFarOut()
A flag to indicate the presence of one or more far out values at the top end of the range.
boolean isLowFarOut()
A flag to indicate the presence of one or more far out values at the bottom end of the range.
Iterator iterator()
Returns an iterator for the outlier lists.
void setHighFarOut(boolean farOut)
Sets the flag that indicates the presence of one or more far out values at the top end of the range.
void setLowFarOut(boolean farOut)
Sets the flag that indicates the presence of one or more far out values at the bottom end of the range.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public OutlierListCollection ()

Creates a new empty collection.

Public Methods

public boolean add (Outlier outlier)

Appends the specified element as a new OutlierList to the end of this list if it does not overlap an outlier in an existing list. If it does overlap, it is appended to the outlier list which it overlaps and that list is updated.

Parameters
outlier element to be appended to this list.
Returns
  • true (as per the general contract of Collection.add).

public boolean isHighFarOut ()

A flag to indicate the presence of one or more far out values at the top end of the range.

Returns
  • A boolean.

public boolean isLowFarOut ()

A flag to indicate the presence of one or more far out values at the bottom end of the range.

Returns
  • A boolean.

public Iterator iterator ()

Returns an iterator for the outlier lists.

Returns
  • An iterator.

public void setHighFarOut (boolean farOut)

Sets the flag that indicates the presence of one or more far out values at the top end of the range.

Parameters
farOut the flag.

public void setLowFarOut (boolean farOut)

Sets the flag that indicates the presence of one or more far out values at the bottom end of the range.

Parameters
farOut the flag.