public class

Outlier

extends Object
implements Comparable<T>
java.lang.Object
   ↳ org.jfree.chart.renderer.Outlier

Class Overview

Represents one outlier in the box and whisker plot.

All the coordinates in this class are in Java2D space.

Summary

Public Constructors
Outlier(double xCoord, double yCoord, double radius)
Constructs an outlier item consisting of a point and the radius of the outlier ellipse
Public Methods
int compareTo(Object o)
Compares this object with the specified object for order, based on the outlier's point.
boolean equals(Object obj)
Tests this outlier for equality with an arbitrary object.
Point2D getPoint()
Returns the xy coordinates of the bounding box containing the outlier ellipse.
double getRadius()
Returns the radius of the outlier ellipse.
double getX()
Returns the x coordinate of the bounding box containing the outlier ellipse.
double getY()
Returns the y coordinate of the bounding box containing the outlier ellipse.
boolean overlaps(Outlier other)
Returns a true if outlier is overlapped and false if it is not.
void setPoint(Point2D point)
Sets the xy coordinates of the bounding box containing the outlier ellipse.
void setRadius(double radius)
Sets the radius of the outlier ellipse.
String toString()
Returns a textual representation of the outlier.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.lang.Comparable

Public Constructors

public Outlier (double xCoord, double yCoord, double radius)

Constructs an outlier item consisting of a point and the radius of the outlier ellipse

Parameters
xCoord the x coordinate of the point.
yCoord the y coordinate of the point.
radius the radius of the ellipse.

Public Methods

public int compareTo (Object o)

Compares this object with the specified object for order, based on the outlier's point.

Parameters
o the Object to be compared.
Returns
  • A negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

public boolean equals (Object obj)

Tests this outlier for equality with an arbitrary object.

Parameters
obj the object (null permitted).
Returns
  • A boolean.

public Point2D getPoint ()

Returns the xy coordinates of the bounding box containing the outlier ellipse.

Returns
  • The location of the outlier ellipse.

public double getRadius ()

Returns the radius of the outlier ellipse.

Returns
  • The radius.

public double getX ()

Returns the x coordinate of the bounding box containing the outlier ellipse.

Returns
  • The x coordinate.

public double getY ()

Returns the y coordinate of the bounding box containing the outlier ellipse.

Returns
  • The y coordinate.

public boolean overlaps (Outlier other)

Returns a true if outlier is overlapped and false if it is not. Overlapping is determined by the respective bounding boxes plus a small margin.

Parameters
other the other outlier.
Returns
  • A boolean indicating whether or not an overlap has occurred.

public void setPoint (Point2D point)

Sets the xy coordinates of the bounding box containing the outlier ellipse.

Parameters
point the location.

public void setRadius (double radius)

Sets the radius of the outlier ellipse.

Parameters
radius the new radius.

public String toString ()

Returns a textual representation of the outlier.

Returns
  • A String representing the outlier.