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

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

public class OutlierListCollection
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 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.

Copyright: Copyright (c) 2013

Company:

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

Constructor Summary
OutlierListCollection()
           Creates a new empty collection.
 
Method Summary
 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.
 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.
 int hashCode()
           Returns a hash code value for the object.
 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.
 java.util.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.
 java.lang.String toString()
           Returns a textual representation of the outlier.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

OutlierListCollection

public OutlierListCollection()
Creates a new empty collection.

Method Detail

isHighFarOut

public boolean isHighFarOut()
A flag to indicate the presence of one or more far out values at the top end of the range.

Returns:
boolean A boolean.

setHighFarOut

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 - boolean The flag.

isLowFarOut

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.

setLowFarOut

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 - boolean The flag.

add

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 - Outlier Element to be appended to this list.
Returns:
true As per the general contract of Collection.add().

iterator

public java.util.Iterator iterator()
Returns an iterator for the outlier lists.

Returns:
Iterator An iterator.

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.