-
Notifications
You must be signed in to change notification settings - Fork 14
/
StorageConnector.java
120 lines (107 loc) · 4.63 KB
/
StorageConnector.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
* <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.jena.connector;
import cz.cvut.kbss.ontodriver.Closeable;
import cz.cvut.kbss.ontodriver.Wrapper;
import cz.cvut.kbss.ontodriver.jena.exception.JenaDriverException;
import org.apache.jena.rdf.model.Property;
import org.apache.jena.rdf.model.RDFNode;
import org.apache.jena.rdf.model.Resource;
import org.apache.jena.rdf.model.Statement;
import java.util.Collection;
import java.util.List;
public interface StorageConnector extends Closeable, Wrapper, StatementExecutor {
/**
* Begins a transaction.
*/
void begin();
/**
* Commits the current transaction.
*
* @throws JenaDriverException If commit fails
*/
void commit() throws JenaDriverException;
/**
* Rolls back the current transaction.
*/
void rollback();
/**
* Retrieves statements corresponding to the specified criteria from the specified named graph.
* <p>
* The first three parameters are optional, their absence signifies that any value in that position is acceptable.
* <p>
* {@code contexts} are also optional, their absence means that the default graph should be used.
*
* @param subject Statement subject, optional
* @param property Property, optional
* @param value Value, optional
* @param contexts Named graph IRIs, optional. If empty, the default graph will be used
* @return Collection of matching statements
*/
Collection<Statement> find(Resource subject, Property property, RDFNode value, Collection<String> contexts);
/**
* Checks whether the specified context (named graph) contains any statements matching the specified criteria.
* <p>
* The first three parameters are optional, their absence signifies that any value in that position is acceptable.
* <p>
* {@code context} is also optional, its absence means that the default graph should be used.
*
* @param subject Subject, optional
* @param property Property, optional
* @param value Value, optional
* @param contexts Named graph IRIs, optional. If empty, the default graph will be used
* @return {@code true} if at least one statement matches the criteria, {@code false} otherwise
*/
boolean contains(Resource subject, Property property, RDFNode value, Collection<String> contexts);
/**
* Lists all contexts (named graph) in the repository (including the transactional ones).
*
* @return List of named graph URIs
*/
List<String> getContexts();
/**
* Adds the specified statements to the specified context in the storage.
* <p>
* Requires an active transaction.
* <p>
* {@code context} is optional, its absence means that the statements will be added into the the default graph.
*
* @param statements Statements to add
* @param context Target context, optional
*/
void add(List<Statement> statements, String context);
/**
* Removes the specified statements from the specified context in the storage.
* <p>
* Requires an active transaction.
* <p>
* {@code context} is optional, its absence means that the statements will be removed from the the default graph.
*
* @param statements Statements to remove
* @param context Target context, optional
*/
void remove(List<Statement> statements, String context);
/**
* Removes statements matching the specified pattern from the specified storage context.
* <p>
* {@code context} is optional, its absence means that the statements will be removed from the the default graph.
*
* @param subject Statement subject, optional
* @param property Statement property, optional
* @param object Statement object, optional
* @param context Repository context IRI, optional
*/
void remove(Resource subject, Property property, RDFNode object, String context);
@Override
void close() throws JenaDriverException;
}