001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2014, by Object Refinery Limited 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 * ValueTick.java
029 * --------------
030 * (C) Copyright 2003-2014, by Object Refinery Limited.
031 *
032 * Original Author:  David Gilbert (for Object Refinery Limited);
033 * Contributor(s):   -;
034 *
035 * Changes
036 * -------
037 * 07-Nov-2003 : Version 1 (DG);
038 * 02-Aug-2007 : Added tick type attribute (DG);
039 *
040 */
041
042package org.jfree.chart.axis;
043
044import org.jfree.ui.TextAnchor;
045
046/**
047 * A value tick.
048 */
049public abstract class ValueTick extends Tick {
050
051    /** The value. */
052    private double value;
053
054    /**
055     * The tick type (major or minor).
056     *
057     * @since 1.0.7
058     */
059    private TickType tickType;
060
061    /**
062     * Creates a new value tick.
063     *
064     * @param value  the value.
065     * @param label  the label.
066     * @param textAnchor  the part of the label that is aligned to the anchor
067     *                    point.
068     * @param rotationAnchor  defines the rotation point relative to the label.
069     * @param angle  the rotation angle (in radians).
070     */
071    public ValueTick(double value, String label,
072                     TextAnchor textAnchor, TextAnchor rotationAnchor,
073                     double angle) {
074
075        this(TickType.MAJOR, value, label, textAnchor, rotationAnchor, angle);
076        this.value = value;
077
078    }
079
080    /**
081     * Creates a new value tick.
082     *
083     * @param tickType  the tick type (major or minor, <code>null</code> not 
084     *     permitted).
085     * @param value  the value.
086     * @param label  the label.
087     * @param textAnchor  the part of the label that is aligned to the anchor
088     *                    point.
089     * @param rotationAnchor  defines the rotation point relative to the label.
090     * @param angle  the rotation angle (in radians).
091     *
092     * @since 1.0.7
093     */
094    public ValueTick(TickType tickType, double value, String label,
095                     TextAnchor textAnchor, TextAnchor rotationAnchor,
096                     double angle) {
097
098        super(label, textAnchor, rotationAnchor, angle);
099        this.value = value;
100        this.tickType = tickType;
101    }
102
103    /**
104     * Returns the value.
105     *
106     * @return The value.
107     */
108    public double getValue() {
109        return this.value;
110    }
111
112    /**
113     * Returns the tick type (major or minor).
114     *
115     * @return The tick type.
116     *
117     * @since 1.0.7
118     */
119    public TickType getTickType() {
120        return this.tickType;
121    }
122
123    /**
124     * Tests this tick for equality with an arbitrary object.
125     *
126     * @param obj  the object to test (<code>null</code> permitted).
127     *
128     * @return A boolean.
129     */
130    @Override
131    public boolean equals(Object obj) {
132        if (obj == this) {
133            return true;
134        }
135        if (!(obj instanceof ValueTick)) {
136            return false;
137        }
138        ValueTick that = (ValueTick) obj;
139        if (this.value != that.value) {
140            return false;
141        }
142        if (!this.tickType.equals(that.tickType)) {
143            return false;
144        }
145        return super.equals(obj);
146    }
147
148}