1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
|
/*
* Copyright 2000-2022 Vaadin Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.vaadin.data;
import java.util.Arrays;
import java.util.Collection;
import java.util.Objects;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import com.vaadin.data.provider.DataProvider;
import com.vaadin.data.provider.HierarchicalDataProvider;
import com.vaadin.data.provider.TreeDataProvider;
/**
* A generic interface for hierarchical listing components that use a data
* provider for showing data.
*
* @author Vaadin Ltd
* @since 8.1
*
* @param <T>
* the item data type
*/
public interface HasHierarchicalDataProvider<T> extends HasDataProvider<T> {
/**
* Sets a new {@link TreeDataProvider} wrapping the given {@link TreeData}.
*
* @param treeData
* the tree data to set
*/
public default void setTreeData(TreeData<T> treeData) {
setDataProvider(new TreeDataProvider<>(treeData));
}
/**
* Gets the backing {@link TreeData} instance of the data provider, if the
* data provider is a {@link TreeDataProvider}.
*
* @return the TreeData instance used by the data provider
* @throws IllegalStateException
* if the type of the data provider is not
* {@link TreeDataProvider}
*/
@SuppressWarnings("unchecked")
public default TreeData<T> getTreeData() {
if (getDataProvider() instanceof TreeDataProvider) {
return ((TreeDataProvider<T>) getDataProvider()).getTreeData();
} else {
throw new IllegalStateException(
"Data provider is not an instance of TreeDataProvider");
}
}
/**
* Sets the root data items of this component provided as a collection and
* recursively populates them with child items with the given value
* provider.
* <p>
* The provided items are wrapped into a {@link TreeDataProvider} backed by
* a flat {@link TreeData} structure. The data provider instance is used as
* a parameter for the {@link #setDataProvider(DataProvider)} method. It
* means that the items collection can be accessed later on via
* {@link #getTreeData()}:
*
* <pre>
* <code>
* Collection<Person> grandParents = getGrandParents();
* HasHierarchicalDataProvider<Person> treeGrid = new TreeGrid<>();
* treeGrid.setItems(grandParents, Person::getChildren);
* ...
*
* TreeData<Person> data = treeGrid.getTreeData();
* </code>
* </pre>
* <p>
* The returned {@link TreeData} instance may be used as-is to add, remove
* or modify items in the hierarchy. These modifications to the object are
* not automatically reflected back to the TreeGrid. Items modified should
* be refreshed with {@link HierarchicalDataProvider#refreshItem(Object)}
* and when adding or removing items
* {@link HierarchicalDataProvider#refreshAll()} should be called.
*
* @param rootItems
* the root items to display, not {@code null}
* @param childItemProvider
* the value provider used to recursively populate the given root
* items with child items, not {@code null}
*/
public default void setItems(Collection<T> rootItems,
ValueProvider<T, Collection<T>> childItemProvider) {
Objects.requireNonNull(rootItems, "Given root items may not be null");
Objects.requireNonNull(childItemProvider,
"Given child item provider may not be null");
setDataProvider(new TreeDataProvider<>(
new TreeData<T>().addItems(rootItems, childItemProvider)));
}
/**
* Sets the root data items of this component provided as a stream and
* recursively populates them with child items with the given value
* provider.
* <p>
* The provided items are wrapped into a {@link TreeDataProvider} backed by
* a flat {@link TreeData} structure. The data provider instance is used as
* a parameter for the {@link #setDataProvider(DataProvider)} method. It
* means that the items collection can be accessed later on via
* {@link #getTreeData()}:
*
* <pre>
* <code>
* Stream<Person> grandParents = getGrandParents();
* HasHierarchicalDataProvider<Person> treeGrid = new TreeGrid<>();
* treeGrid.setItems(grandParents, Person::getChildren);
* ...
*
* TreeData<Person> data = treeGrid.getTreeData();
* </code>
* </pre>
* <p>
* The returned {@link TreeData} instance may be used as-is to add, remove
* or modify items in the hierarchy. These modifications to the object are
* not automatically reflected back to the TreeGrid. Items modified should
* be refreshed with {@link HierarchicalDataProvider#refreshItem(Object)}
* and when adding or removing items
* {@link HierarchicalDataProvider#refreshAll()} should be called.
*
* @param rootItems
* the root items to display, not {@code null}
* @param childItemProvider
* the value provider used to recursively populate the given root
* items with child items, not {@code null}
*/
public default void setItems(Stream<T> rootItems,
ValueProvider<T, Stream<T>> childItemProvider) {
Objects.requireNonNull(rootItems, "Given root items may not be null");
Objects.requireNonNull(childItemProvider,
"Given child item provider may not be null");
setDataProvider(new TreeDataProvider<>(
new TreeData<T>().addItems(rootItems, childItemProvider)));
}
/**
* Sets the data items of this component provided as a collection.
* <p>
* The provided items are wrapped into a {@link TreeDataProvider} backed by
* a flat {@link TreeData} structure. The data provider instance is used as
* a parameter for the {@link #setDataProvider(DataProvider)} method. It
* means that the items collection can be accessed later on via
* {@link #getTreeData()}:
*
* <pre>
* <code>
* HasHierarchicalDataProvider<String> treeGrid = new TreeGrid<>();
* treeGrid.setItems(Arrays.asList("a","b"));
* ...
*
* TreeData<String> data = treeGrid.getTreeData();
* </code>
* </pre>
* <p>
* The returned {@link TreeData} instance may be used as-is to add, remove
* or modify items in the hierarchy. These modifications to the object are
* not automatically reflected back to the TreeGrid. Items modified should
* be refreshed with {@link HierarchicalDataProvider#refreshItem(Object)}
* and when adding or removing items
* {@link HierarchicalDataProvider#refreshAll()} should be called.
*
* @param items
* the data items to display, not {@code null}
*/
@Override
public default void setItems(Collection<T> items) {
Objects.requireNonNull(items, "Given collection may not be null");
setDataProvider(new TreeDataProvider<>(
new TreeData<T>().addItems(null, items)));
}
/**
* Sets the data items of this component provided as a stream.
* <p>
* The provided items are wrapped into a {@link TreeDataProvider} backed by
* a flat {@link TreeData} structure. The data provider instance is used as
* a parameter for the {@link #setDataProvider(DataProvider)} method. It
* means that the items collection can be accessed later on via
* {@link #getTreeData()}:
*
* <pre>
* <code>
* HasHierarchicalDataProvider<String> treeGrid = new TreeGrid<>();
* treeGrid.setItems(Stream.of("a","b"));
* ...
*
* TreeData<String> data = treeGrid.getTreeData();
* </code>
* </pre>
* <p>
* The returned {@link TreeData} instance may be used as-is to add, remove
* or modify items in the hierarchy. These modifications to the object are
* not automatically reflected back to the TreeGrid. Items modified should
* be refreshed with {@link HierarchicalDataProvider#refreshItem(Object)}
* and when adding or removing items
* {@link HierarchicalDataProvider#refreshAll()} should be called.
*
* @param items
* the data items to display, not {@code null}
*/
@Override
public default void setItems(Stream<T> items) {
Objects.requireNonNull(items, "Given stream may not be null");
setItems(items.collect(Collectors.toList()));
}
/**
* Sets the data items of this listing.
* <p>
* The provided items are wrapped into a {@link TreeDataProvider} backed by
* a flat {@link TreeData} structure. The data provider instance is used as
* a parameter for the {@link #setDataProvider(DataProvider)} method. It
* means that the items collection can be accessed later on via
* {@link #getTreeData()}:
*
* <pre>
* <code>
* TreeGrid<String> treeGrid = new TreeGrid<>();
* treeGrid.setItems("a","b");
* ...
*
* TreeData<String> data = treeGrid.getTreeData();
* </code>
* </pre>
* <p>
* The returned {@link TreeData} instance may be used as-is to add, remove
* or modify items in the hierarchy. These modifications to the object are
* not automatically reflected back to the TreeGrid. Items modified should
* be refreshed with {@link HierarchicalDataProvider#refreshItem(Object)}
* and when adding or removing items
* {@link HierarchicalDataProvider#refreshAll()} should be called.
*
* @param items
* the data items to display, not {@code null}
*/
@Override
public default void setItems(@SuppressWarnings("unchecked") T... items) {
Objects.requireNonNull(items, "Given items may not be null");
setItems(Arrays.asList(items));
}
}
|
