Dataset.html 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html lang="en">
  3. <head>
  4. <title>Source code</title>
  5. <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
  6. </head>
  7. <body>
  8. <div class="sourceContainer">
  9. <pre><span class="sourceLineNo">001</span>/* ===========================================================<a name="line.1"></a>
  10. <span class="sourceLineNo">002</span> * JFreeChart : a free chart library for the Java(tm) platform<a name="line.2"></a>
  11. <span class="sourceLineNo">003</span> * ===========================================================<a name="line.3"></a>
  12. <span class="sourceLineNo">004</span> *<a name="line.4"></a>
  13. <span class="sourceLineNo">005</span> * (C) Copyright 2000-2013, by Object Refinery Limited and Contributors.<a name="line.5"></a>
  14. <span class="sourceLineNo">006</span> *<a name="line.6"></a>
  15. <span class="sourceLineNo">007</span> * Project Info: http://www.jfree.org/jfreechart/index.html<a name="line.7"></a>
  16. <span class="sourceLineNo">008</span> *<a name="line.8"></a>
  17. <span class="sourceLineNo">009</span> * This library is free software; you can redistribute it and/or modify it<a name="line.9"></a>
  18. <span class="sourceLineNo">010</span> * under the terms of the GNU Lesser General Public License as published by<a name="line.10"></a>
  19. <span class="sourceLineNo">011</span> * the Free Software Foundation; either version 2.1 of the License, or<a name="line.11"></a>
  20. <span class="sourceLineNo">012</span> * (at your option) any later version.<a name="line.12"></a>
  21. <span class="sourceLineNo">013</span> *<a name="line.13"></a>
  22. <span class="sourceLineNo">014</span> * This library is distributed in the hope that it will be useful, but<a name="line.14"></a>
  23. <span class="sourceLineNo">015</span> * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY<a name="line.15"></a>
  24. <span class="sourceLineNo">016</span> * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public<a name="line.16"></a>
  25. <span class="sourceLineNo">017</span> * License for more details.<a name="line.17"></a>
  26. <span class="sourceLineNo">018</span> *<a name="line.18"></a>
  27. <span class="sourceLineNo">019</span> * You should have received a copy of the GNU Lesser General Public<a name="line.19"></a>
  28. <span class="sourceLineNo">020</span> * License along with this library; if not, write to the Free Software<a name="line.20"></a>
  29. <span class="sourceLineNo">021</span> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,<a name="line.21"></a>
  30. <span class="sourceLineNo">022</span> * USA.<a name="line.22"></a>
  31. <span class="sourceLineNo">023</span> *<a name="line.23"></a>
  32. <span class="sourceLineNo">024</span> * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. <a name="line.24"></a>
  33. <span class="sourceLineNo">025</span> * Other names may be trademarks of their respective owners.]<a name="line.25"></a>
  34. <span class="sourceLineNo">026</span> *<a name="line.26"></a>
  35. <span class="sourceLineNo">027</span> * ------------<a name="line.27"></a>
  36. <span class="sourceLineNo">028</span> * Dataset.java<a name="line.28"></a>
  37. <span class="sourceLineNo">029</span> * ------------<a name="line.29"></a>
  38. <span class="sourceLineNo">030</span> * (C) Copyright 2000-2008, by Object Refinery Limited.<a name="line.30"></a>
  39. <span class="sourceLineNo">031</span> *<a name="line.31"></a>
  40. <span class="sourceLineNo">032</span> * Original Author: David Gilbert (for Object Refinery Limited);<a name="line.32"></a>
  41. <span class="sourceLineNo">033</span> * Contributor(s): -;<a name="line.33"></a>
  42. <span class="sourceLineNo">034</span> *<a name="line.34"></a>
  43. <span class="sourceLineNo">035</span> * Changes (from 18-Sep-2001)<a name="line.35"></a>
  44. <span class="sourceLineNo">036</span> * --------------------------<a name="line.36"></a>
  45. <span class="sourceLineNo">037</span> * 18-Sep-2001 : Added standard header and fixed DOS encoding problem (DG);<a name="line.37"></a>
  46. <span class="sourceLineNo">038</span> * 15-Oct-2001 : Moved to a new package (com.jrefinery.data.*) (DG);<a name="line.38"></a>
  47. <span class="sourceLineNo">039</span> * 22-Oct-2001 : Changed name to Dataset.java (DG);<a name="line.39"></a>
  48. <span class="sourceLineNo">040</span> * 17-Nov-2001 : Added getLegendItemCount() and getLegendItemLabels() methods,<a name="line.40"></a>
  49. <span class="sourceLineNo">041</span> * created SeriesDataset interface and transferred series related<a name="line.41"></a>
  50. <span class="sourceLineNo">042</span> * methods out (DG);<a name="line.42"></a>
  51. <span class="sourceLineNo">043</span> * 22-Jan-2002 : Reconsidered (and removed) the getLegendItemCount() and<a name="line.43"></a>
  52. <span class="sourceLineNo">044</span> * getLegendItemLabels() methods...leave this to client code (DG);<a name="line.44"></a>
  53. <span class="sourceLineNo">045</span> * 27-Sep-2002 : Added get/setDatasetGroup() methods (DG);<a name="line.45"></a>
  54. <span class="sourceLineNo">046</span> * 10-Jan-2003 : Updated Javadocs (DG);<a name="line.46"></a>
  55. <span class="sourceLineNo">047</span> *<a name="line.47"></a>
  56. <span class="sourceLineNo">048</span> */<a name="line.48"></a>
  57. <span class="sourceLineNo">049</span><a name="line.49"></a>
  58. <span class="sourceLineNo">050</span>package org.jfree.data.general;<a name="line.50"></a>
  59. <span class="sourceLineNo">051</span><a name="line.51"></a>
  60. <span class="sourceLineNo">052</span>/**<a name="line.52"></a>
  61. <span class="sourceLineNo">053</span> * The base interface for data sets.<a name="line.53"></a>
  62. <span class="sourceLineNo">054</span> * &lt;P&gt;<a name="line.54"></a>
  63. <span class="sourceLineNo">055</span> * All datasets are required to support the {@link DatasetChangeEvent}<a name="line.55"></a>
  64. <span class="sourceLineNo">056</span> * mechanism by allowing listeners to register and receive notification of any<a name="line.56"></a>
  65. <span class="sourceLineNo">057</span> * changes to the dataset.<a name="line.57"></a>
  66. <span class="sourceLineNo">058</span> * &lt;P&gt;<a name="line.58"></a>
  67. <span class="sourceLineNo">059</span> * In addition, all datasets must belong to one (and only one)<a name="line.59"></a>
  68. <span class="sourceLineNo">060</span> * {@link DatasetGroup}. The group object maintains a reader-writer lock<a name="line.60"></a>
  69. <span class="sourceLineNo">061</span> * which provides synchronised access to the datasets in multi-threaded code.<a name="line.61"></a>
  70. <span class="sourceLineNo">062</span> */<a name="line.62"></a>
  71. <span class="sourceLineNo">063</span>public interface Dataset {<a name="line.63"></a>
  72. <span class="sourceLineNo">064</span><a name="line.64"></a>
  73. <span class="sourceLineNo">065</span> /**<a name="line.65"></a>
  74. <span class="sourceLineNo">066</span> * Registers an object for notification of changes to the dataset.<a name="line.66"></a>
  75. <span class="sourceLineNo">067</span> *<a name="line.67"></a>
  76. <span class="sourceLineNo">068</span> * @param listener the object to register.<a name="line.68"></a>
  77. <span class="sourceLineNo">069</span> */<a name="line.69"></a>
  78. <span class="sourceLineNo">070</span> public void addChangeListener(DatasetChangeListener listener);<a name="line.70"></a>
  79. <span class="sourceLineNo">071</span><a name="line.71"></a>
  80. <span class="sourceLineNo">072</span> /**<a name="line.72"></a>
  81. <span class="sourceLineNo">073</span> * Deregisters an object for notification of changes to the dataset.<a name="line.73"></a>
  82. <span class="sourceLineNo">074</span> *<a name="line.74"></a>
  83. <span class="sourceLineNo">075</span> * @param listener the object to deregister.<a name="line.75"></a>
  84. <span class="sourceLineNo">076</span> */<a name="line.76"></a>
  85. <span class="sourceLineNo">077</span> public void removeChangeListener(DatasetChangeListener listener);<a name="line.77"></a>
  86. <span class="sourceLineNo">078</span><a name="line.78"></a>
  87. <span class="sourceLineNo">079</span> /**<a name="line.79"></a>
  88. <span class="sourceLineNo">080</span> * Returns the dataset group.<a name="line.80"></a>
  89. <span class="sourceLineNo">081</span> *<a name="line.81"></a>
  90. <span class="sourceLineNo">082</span> * @return The dataset group.<a name="line.82"></a>
  91. <span class="sourceLineNo">083</span> */<a name="line.83"></a>
  92. <span class="sourceLineNo">084</span> public DatasetGroup getGroup();<a name="line.84"></a>
  93. <span class="sourceLineNo">085</span><a name="line.85"></a>
  94. <span class="sourceLineNo">086</span> /**<a name="line.86"></a>
  95. <span class="sourceLineNo">087</span> * Sets the dataset group.<a name="line.87"></a>
  96. <span class="sourceLineNo">088</span> *<a name="line.88"></a>
  97. <span class="sourceLineNo">089</span> * @param group the dataset group.<a name="line.89"></a>
  98. <span class="sourceLineNo">090</span> */<a name="line.90"></a>
  99. <span class="sourceLineNo">091</span> public void setGroup(DatasetGroup group);<a name="line.91"></a>
  100. <span class="sourceLineNo">092</span><a name="line.92"></a>
  101. <span class="sourceLineNo">093</span>}<a name="line.93"></a>
  102. </pre>
  103. </div>
  104. </body>
  105. </html>