-
Notifications
You must be signed in to change notification settings - Fork 14
/
Tuple.java
120 lines (111 loc) · 3.44 KB
/
Tuple.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
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
/**
* Copyright (C) 2020 Czech Technical University in Prague
*
* This program is free software: you can redistribute it and/or modify it under
* the terms of the GNU General Public License as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any
* later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details. You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package cz.cvut.kbss.jopa.model.query;
import java.util.List;
/**
* Interface for extracting the elements of a query result tuple.
*/
public interface Tuple {
/**
* Get the value of the specified tuple element.
*
* @param tupleElement
* tuple element
* @return value of tuple element
* @throws IllegalArgumentException
* if tuple element
*
* does not correspond to an element in the
*
* query result tuple
*/
<X> X get(TupleElement<X> tupleElement);
/**
* Get the value of the tuple element to which the specified alias has been
* assigned.
*
* @param alias
* alias assigned to tuple element
* @param type
* of the tuple element
* @return value of the tuple element
* @throws IllegalArgumentException
* if alias
*
* does not correspond to an element in the
*
* query result tuple or element cannot be
*
* assigned to the specified type
*/
<X> X get(String alias, Class<X> type);
/**
* Get the value of the tuple element to which the specified alias has been
* assigned.
*
* @param alias
* alias assigned to tuple element
* @return value of the tuple element
* @throws IllegalArgumentException
* if alias
*
* does not correspond to an element in the
*
* query result tuple
*/
Object get(String alias);
/**
* Get the value of the element at the specified position in the result
* tuple. The first position is 0.
*
* @param i
* position in result tuple
* @param type
* type of the tuple element
* @return value of the tuple element
* @throws IllegalArgumentException
* if i exceeds
*
* length of result tuple or element cannot be
*
* assigned to the specified type
*/
<X> X get(int i, Class<X> type);
/**
* Get the value of the element at the specified position in the result
* tuple. The first position is 0.
*
* @param i
* position in result tuple
* @return value of the tuple element
* @throws IllegalArgumentException
* if i exceeds
*
* length of result tuple
*/
Object get(int i);
/**
* Return the values of the result tuple elements as an array.
*
* @return tuple element values
*/
Object[] toArray();
/**
* Return the tuple elements.
*
* @return tuple elements
*/
List<TupleElement<?>> getElements();
}