-
Notifications
You must be signed in to change notification settings - Fork 17
/
ResultService.java
79 lines (72 loc) · 2.78 KB
/
ResultService.java
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
/*
* Copyright 2011-2019 the original author or authors.
*
* 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 org.appng.api;
import java.sql.ResultSet;
import java.util.Collection;
import org.appng.xml.platform.Datafield;
import org.appng.xml.platform.FieldDef;
import org.appng.xml.platform.MetaData;
import org.appng.xml.platform.Result;
import org.appng.xml.platform.Resultset;
import org.springframework.data.domain.Page;
/**
*
* Provides methods to transform a bindobject to a {@link Result} and a {@link Page} of bindobjects to a
* {@link Resultset}.
*
* @author Matthias Müller
*
*/
public interface ResultService {
/**
* Builds a {@link ResultSet} from the items provided by the {@link Page}, using the {@link FieldProcessor}'s
* {@link MetaData}.
*
* @param fp
* a {@link FieldProcessor}
* @param page
* a {@link Page} of bindobjects
* @return a {@link Resultset} containing a {@link Result} for each item of the {@link Page}. Every {@link Result}
* contains a {@link Datafield} for each {@link FieldDef} provided by the {@link FieldProcessor}'s
* {@link MetaData}.
*/
Resultset getResultset(FieldProcessor fp, Page<?> page);
/**
* Builds a {@link ResultSet} from the items provided by the {@link Collection}, using the {@link FieldProcessor}'s
* {@link MetaData}.<br />
* <b>Note that pagination will not be available.</b>
*
* @param fp
* a {@link FieldProcessor}
* @param items
* a {@link Collection} of bindobjects
* @return a {@link Resultset} containing a {@link Result} for each item of the {@link Collection}. Every
* {@link Result} contains a {@link Datafield} for each {@link FieldDef} provided by the
* {@link FieldProcessor}'s {@link MetaData}.
*/
Resultset getResultset(FieldProcessor fp, Collection<?> items);
/**
* Builds a {@link Result} from the provided bindObject, using the {@link FieldProcessor}'s {@link MetaData}.
*
* @param fp
* a {@link FieldProcessor}
* @param bindObject
* a bindobject
* @return a {@link Result} containing a {@link Datafield} for each {@link FieldDef} provided by the
* {@link FieldProcessor}'s {@link MetaData}.
*/
Result getResult(FieldProcessor fp, Object bindObject);
}