com.ijchart.xychart.render.category.outlier
Class OutlierList

java.lang.Object
  extended by com.ijchart.xychart.render.category.outlier.OutlierList
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class OutlierList
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

Title: IJChart

Description: a chart library for the Java(tm) platform.

A collection of outliers for a single entity in a box and whisker plot. Outliers are grouped in lists for each entity. Lists contain one or more outliers, determined by whether overlaps have occured. Overlapping outliers are grouped in the same list. Each list contains an averaged outlier, which is the same as a single outlier if there is only one outlier in the list, but the average of all the outliers in the list if there is more than one. NB This is simply my scheme for displaying outliers, and might not be acceptable by the wider community.

Copyright: Copyright (c) 2013

Company:

Version:
1.0
Author:
zhang feng min,shanghai china. Contract me by email.
See Also:
Serialized Form

Constructor Summary
OutlierList(Outlier outlier)
           Creates a new list containing a single outlier.
 
Method Summary
 boolean add(Outlier outlier)
           Adds an outlier to the list.
 java.lang.Object clone()
           Creates and returns a copy of this object.
 boolean equals(java.lang.Object obj)
           Tests this instance for equality with an arbitrary object.
 Outlier getAveragedOutlier()
           Returns the averaged outlier.
 int getItemCount()
           Returns the number of outliers in the list.
 int hashCode()
           Returns a hash code value for the object.
 boolean isMultiple()
           Returns true if the list contains multiple outliers, and false otherwise.
 boolean isOverlapped(Outlier other)
           Returns true if the outlier overlaps, and false otherwise.
 void setAveragedOutlier(Outlier averagedOutlier)
           Sets the averaged outlier.
 void setMultiple(boolean multiple)
           Sets the flag that indicates whether or not this list represents multiple outliers.
 java.lang.String toString()
           Returns a textual representation of the outlier.
 void updateAveragedOutlier()
           Updates the averaged outlier.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

OutlierList

public OutlierList(Outlier outlier)
Creates a new list containing a single outlier.

Parameters:
outlier - Outlier The outlier.
Method Detail

add

public boolean add(Outlier outlier)
Adds an outlier to the list.

Parameters:
outlier - Outlier The outlier.
Returns:
A boolean.

getItemCount

public int getItemCount()
Returns the number of outliers in the list.

Returns:
int The item count.

getAveragedOutlier

public Outlier getAveragedOutlier()
Returns the averaged outlier.

Returns:
The averaged outlier.

setAveragedOutlier

public void setAveragedOutlier(Outlier averagedOutlier)
Sets the averaged outlier.

Parameters:
averagedOutlier - Outlier The averaged outlier.

isMultiple

public boolean isMultiple()
Returns true if the list contains multiple outliers, and false otherwise.

Returns:
boolean A boolean.

setMultiple

public void setMultiple(boolean multiple)
Sets the flag that indicates whether or not this list represents multiple outliers.

Parameters:
multiple - boolean A boolean.

isOverlapped

public boolean isOverlapped(Outlier other)
Returns true if the outlier overlaps, and false otherwise.

Parameters:
other - Outlier The outlier.
Returns:
A boolean.

updateAveragedOutlier

public void updateAveragedOutlier()
Updates the averaged outlier.


equals

public boolean equals(java.lang.Object obj)
Tests this instance for equality with an arbitrary object.

Overrides:
equals in class java.lang.Object
Parameters:
obj - the object (null permitted).
Returns:
A boolean.

hashCode

public int hashCode()
Returns a hash code value for the object.

Overrides:
hashCode in class java.lang.Object
Returns:
int A hash code value for this object.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Creates and returns a copy of this object.

Overrides:
clone in class java.lang.Object
Returns:
object a clone of this instance.
Throws:
java.lang.CloneNotSupportedException - if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

toString

public java.lang.String toString()
Returns a textual representation of the outlier.

Overrides:
toString in class java.lang.Object
Returns:
A String representing the outlier.