KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jfree > chart > plot > DatasetRenderingOrder


1 /* ===========================================================
2  * JFreeChart : a free chart library for the Java(tm) platform
3  * ===========================================================
4  *
5  * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
6  *
7  * Project Info: http://www.jfree.org/jfreechart/index.html
8  *
9  * This library is free software; you can redistribute it and/or modify it
10  * under the terms of the GNU Lesser General Public License as published by
11  * the Free Software Foundation; either version 2.1 of the License, or
12  * (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful, but
15  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
16  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
17  * License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public License
20  * along with this library; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
22  *
23  * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
24  * in the United States and other countries.]
25  *
26  * --------------------------
27  * DatasetRenderingOrder.java
28  * --------------------------
29  * (C) Copyright 2003-2005, by Object Refinery Limited.
30  *
31  * Original Author: David Gilbert (for Object Refinery Limited);
32  * Contributor(s): -;
33  *
34  * $Id: DatasetRenderingOrder.java,v 1.4 2005/05/19 14:03:42 mungady Exp $
35  *
36  * Changes:
37  * --------
38  * 02-May-2003 : Version 1 (DG);
39  * 02-Jun-2004 : Changed 'STANDARD' --> 'FORWARD' (DG);
40  *
41  */
42
43 package org.jfree.chart.plot;
44
45 import java.io.ObjectStreamException JavaDoc;
46 import java.io.Serializable JavaDoc;
47
48 /**
49  * Defines the tokens that indicate the rendering order for datasets in a
50  * {@link org.jfree.chart.plot.CategoryPlot} or an
51  * {@link org.jfree.chart.plot.XYPlot}.
52  */
53 public final class DatasetRenderingOrder implements Serializable JavaDoc {
54
55     /** For serialization. */
56     private static final long serialVersionUID = -600593412366385072L;
57
58     /**
59      * Render datasets in the order 0, 1, 2, ..., N-1, where N is the number
60      * of datasets.
61      */
62     public static final DatasetRenderingOrder FORWARD
63         = new DatasetRenderingOrder("DatasetRenderingOrder.FORWARD");
64
65     /**
66      * Render datasets in the order N-1, N-2, ..., 2, 1, 0, where N is the
67      * number of datasets.
68      */
69     public static final DatasetRenderingOrder REVERSE
70         = new DatasetRenderingOrder("DatasetRenderingOrder.REVERSE");
71
72     /** The name. */
73     private String JavaDoc name;
74
75     /**
76      * Private constructor.
77      *
78      * @param name the name.
79      */
80     private DatasetRenderingOrder(String JavaDoc name) {
81         this.name = name;
82     }
83
84     /**
85      * Returns a string representing the object.
86      *
87      * @return The string (never <code>null</code>).
88      */
89     public String JavaDoc toString() {
90         return this.name;
91     }
92
93     /**
94      * Returns <code>true</code> if this object is equal to the specified
95      * object, and <code>false</code> otherwise.
96      *
97      * @param o the other object.
98      *
99      * @return A boolean.
100      */
101     public boolean equals(Object JavaDoc o) {
102
103         if (this == o) {
104             return true;
105         }
106         if (!(o instanceof DatasetRenderingOrder)) {
107             return false;
108         }
109
110         DatasetRenderingOrder order = (DatasetRenderingOrder) o;
111         if (!this.name.equals(order.toString())) {
112             return false;
113         }
114
115         return true;
116
117     }
118     
119     /**
120      * Ensures that serialization returns the unique instances.
121      *
122      * @return The object.
123      *
124      * @throws ObjectStreamException if there is a problem.
125      */
126     private Object JavaDoc readResolve() throws ObjectStreamException JavaDoc {
127         if (this.equals(DatasetRenderingOrder.FORWARD)) {
128             return DatasetRenderingOrder.FORWARD;
129         }
130         else if (this.equals(DatasetRenderingOrder.REVERSE)) {
131             return DatasetRenderingOrder.REVERSE;
132         }
133         return null;
134     }
135
136 }
137
Popular Tags