Revision 20098 trunk/libraries/libFMap/src/com/iver/cit/gvsig/fmap/AtomicEvent.java
AtomicEvent.java | ||
---|---|---|
50 | 50 |
|
51 | 51 |
|
52 | 52 |
/** |
53 |
* <p><code>AtomicEvent</code> stores all the events in an ArrayList in order |
|
54 |
* to execute them atomically instead of do it sequentially. |
|
53 |
* <p>An atomic event represents a group of events that will be attended without any interruption.</p> |
|
55 | 54 |
* |
56 |
* @see FMapEvent |
|
57 |
* |
|
55 |
* <p>This kind of events are created by the buffer of events of the {@link MapContext MapContext}.</p> |
|
58 | 56 |
*/ |
59 | 57 |
public class AtomicEvent extends FMapEvent { |
60 | 58 |
/** |
61 |
* ArrayList where all the events will be stored.
|
|
59 |
* <p>Events that constitute this one.</p>
|
|
62 | 60 |
*/ |
63 | 61 |
private ArrayList events; |
64 | 62 |
|
65 | 63 |
/** |
66 |
* Constructor method that creates a new atomic event
|
|
64 |
* <p>Creates a new instance of this kind of event.</p>
|
|
67 | 65 |
* |
68 |
* @param fmapEvents ArrayList of FMapEvents.
|
|
66 |
* @param fmapEvents events that will constitute this one
|
|
69 | 67 |
*/ |
70 | 68 |
public AtomicEvent(ArrayList fmapEvents) { |
71 | 69 |
this.events = (ArrayList) fmapEvents.clone(); |
72 | 70 |
} |
73 | 71 |
|
74 | 72 |
/** |
75 |
* Returns the FMapEvent placed in the index (argument) position of the ArrayList of events. |
|
76 |
* |
|
77 |
* @param index ?ndex of the position inside the ArrayList. |
|
73 |
* <p>Returns the event at the specified position in the internal list.</p> |
|
78 | 74 |
* |
79 |
* @return FMapEvent. |
|
75 |
* @param index index of event to return |
|
76 |
* |
|
77 |
* @return event at the specified position in this list |
|
80 | 78 |
*/ |
81 | 79 |
public FMapEvent getEvent(int index) { |
82 | 80 |
return (FMapEvent) events.get(index); |
83 | 81 |
} |
84 | 82 |
|
85 | 83 |
/** |
86 |
* Returns the number of events that are contained in the ArrayList.
|
|
84 |
* <p>Returns the number of events that constitute this one.</p>
|
|
87 | 85 |
* |
88 |
* @return Number of events.
|
|
86 |
* @return number of events that constitute this one
|
|
89 | 87 |
*/ |
90 | 88 |
public int getEventCount() { |
91 | 89 |
return events.size(); |
92 | 90 |
} |
93 | 91 |
|
94 | 92 |
/** |
93 |
* <p>Returns all legend events that constitute this one.</p> |
|
95 | 94 |
* |
96 |
* Returns a vector with the legends events that are contained inside the |
|
97 |
* ArrayList of events. |
|
98 |
* |
|
99 |
* @see LegendEvent |
|
100 |
* @return Vector of legend events. |
|
95 |
* @return an array with all legend events that constitute this one |
|
101 | 96 |
*/ |
102 | 97 |
public LegendEvent[] getLegendEvents() { |
103 | 98 |
ArrayList ret = new ArrayList(); |
... | ... | |
114 | 109 |
} |
115 | 110 |
|
116 | 111 |
/** |
117 |
* Returns a vector with the events of layer collections that are contained inside the |
|
118 |
* ArrayList of events. |
|
119 |
* |
|
120 |
* @see LayerCollectionEvent |
|
121 |
* @return vector with the events of layer collections. |
|
112 |
* <p>Returns all layer collection events that constitute this one.</p> |
|
113 |
* |
|
114 |
* @return an array with all layer collection events that constitute this one |
|
122 | 115 |
*/ |
123 | 116 |
public LayerCollectionEvent[] getLayerCollectionEvents() { |
124 | 117 |
ArrayList ret = new ArrayList(); |
... | ... | |
135 | 128 |
} |
136 | 129 |
|
137 | 130 |
/** |
138 |
* Returns a vector with the events of selection that are contained inside the |
|
139 |
* ArrayList of events. |
|
140 |
* |
|
141 |
* @see SelectionEvent |
|
142 |
* @return vector with the events of selection. |
|
131 |
* <p>Returns all vector layer selection events that constitute this one.</p> |
|
132 |
* |
|
133 |
* @return an array with all vector layer selection events that constitute this one |
|
143 | 134 |
*/ |
144 | 135 |
public SelectionEvent[] getSelectionEvents() { |
145 | 136 |
ArrayList ret = new ArrayList(); |
... | ... | |
156 | 147 |
} |
157 | 148 |
|
158 | 149 |
/** |
159 |
* Returns a vector with the events of extent that are contained inside the |
|
160 |
* ArrayList of events. |
|
161 |
* |
|
162 |
* @see ExtentEvent |
|
163 |
* @return vector with the events of extent. |
|
150 |
* <p>Returns all extent events that constitute this one.</p> |
|
151 |
* |
|
152 |
* @return an array with all extent events that constitute this one |
|
164 | 153 |
*/ |
165 | 154 |
public ExtentEvent[] getExtentEvents() { |
166 | 155 |
ArrayList ret = new ArrayList(); |
... | ... | |
177 | 166 |
} |
178 | 167 |
|
179 | 168 |
/** |
180 |
* Returns a vector with the events of layer that are contained inside the |
|
181 |
* ArrayList of events |
|
169 |
* <p>Returns all layer events that constitute this one.</p> |
|
182 | 170 |
* |
183 |
* @see LayerEvent |
|
184 |
* @return vector with the events of layer. |
|
171 |
* @return an array with all layer events that constitute this one |
|
185 | 172 |
*/ |
186 | 173 |
public LayerEvent[] getLayerEvents() { |
187 | 174 |
ArrayList ret = new ArrayList(); |
... | ... | |
198 | 185 |
} |
199 | 186 |
|
200 | 187 |
/** |
201 |
* Returns a vector with the events of color that are contained inside the |
|
202 |
* ArrayList of events |
|
188 |
* <p>Returns all color events that constitute this one.</p> |
|
203 | 189 |
* |
204 |
* @see ColorEvent |
|
205 |
* @return vector with the events of color. |
|
190 |
* @return an array with all color events that constitute this one |
|
206 | 191 |
*/ |
207 | 192 |
public ColorEvent[] getColorEvents() { |
208 | 193 |
ArrayList ret = new ArrayList(); |
... | ... | |
217 | 202 |
|
218 | 203 |
return (ColorEvent[]) ret.toArray(new ColorEvent[0]); |
219 | 204 |
} |
205 |
|
|
220 | 206 |
/** |
221 |
* Returns a vector with the projection events that are contained inside the |
|
222 |
* ArrayList of events |
|
207 |
* <p>Returns all projection events that constitute this one.</p> |
|
223 | 208 |
* |
224 |
* @see ProjectionEvent |
|
225 |
* @return vector with the projection events. |
|
209 |
* @return an array with all projection events that constitute this one |
|
226 | 210 |
*/ |
227 |
|
|
228 | 211 |
public ProjectionEvent[] getProjectionEvents() { |
229 | 212 |
ArrayList ret = new ArrayList(); |
230 | 213 |
|
... | ... | |
238 | 221 |
|
239 | 222 |
return (ProjectionEvent[]) ret.toArray(new ProjectionEvent[0]); |
240 | 223 |
} |
241 |
|
|
242 | 224 |
} |
Also available in: Unified diff