Added
Link Here
|
1 |
/******************************************************************************* |
2 |
* Copyright (c) 2010 Ovidio Mallo and others. |
3 |
* All rights reserved. This program and the accompanying materials |
4 |
* are made available under the terms of the Eclipse Public License v1.0 |
5 |
* which accompanies this distribution, and is available at |
6 |
* http://www.eclipse.org/legal/epl-v10.html |
7 |
* |
8 |
* Contributors: |
9 |
* Ovidio Mallo - initial API and implementation (bug 305367) |
10 |
******************************************************************************/ |
11 |
|
12 |
package org.eclipse.core.tests.internal.databinding.observable.masterdetail; |
13 |
|
14 |
import java.util.ArrayList; |
15 |
import java.util.Collections; |
16 |
import java.util.List; |
17 |
|
18 |
import junit.framework.Test; |
19 |
import junit.framework.TestSuite; |
20 |
|
21 |
import org.eclipse.core.databinding.beans.BeansObservables; |
22 |
import org.eclipse.core.databinding.observable.IObservable; |
23 |
import org.eclipse.core.databinding.observable.IObservableCollection; |
24 |
import org.eclipse.core.databinding.observable.Realm; |
25 |
import org.eclipse.core.databinding.observable.list.IObservableList; |
26 |
import org.eclipse.core.databinding.observable.list.ListDiff; |
27 |
import org.eclipse.core.databinding.observable.list.ListDiffEntry; |
28 |
import org.eclipse.core.databinding.observable.list.WritableList; |
29 |
import org.eclipse.core.databinding.observable.masterdetail.IObservableFactory; |
30 |
import org.eclipse.core.databinding.observable.value.WritableValue; |
31 |
import org.eclipse.core.internal.databinding.observable.masterdetail.ListDetailValueObservableList; |
32 |
import org.eclipse.jface.databinding.conformance.ObservableListContractTest; |
33 |
import org.eclipse.jface.databinding.conformance.delegate.AbstractObservableCollectionContractDelegate; |
34 |
import org.eclipse.jface.databinding.conformance.util.ListChangeEventTracker; |
35 |
import org.eclipse.jface.examples.databinding.model.SimplePerson; |
36 |
import org.eclipse.jface.tests.databinding.AbstractDefaultRealmTestCase; |
37 |
|
38 |
/** |
39 |
* @since 1.3 |
40 |
*/ |
41 |
public class ListDetailValueObservableListTest extends |
42 |
AbstractDefaultRealmTestCase { |
43 |
|
44 |
public static Test suite() { |
45 |
TestSuite suite = new TestSuite( |
46 |
ListDetailValueObservableListTest.class.getName()); |
47 |
suite.addTestSuite(ListDetailValueObservableListTest.class); |
48 |
suite.addTest(ObservableListContractTest.suite(new Delegate())); |
49 |
return suite; |
50 |
} |
51 |
|
52 |
public void testUnmodifiability() { |
53 |
WritableList masterObservableList = new WritableList(); |
54 |
masterObservableList.add(new SimplePerson()); |
55 |
masterObservableList.add(new SimplePerson()); |
56 |
ListDetailValueObservableList ldol = new ListDetailValueObservableList( |
57 |
masterObservableList, BeansObservables.valueFactory("name"), |
58 |
null); |
59 |
|
60 |
try { |
61 |
ldol.add("name"); |
62 |
fail("ListDetailValueObservableList must not be modifiable."); |
63 |
} catch (UnsupportedOperationException e) { |
64 |
// expected exception |
65 |
} |
66 |
|
67 |
try { |
68 |
ldol.remove(masterObservableList.get(0)); |
69 |
fail("ListDetailValueObservableList must not be modifiable."); |
70 |
} catch (UnsupportedOperationException e) { |
71 |
// expected exception |
72 |
} |
73 |
|
74 |
try { |
75 |
ldol.removeAll(Collections.singleton(masterObservableList.get(0))); |
76 |
fail("ListDetailValueObservableList must not be modifiable."); |
77 |
} catch (UnsupportedOperationException e) { |
78 |
// expected exception |
79 |
} |
80 |
|
81 |
try { |
82 |
ldol.retainAll(Collections.EMPTY_LIST); |
83 |
fail("ListDetailValueObservableList must not be modifiable."); |
84 |
} catch (UnsupportedOperationException e) { |
85 |
// expected exception |
86 |
} |
87 |
|
88 |
try { |
89 |
ldol.move(0, 1); |
90 |
fail("ListDetailValueObservableList must not be modifiable."); |
91 |
} catch (UnsupportedOperationException e) { |
92 |
// expected exception |
93 |
} |
94 |
} |
95 |
|
96 |
public void testGetElementType() { |
97 |
ListDetailValueObservableList ldol = new ListDetailValueObservableList( |
98 |
new WritableList(), BeansObservables.valueFactory("name"), |
99 |
String.class); |
100 |
|
101 |
assertSame(String.class, ldol.getElementType()); |
102 |
} |
103 |
|
104 |
public void testGetObserved() { |
105 |
WritableList masterList = new WritableList(); |
106 |
ListDetailValueObservableList ldol = new ListDetailValueObservableList( |
107 |
masterList, BeansObservables.valueFactory("name"), String.class); |
108 |
|
109 |
// The observed object is the master list. |
110 |
assertSame(masterList, ldol.getObserved()); |
111 |
} |
112 |
|
113 |
public void testMasterListInitiallyNotEmpty() { |
114 |
WritableList masterList = new WritableList(); |
115 |
SimplePerson person = new SimplePerson(); |
116 |
person.setName("name"); |
117 |
masterList.add(person); |
118 |
ListDetailValueObservableList ldol = new ListDetailValueObservableList( |
119 |
masterList, BeansObservables.valueFactory("name"), String.class); |
120 |
|
121 |
// Make sure that a non-empty master list is initialized correctly. |
122 |
assertEquals(masterList.size(), ldol.size()); |
123 |
assertEquals(person.getName(), ldol.get(0)); |
124 |
} |
125 |
|
126 |
public void testAddRemove() { |
127 |
WritableList masterList = new WritableList(); |
128 |
ListDetailValueObservableList ldol = new ListDetailValueObservableList( |
129 |
masterList, BeansObservables.valueFactory("name"), String.class); |
130 |
|
131 |
// Initially, the detail list is empty. |
132 |
assertTrue(ldol.isEmpty()); |
133 |
|
134 |
// Add a first person and check that its name is in the detail list. |
135 |
SimplePerson p1 = new SimplePerson(); |
136 |
p1.setName("name1"); |
137 |
masterList.add(p1); |
138 |
assertEquals(masterList.size(), ldol.size()); |
139 |
assertEquals(p1.getName(), ldol.get(0)); |
140 |
|
141 |
// Add a second person and check that it's name is in the detail list. |
142 |
SimplePerson p2 = new SimplePerson(); |
143 |
p2.setName("name2"); |
144 |
masterList.add(p2); |
145 |
assertEquals(masterList.size(), ldol.size()); |
146 |
assertEquals(p2.getName(), ldol.get(1)); |
147 |
|
148 |
// Remove the first person from the master list and check that we still |
149 |
// have the name of the second person in the detail list. |
150 |
masterList.remove(0); |
151 |
assertEquals(masterList.size(), ldol.size()); |
152 |
assertEquals(p2.getName(), ldol.get(0)); |
153 |
|
154 |
// Remove the second person as well. |
155 |
masterList.remove(0); |
156 |
assertTrue(ldol.isEmpty()); |
157 |
} |
158 |
|
159 |
public void testChangeDetail() { |
160 |
WritableList masterList = new WritableList(); |
161 |
ListDetailValueObservableList ldol = new ListDetailValueObservableList( |
162 |
masterList, BeansObservables.valueFactory("name"), String.class); |
163 |
|
164 |
// Change the detail attribute explicitly. |
165 |
SimplePerson p1 = new SimplePerson(); |
166 |
p1.setName("name1"); |
167 |
masterList.add(p1); |
168 |
assertEquals(p1.getName(), ldol.get(0)); |
169 |
p1.setName("name2"); |
170 |
assertEquals(p1.getName(), ldol.get(0)); |
171 |
|
172 |
// Change the detail attribute by changing the master. |
173 |
SimplePerson p2 = new SimplePerson(); |
174 |
p2.setName("name3"); |
175 |
masterList.set(0, p2); |
176 |
assertEquals(p2.getName(), ldol.get(0)); |
177 |
} |
178 |
|
179 |
public void testSet() { |
180 |
WritableList masterList = new WritableList(); |
181 |
ListDetailValueObservableList ldol = new ListDetailValueObservableList( |
182 |
masterList, BeansObservables.valueFactory("name"), String.class); |
183 |
|
184 |
// Change the detail attribute explicitly. |
185 |
SimplePerson person = new SimplePerson(); |
186 |
person.setName("name1"); |
187 |
masterList.add(person); |
188 |
assertEquals(person.getName(), ldol.get(0)); |
189 |
|
190 |
// Set a new name on the detail list. |
191 |
ldol.set(0, "name2"); |
192 |
// Check that the name has been propagated to the master. |
193 |
assertEquals("name2", person.getName()); |
194 |
assertEquals(person.getName(), ldol.get(0)); |
195 |
} |
196 |
|
197 |
public void testDuplicateMasterElements() { |
198 |
WritableList masterList = new WritableList(); |
199 |
ListDetailValueObservableList ldol = new ListDetailValueObservableList( |
200 |
masterList, BeansObservables.valueFactory("name"), String.class); |
201 |
|
202 |
SimplePerson master = new SimplePerson(); |
203 |
master.setName("name1"); |
204 |
|
205 |
// Add the same master twice. |
206 |
masterList.add(master); |
207 |
masterList.add(master); |
208 |
|
209 |
// Attach the change listener to the detail list. |
210 |
ListChangeEventTracker changeTracker = ListChangeEventTracker |
211 |
.observe(ldol); |
212 |
|
213 |
// Setting the name on master should trigger an event on both |
214 |
// occurrences of in the master list. |
215 |
master.setName("name2"); |
216 |
|
217 |
// We should have 2 replace diffs, i.e. 4 diff entries. |
218 |
assertEquals(1, changeTracker.count); |
219 |
assertEquals(4, changeTracker.event.diff.getDifferences().length); |
220 |
assertReplaceDiffAt(changeTracker.event.diff, 0, 0, "name1", "name2"); |
221 |
assertReplaceDiffAt(changeTracker.event.diff, 2, 0, "name1", "name2"); |
222 |
|
223 |
// Remove one instance of the master (one will remain). |
224 |
masterList.remove(master); |
225 |
|
226 |
// It should still be possible to work on the remaining master instance. |
227 |
ldol.set(0, "name3"); |
228 |
assertEquals("name3", master.getName()); |
229 |
} |
230 |
|
231 |
public void testDetailObservableChangeEvent() { |
232 |
WritableList masterList = new WritableList(); |
233 |
ListDetailValueObservableList ldol = new ListDetailValueObservableList( |
234 |
masterList, BeansObservables.valueFactory("name"), String.class); |
235 |
|
236 |
ListChangeEventTracker changeTracker = ListChangeEventTracker |
237 |
.observe(ldol); |
238 |
|
239 |
SimplePerson person = new SimplePerson(); |
240 |
person.setName("old name"); |
241 |
|
242 |
// Initially, we should not have received any event. |
243 |
assertEquals(0, changeTracker.count); |
244 |
|
245 |
// Add the person and check that we receive an addition event on the |
246 |
// correct index and with the correct value. |
247 |
masterList.add(person); |
248 |
assertEquals(1, changeTracker.count); |
249 |
assertEquals(1, changeTracker.event.diff.getDifferences().length); |
250 |
assertTrue(changeTracker.event.diff.getDifferences()[0].isAddition()); |
251 |
assertEquals(0, |
252 |
changeTracker.event.diff.getDifferences()[0].getPosition()); |
253 |
assertEquals(person.getName(), |
254 |
changeTracker.event.diff.getDifferences()[0].getElement()); |
255 |
|
256 |
// Change the detail property and check that we receive a replace event. |
257 |
person.setName("new name"); |
258 |
assertEquals(2, changeTracker.count); |
259 |
assertIsSingleReplaceDiff(changeTracker.event.diff, 0, "old name", |
260 |
"new name"); |
261 |
} |
262 |
|
263 |
private void assertIsSingleReplaceDiff(ListDiff diff, int index, |
264 |
Object oldElement, Object newElement) { |
265 |
// We should have 2 diff entries. |
266 |
assertEquals(2, diff.getDifferences().length); |
267 |
|
268 |
// Check that it indeed is a replace diff. |
269 |
assertReplaceDiffAt(diff, 0, index, oldElement, newElement); |
270 |
} |
271 |
|
272 |
private void assertReplaceDiffAt(ListDiff diff, int diffOffset, int index, |
273 |
Object oldElement, Object newElement) { |
274 |
ListDiffEntry entry1 = diff.getDifferences()[0]; |
275 |
ListDiffEntry entry2 = diff.getDifferences()[1]; |
276 |
|
277 |
// One diff entry must be an addition, the other a removal. |
278 |
assertTrue(entry1.isAddition() != entry2.isAddition()); |
279 |
|
280 |
// Check for the index on the diff entries. |
281 |
assertEquals(index, entry1.getPosition()); |
282 |
assertEquals(index, entry2.getPosition()); |
283 |
|
284 |
// Check for the old/new element values on both diff entries. |
285 |
if (entry1.isAddition()) { |
286 |
assertEquals(oldElement, entry2.getElement()); |
287 |
assertEquals(newElement, entry1.getElement()); |
288 |
} else { |
289 |
assertEquals(oldElement, entry1.getElement()); |
290 |
assertEquals(newElement, entry2.getElement()); |
291 |
} |
292 |
} |
293 |
|
294 |
public void testMasterNull() { |
295 |
WritableList masterObservableList = new WritableList(); |
296 |
ListDetailValueObservableList ldol = new ListDetailValueObservableList( |
297 |
masterObservableList, BeansObservables.valueFactory("name"), |
298 |
String.class); |
299 |
|
300 |
// Make sure null values are handled gracefully. |
301 |
masterObservableList.add(null); |
302 |
assertEquals(1, ldol.size()); |
303 |
assertNull(ldol.get(0)); |
304 |
} |
305 |
|
306 |
public void testDetailObservableValuesAreDisposed() { |
307 |
final List detailObservables = new ArrayList(); |
308 |
IObservableFactory detailValueFactory = new IObservableFactory() { |
309 |
public IObservable createObservable(Object target) { |
310 |
WritableValue detailObservable = new WritableValue(); |
311 |
// Remember the created observables. |
312 |
detailObservables.add(detailObservable); |
313 |
return detailObservable; |
314 |
} |
315 |
}; |
316 |
|
317 |
WritableList masterList = new WritableList(); |
318 |
ListDetailValueObservableList ldol = new ListDetailValueObservableList( |
319 |
masterList, detailValueFactory, null); |
320 |
|
321 |
masterList.add(new Object()); |
322 |
masterList.add(new Object()); |
323 |
|
324 |
assertEquals(ldol.size(), detailObservables.size()); |
325 |
|
326 |
// No detail observables should be disposed yet. |
327 |
assertFalse(((WritableValue) detailObservables.get(0)).isDisposed()); |
328 |
assertFalse(((WritableValue) detailObservables.get(1)).isDisposed()); |
329 |
|
330 |
// Only the detail observable for the removed master should be disposed. |
331 |
masterList.remove(1); |
332 |
assertFalse(((WritableValue) detailObservables.get(0)).isDisposed()); |
333 |
assertTrue(((WritableValue) detailObservables.get(1)).isDisposed()); |
334 |
|
335 |
// After disposing the detail list, all detail observables should be |
336 |
// disposed. |
337 |
ldol.dispose(); |
338 |
assertTrue(((WritableValue) detailObservables.get(0)).isDisposed()); |
339 |
assertTrue(((WritableValue) detailObservables.get(1)).isDisposed()); |
340 |
} |
341 |
|
342 |
public void testDisposeOnMasterDisposed() { |
343 |
WritableList masterList = new WritableList(); |
344 |
ListDetailValueObservableList ldol = new ListDetailValueObservableList( |
345 |
masterList, BeansObservables.valueFactory("name"), String.class); |
346 |
|
347 |
// Initially, nothing should be disposed. |
348 |
assertFalse(masterList.isDisposed()); |
349 |
assertFalse(ldol.isDisposed()); |
350 |
|
351 |
// Upon disposing the master list, the detail list should be disposed as |
352 |
// well. |
353 |
masterList.dispose(); |
354 |
assertTrue(masterList.isDisposed()); |
355 |
assertTrue(ldol.isDisposed()); |
356 |
} |
357 |
|
358 |
private static class Delegate extends |
359 |
AbstractObservableCollectionContractDelegate { |
360 |
public IObservableCollection createObservableCollection(Realm realm, |
361 |
int elementCount) { |
362 |
WritableList masterList = new WritableList(realm); |
363 |
for (int i = 0; i < elementCount; i++) { |
364 |
masterList.add(new SimplePerson()); |
365 |
} |
366 |
|
367 |
return new TestListDetailValueObservableList(masterList, |
368 |
BeansObservables.valueFactory(realm, "name"), String.class); |
369 |
} |
370 |
|
371 |
public void change(IObservable observable) { |
372 |
TestListDetailValueObservableList ldol = (TestListDetailValueObservableList) observable; |
373 |
ldol.masterList.add(new SimplePerson()); |
374 |
} |
375 |
|
376 |
public Object getElementType(IObservableCollection collection) { |
377 |
return String.class; |
378 |
} |
379 |
} |
380 |
|
381 |
private static class TestListDetailValueObservableList extends |
382 |
ListDetailValueObservableList { |
383 |
final IObservableList masterList; |
384 |
|
385 |
public TestListDetailValueObservableList(IObservableList masterList, |
386 |
IObservableFactory detailValueFactory, Object detailType) { |
387 |
super(masterList, detailValueFactory, detailType); |
388 |
this.masterList = masterList; |
389 |
} |
390 |
} |
391 |
} |