blob: 453e45b1dbf2c3d71bf97b5ac98e9be1ebaa2366 (
plain)
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
|
/*
* Copyright 2000-2014 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.util;
import java.io.Serializable;
import com.vaadin.data.Container.Filter;
import com.vaadin.data.Item;
import com.vaadin.data.Property;
import com.vaadin.data.sort.SortOrder;
import com.vaadin.data.util.filter.UnsupportedFilterException;
/**
* PropertyValueGenerator for GeneratedPropertyContainer.
*
* @param <T>
* Property data type
* @since 7.4
* @author Vaadin Ltd
*/
public abstract class PropertyValueGenerator<T> implements Serializable {
/**
* Returns value for given Item. Used by GeneratedPropertyContainer when
* generating new properties.
*
* @param item
* currently handled item
* @param itemId
* item id for currently handled item
* @param propertyId
* id for this property
* @return generated value
*/
public abstract T getValue(Item item, Object itemId, Object propertyId);
/**
* Return Property type for this generator. This function is called when
* {@link Property#getType()} is called for generated property.
*
* @return type of generated property
*/
public abstract Class<T> getType();
/**
* Translates sorting of the generated property in a specific direction to a
* set of property ids and directions in the underlying container.
*
* SortOrder is similar to (or the same as) the SortOrder already defined
* for Grid.
*
* The default implementation of this method returns an empty array, which
* means that the property will not be included in
* getSortableContainerPropertyIds(). Attempting to sort by that column
* throws UnsupportedOperationException.
*
* Returning null is not allowed.
*
* @param order
* a sort order for this property
* @return an array of sort orders describing how this property is sorted
*/
public SortOrder[] getSortProperties(SortOrder order) {
return new SortOrder[] {};
}
/**
* Return an updated filter that should be compatible with the underlying
* container.
*
* This function is called when setting a filter for this generated
* property. Returning null from this function causes
* GeneratedPropertyContainer to discard the filter and not use it.
*
* By default this function throws UnsupportedFilterException.
*
* @param filter
* original filter for this property
* @return modified filter that is compatible with the underlying container
* @throws UnsupportedFilterException
*/
public Filter modifyFilter(Filter filter) throws UnsupportedFilterException {
throw new UnsupportedFilterException("Filter" + filter
+ " is not supported");
}
}
|
