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 * XYCoordinateType.java
029 * ---------------------
030 * (C) Copyright 2007-present, by David Gilbert and Contributors.
031 *
032 * Original Author:  David Gilbert;
033 * Contributor(s):   -;
034 *
035 */
036
037package org.jfree.chart.util;
038
039import java.io.ObjectStreamException;
040import java.io.Serializable;
041
042/**
043 * Represents several possible interpretations for an (x, y) coordinate.
044 */
045public final class XYCoordinateType implements Serializable {
046
047    /** The (x, y) coordinates represent a point in the data space. */
048    public static final XYCoordinateType DATA
049            = new XYCoordinateType("XYCoordinateType.DATA");
050
051    /**
052     * The (x, y) coordinates represent a relative position in the data space.
053     * In this case, the values should be in the range (0.0 to 1.0).
054     */
055    public static final XYCoordinateType RELATIVE
056            = new XYCoordinateType("XYCoordinateType.RELATIVE");
057
058    /**
059     * The (x, y) coordinates represent indices in a dataset.
060     * In this case, the values should be in the range (0.0 to 1.0).
061     */
062    public static final XYCoordinateType INDEX
063            = new XYCoordinateType("XYCoordinateType.INDEX");
064
065    /** The name. */
066    private String name;
067
068    /**
069     * Private constructor.
070     *
071     * @param name  the name.
072     */
073    private XYCoordinateType(String name) {
074        this.name = name;
075    }
076
077    /**
078     * Returns a string representing the object.
079     *
080     * @return The string.
081     */
082    @Override
083    public String toString() {
084        return this.name;
085    }
086
087    /**
088     * Returns {@code true} if this object is equal to the specified
089     * object, and {@code false} otherwise.
090     *
091     * @param obj  the other object.
092     *
093     * @return A boolean.
094     */
095    @Override
096    public boolean equals(Object obj) {
097        if (this == obj) {
098            return true;
099        }
100        if (!(obj instanceof XYCoordinateType)) {
101            return false;
102        }
103        XYCoordinateType order = (XYCoordinateType) obj;
104        if (!this.name.equals(order.toString())) {
105            return false;
106        }
107        return true;
108    }
109
110    /**
111     * Ensures that serialization returns the unique instances.
112     *
113     * @return The object.
114     *
115     * @throws ObjectStreamException if there is a problem.
116     */
117    private Object readResolve() throws ObjectStreamException {
118        if (this.equals(XYCoordinateType.DATA)) {
119            return XYCoordinateType.DATA;
120        }
121        else if (this.equals(XYCoordinateType.RELATIVE)) {
122            return XYCoordinateType.RELATIVE;
123        }
124        else if (this.equals(XYCoordinateType.INDEX)) {
125            return XYCoordinateType.INDEX;
126        }
127        return null;
128    }
129
130}