-
Notifications
You must be signed in to change notification settings - Fork 14
/
Statement.java
93 lines (84 loc) · 3.21 KB
/
Statement.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
/**
* Copyright (C) 2016 Czech Technical University in Prague
* <p>
* 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.
* <p>
* 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.ontodriver;
import cz.cvut.kbss.ontodriver.exception.OntoDriverException;
/**
* This interface represents a SPARQL statement.
*/
public interface Statement extends AutoCloseable {
/**
* Specifies which ontology is used for statement evaluation.
*/
enum StatementOntology {
/**
* Transactional ontology. May contain uncommitted changes which influence the statement evaluation.
*/
TRANSACTIONAL,
/**
* The main ontology in the current state. No uncommitted changes are present in it.
*/
CENTRAL
}
/**
* Execute the specified SPARQL query.
*
* @param sparql The statement to execute
* @return {@code ResultSet} containing results of the query
* @throws OntoDriverException If an error occurs during query execution
*/
ResultSet executeQuery(String sparql) throws OntoDriverException;
/**
* Execute the specified SPARQL update query.
*
* @param sparql The statement to execute
* @throws OntoDriverException If an error occurs during query execution
*/
void executeUpdate(String sparql) throws OntoDriverException;
/**
* Sets which ontology is used to evaluate this statement.
* <p>
* {@link Statement.StatementOntology#TRANSACTIONAL} ontology is the transactional
* snapshot. It may contain uncommitted changes and thus the query results may differ from evaluation against {@link
* Statement.StatementOntology#CENTRAL}.
*
* @param ontology Which ontology to use
*/
void useOntology(StatementOntology ontology);
/**
* Gets information about which ontology will be used to evaluate the statement.
*
* @return Which ontology will be used for evaluation
* @see #useOntology(StatementOntology)
*/
StatementOntology getStatementOntology();
/**
* Whether this statement is still open.
* <p>
* A {@code Statement} is closed if the method {@link #close()} has been called on it.
*
* @return Open status
*/
boolean isOpen();
/**
* Closes this statement, releasing any resources it has hold.
* <p>
* Calling the method close on a Statement object that is already closed has no effect.
*
* @throws OntoDriverException If closing the statement fails
* @apiNote When a {@code Statement} object is closed, its current {@code ResultSet} object, if one exists, is also closed.
*/
@Override
void close() throws OntoDriverException;
}