001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-present, by David Gilbert and Contributors.
006 *
007 * Project Info:  http://www.jfree.org/jfreechart/index.html
008 *
009 * This library is free software; you can redistribute it and/or modify it
010 * under the terms of the GNU Lesser General Public License as published by
011 * the Free Software Foundation; either version 2.1 of the License, or
012 * (at your option) any later version.
013 *
014 * This library is distributed in the hope that it will be useful, but
015 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
016 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
017 * License for more details.
018 *
019 * You should have received a copy of the GNU Lesser General Public
020 * License along with this library; if not, write to the Free Software
021 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
022 * USA.
023 *
024 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 
025 * Other names may be trademarks of their respective owners.]
026 *
027 * -------------------
028 * AxisCollection.java
029 * -------------------
030 * (C) Copyright 2003-present, by David Gilbert.
031 *
032 * Original Author:  David Gilbert;
033 * Contributor(s):   -;
034 *
035 */
036
037package org.jfree.chart.axis;
038
039import java.util.List;
040import org.jfree.chart.ui.RectangleEdge;
041import org.jfree.chart.util.Args;
042
043/**
044 * A collection of axes that have been assigned to the TOP, BOTTOM, LEFT or
045 * RIGHT of a chart.  This class is used internally by JFreeChart, you won't
046 * normally need to use it yourself.
047 */
048public class AxisCollection {
049
050    /** The axes that need to be drawn at the top of the plot area. */
051    private final List axesAtTop;
052
053    /** The axes that need to be drawn at the bottom of the plot area. */
054    private final List axesAtBottom;
055
056    /** The axes that need to be drawn at the left of the plot area. */
057    private final List axesAtLeft;
058
059    /** The axes that need to be drawn at the right of the plot area. */
060    private final List axesAtRight;
061
062    /**
063     * Creates a new empty collection.
064     */
065    public AxisCollection() {
066        this.axesAtTop = new java.util.ArrayList();
067        this.axesAtBottom = new java.util.ArrayList();
068        this.axesAtLeft = new java.util.ArrayList();
069        this.axesAtRight = new java.util.ArrayList();
070    }
071
072    /**
073     * Returns a list of the axes (if any) that need to be drawn at the top of
074     * the plot area.
075     *
076     * @return A list of axes.
077     */
078    public List getAxesAtTop() {
079        return this.axesAtTop;
080    }
081
082   /**
083    * Returns a list of the axes (if any) that need to be drawn at the bottom
084    * of the plot area.
085    *
086    * @return A list of axes.
087    */
088   public List getAxesAtBottom() {
089        return this.axesAtBottom;
090    }
091
092    /**
093     * Returns a list of the axes (if any) that need to be drawn at the left
094     * of the plot area.
095     *
096     * @return A list of axes.
097     */
098    public List getAxesAtLeft() {
099        return this.axesAtLeft;
100    }
101
102    /**
103    * Returns a list of the axes (if any) that need to be drawn at the right
104    * of the plot area.
105    *
106    * @return A list of axes.
107    */
108    public List getAxesAtRight() {
109        return this.axesAtRight;
110    }
111
112    /**
113     * Adds an axis to the collection.
114     *
115     * @param axis  the axis ({@code null} not permitted).
116     * @param edge  the edge of the plot that the axis should be drawn on
117     *              ({@code null} not permitted).
118     */
119    public void add(Axis axis, RectangleEdge edge) {
120        Args.nullNotPermitted(axis, "axis");
121        Args.nullNotPermitted(edge, "edge");
122        if (edge == RectangleEdge.TOP) {
123            this.axesAtTop.add(axis);
124        }
125        else if (edge == RectangleEdge.BOTTOM) {
126            this.axesAtBottom.add(axis);
127        }
128        else if (edge == RectangleEdge.LEFT) {
129            this.axesAtLeft.add(axis);
130        }
131        else if (edge == RectangleEdge.RIGHT) {
132            this.axesAtRight.add(axis);
133        }
134    }
135
136}