Logo
Distributed Genetic Programming Framework
print print

File org.jfree.chart.renderer.OutlierList.java

Here you can find all the information about the file org.jfree.chart.renderer.OutlierList.java. You may explore it here or download it onto your local disk.
/* ===========================================================
 * JFreeChart : a free chart library for the Java(tm) platform
 * ===========================================================
 *
 * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
 *
 * Project Info:  http://www.jfree.org/jfreechart/index.html
 *
 * This library is free software; you can redistribute it and/or modify it 
 * under the terms of the GNU Lesser General Public License as published by 
 * the Free Software Foundation; either version 2.1 of the License, or 
 * (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but 
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
 * USA.  
 *
 * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
 * in the United States and other countries.]
 *
 * ----------------
 * OutlierList.java
 * ----------------
 * (C) Copyright 2003, 2004, by David Browning and Contributors.
 *
 * Original Author:  David Browning (for Australian Institute of Marine 
 *                   Science);
 * Contributor(s):   David Gilbert (for Object Refinery Limited);
 *
 * $Id: OutlierList.java,v 1.2.2.1 2005/10/25 20:53:40 mungady Exp $
 *
 * Changes
 * -------
 * 05-Aug-2003 : Version 1, contributed by David Browning (DG);
 * 28-Aug-2003 : Minor tidy-up including Javadocs (DG);
 *
 */

package org.jfree.chart.renderer;

import java.awt.geom.Point2D;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

/**
 * 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.
 *
 * @author David Browning
 */

public class OutlierList {

    /** Storage for the outliers. */
    private List outliers;
    
    /** The averaged outlier. */
    private Outlier averagedOutlier;
    
    /** 
     * A flag that indicates whether or not there are multiple outliers in the 
     * list. 
     */

    private boolean multiple = false;

    /**
     * Creates a new list containing a single outlier.
     * 
     * @param outlier  the outlier.
     */

    public OutlierList(Outlier outlier) {
        this.outliers = new ArrayList();
        setAveragedOutlier(outlier);
    }

    /**
     * Adds an outlier to the list.
     * 
     * @param outlier  the outlier.
     * 
     * @return A boolean.
     */

    public boolean add(Outlier outlier) {
        return this.outliers.add(outlier);    
    }
    
    /**
     * Returns the number of outliers in the list.
     * 
     * @return The item count.
     */

    public int getItemCount() {
        return this.outliers.size();
    }
    
    /**
     * Returns the averaged outlier. 
     * 
     * @return The averaged outlier.
     */

    public Outlier getAveragedOutlier() {
        return this.averagedOutlier;
    }

    /**
     * Sets the averaged outlier.
     * 
     * @param averagedOutlier  the averaged outlier.
     */

    public void setAveragedOutlier(Outlier averagedOutlier) {
        this.averagedOutlier = averagedOutlier;
    }

    /**
     * Returns <code>true</code> if the list contains multiple outliers, and 
     * <code>false</code> otherwise.
     * 
     * @return A boolean.
     */

    public boolean isMultiple() {
        return this.multiple;
    }

    /**
     * Sets the flag that indicates whether or not this list represents 
     * multiple outliers.
     * 
     * @param multiple  the flag.
     */

    public void setMultiple(boolean multiple) {
        this.multiple = multiple;
    }

    /**
     * Returns <code>true</code> if the outlier overlaps, and 
     * <code>false</code> otherwise.
     * 
     * @param other  the outlier.
     * 
     * @return A boolean.
     */

    public boolean isOverlapped(Outlier other) {

        if (other == null) {
            return false;
        }
        
        boolean result = other.overlaps(getAveragedOutlier());
        return result;
        
    }

    /**
     * Updates the averaged outlier.
     *
     */

    public void updateAveragedOutlier() {
        double totalXCoords = 0.0;
        double totalYCoords = 0.0;
        int size = getItemCount();
        for (Iterator iterator = this.outliers.iterator(); 
             iterator.hasNext();) {
            Outlier o = (Outlier) iterator.next();
            totalXCoords += o.getX();
            totalYCoords += o.getY();
        }
        getAveragedOutlier().getPoint().setLocation(
            new Point2D.Double(totalXCoords / size, totalYCoords / size)
        );
    }

}

File Information:

file name:OutlierList.java
package:org.jfree.chart.renderer
qualified name:org.jfree.chart.renderer.OutlierList.java
file type:Java Source File
download location:download http://dgpf.sourceforge.net/source/org/jfree/chart/renderer/OutlierList.java
size:5.437 KB (5568 B)
uploaded: 2015-07-22 04:11:04 GMT+0000
last update: 2006-08-25 12:16:44 GMT+0000
last access: 2017-11-20 18:46:08 GMT+0000

statistics online since 2006-01-02.   RSS Feed
Contact us by sending an email to tweise@gmx.de to receive further information, to report errors, or to join our project.
All content on this site (http://dgpf.sourceforge.net/) is LGPL-licensed.
http://dgpf.sourceforge.net/scripts/source/source.php last modified at 2015-07-22 04:10:53 GMT+0000 served at 2017-11-20 18:46:08 GMT+0000.
Valid CSS Valid XHTML 1.1
Valid RSS SourceForge.net Logo