/
IInMemoryQueryableStore.cs
278 lines (244 loc) · 13 KB
/
IInMemoryQueryableStore.cs
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
/*
// <copyright>
// dotNetRDF is free and open source software licensed under the MIT License
// -------------------------------------------------------------------------
//
// Copyright (c) 2009-2023 dotNetRDF Project (http://dotnetrdf.org/)
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is furnished
// to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// </copyright>
*/
using System;
using System.Collections.Generic;
namespace VDS.RDF
{
/// <summary>
/// Interface for Triple Stores which can be queried in memory using method calls or the SPARQL implementation contained in this library.
/// </summary>
/// <remarks>
/// <para>
/// An in memory Triple Store will typically load most of the Graphs and consequently Triples contained within it into Memory as the in memory SPARQL implementation only operates over the part of the Triple Store loaded in memory. This being said there is no reason why an in memory store can't provide a Snapshot view of an underlying store to allow only the relevant parts of Store to be loaded and queried.
/// </para>
/// <para>
/// All the Selection Methods which do not specify a subset of Graphs on such a Triple Store <strong>should</strong> operate over the entire store.
/// </para>
/// </remarks>
public interface IInMemoryQueryableStore
: ITripleStore
{
/// <summary>
/// Returns whether a given Triple is contained anywhere in the Query Triples.
/// </summary>
/// <param name="t">Triple to check for existence of.</param>
/// <returns></returns>
bool Contains(Triple t);
#region Selection over Entire Triple Store
/// <summary>
/// Selects all Triples which have a Uri Node with the given Uri from all the Query Triples.
/// </summary>
/// <param name="uri">Uri.</param>
/// <returns></returns>
IEnumerable<Triple> GetTriples(Uri uri);
/// <summary>
/// Selects all Triples which contain the given Node from all the Query Triples.
/// </summary>
/// <param name="n">Node.</param>
/// <returns></returns>
IEnumerable<Triple> GetTriples(INode n);
/// <summary>
/// Selects all Triples where the Object is a Uri Node with the given Uri from all the Query Triples.
/// </summary>
/// <param name="u">Uri.</param>
/// <returns></returns>
IEnumerable<Triple> GetTriplesWithObject(Uri u);
/// <summary>
/// Selects all Triples where the Object is a given Node from all the Query Triples.
/// </summary>
/// <param name="n">Node.</param>
/// <returns></returns>
IEnumerable<Triple> GetTriplesWithObject(INode n);
/// <summary>
/// Selects all Triples where the Predicate is a given Node from all the Query Triples.
/// </summary>
/// <param name="n">Node.</param>
/// <returns></returns>
IEnumerable<Triple> GetTriplesWithPredicate(INode n);
/// <summary>
/// Selects all Triples where the Predicate is a Uri Node with the given Uri from all the Query Triples.
/// </summary>
/// <param name="u">Uri.</param>
/// <returns></returns>
IEnumerable<Triple> GetTriplesWithPredicate(Uri u);
/// <summary>
/// Selects all Triples where the Subject is a given Node from all the Query Triples.
/// </summary>
/// <param name="n">Node.</param>
/// <returns></returns>
IEnumerable<Triple> GetTriplesWithSubject(INode n);
/// <summary>
/// Selects all Triples where the Subject is a Uri Node with the given Uri from all the Query Triples.
/// </summary>
/// <param name="u">Uri.</param>
/// <returns></returns>
IEnumerable<Triple> GetTriplesWithSubject(Uri u);
/// <summary>
/// Selects all the Triples with the given Subject-Predicate pair from all the Query Triples.
/// </summary>
/// <param name="subj">Subject.</param>
/// <param name="predicate">Predicate.</param>
/// <returns></returns>
IEnumerable<Triple> GetTriplesWithSubjectPredicate(INode subj, INode predicate);
/// <summary>
/// Selects all the Triples with the given Predicate-Object pair from all the Query Triples.
/// </summary>
/// <param name="predicate">Predicate.</param>
/// <param name="obj">Object.</param>
/// <returns></returns>
IEnumerable<Triple> GetTriplesWithPredicateObject(INode predicate, INode obj);
/// <summary>
/// Selects all the Triples with the given Subject-Object pair from all the Query Triples.
/// </summary>
/// <param name="subj">Subject.</param>
/// <param name="obj">Object.</param>
/// <returns></returns>
IEnumerable<Triple> GetTriplesWithSubjectObject(INode subj, INode obj);
#endregion
#region Selection over a Subset of the Store
/// <summary>
/// Selects all Triples which have a Uri Node with the given Uri from a Subset of Graphs in the Triple Store.
/// </summary>
/// <param name="graphUris">List of the Graph URIs of Graphs you want to select over.</param>
/// <param name="uri">Uri.</param>
/// <returns></returns>
[Obsolete("Replaced by GetTriples(List<IRefNode>, Uri)")]
IEnumerable<Triple> GetTriples(List<Uri> graphUris, Uri uri);
/// <summary>
/// Selects all Triples which contain the given Node from a Subset of Graphs in the Triple Store.
/// </summary>
/// <param name="graphUris">List of the Graph URIs of Graphs you want to select over.</param>
/// <param name="n">Node.</param>
/// <returns></returns>
[Obsolete("Replaced by GetTriples(List<IRefNode>, INode)")]
IEnumerable<Triple> GetTriples(List<Uri> graphUris, INode n);
/// <summary>
/// Selects all Triples where the Object is a Uri Node with the given Uri from a Subset of Graphs in the Triple Store.
/// </summary>
/// <param name="graphUris">List of the Graph URIs of Graphs you want to select over.</param>
/// <param name="u">Uri.</param>
/// <returns></returns>
[Obsolete("Replaced by GetTriplesWithObject(List<IRefNode>, Uri)")]
IEnumerable<Triple> GetTriplesWithObject(List<Uri> graphUris, Uri u);
/// <summary>
/// Selects all Triples where the Object is a given Node from a Subset of Graphs in the Triple Store.
/// </summary>
/// <param name="graphUris">List of the Graph URIs of Graphs you want to select over.</param>
/// <param name="n">Node.</param>
/// <returns></returns>
[Obsolete("Replaced by GetTriplesWithObject(List<IRefNode>, INode)")]
IEnumerable<Triple> GetTriplesWithObject(List<Uri> graphUris, INode n);
/// <summary>
/// Selects all Triples where the Predicate is a given Node from a Subset of Graphs in the Triple Store.
/// </summary>
/// <param name="graphUris">List of the Graph URIs of Graphs you want to select over.</param>
/// <param name="n">Node.</param>
/// <returns></returns>
[Obsolete("Replaced by GetTriplesWithPredicate(List<IRefNode>, INode)")]
IEnumerable<Triple> GetTriplesWithPredicate(List<Uri> graphUris, INode n);
/// <summary>
/// Selects all Triples where the Predicate is a Uri Node with the given Uri from a Subset of Graphs in the Triple Store.
/// </summary>
/// <param name="graphUris">List of the Graph URIs of Graphs you want to select over.</param>
/// <param name="u">Uri.</param>
/// <returns></returns>
[Obsolete("Replaced by GetTriplesWithPredicate(List<IRefNode>, Uri)")]
IEnumerable<Triple> GetTriplesWithPredicate(List<Uri> graphUris, Uri u);
/// <summary>
/// Selects all Triples where the Subject is a given Node from a Subset of Graphs in the Triple Store.
/// </summary>
/// <param name="graphUris">List of the Graph URIs of Graphs you want to select over.</param>
/// <param name="n">Node.</param>
/// <returns></returns>
[Obsolete("Replaced by GetTriplesWithSubject(List<IRefNode>, INode)")]
IEnumerable<Triple> GetTriplesWithSubject(List<Uri> graphUris, INode n);
/// <summary>
/// Selects all Triples where the Subject is a Uri Node with the given Uri from a Subset of Graphs in the Triple Store.
/// </summary>
/// <param name="graphUris">List of the Graph URIs of Graphs you want to select over.</param>
/// <param name="u">Uri.</param>
/// <returns></returns>
[Obsolete("Replaced by GetTriplesWithSubject(List<IRefNode>, Uri)")]
IEnumerable<Triple> GetTriplesWithSubject(List<Uri> graphUris, Uri u);
/// <summary>
/// Selects all Triples which have a Uri Node with the given Uri from a Subset of Graphs in the Triple Store.
/// </summary>
/// <param name="graphNames">List of the names of Graphs you want to select over.</param>
/// <param name="uri">Uri.</param>
/// <returns></returns>
IEnumerable<Triple> GetTriples(List<IRefNode> graphNames, Uri uri);
/// <summary>
/// Selects all Triples which contain the given Node from a Subset of Graphs in the Triple Store.
/// </summary>
/// <param name="graphNames">List of the names of Graphs you want to select over.</param>
/// <param name="n">Node.</param>
/// <returns></returns>
IEnumerable<Triple> GetTriples(List<IRefNode> graphNames, INode n);
/// <summary>
/// Selects all Triples where the Object is a Uri Node with the given Uri from a Subset of Graphs in the Triple Store.
/// </summary>
/// <param name="graphNames">List of the names of Graphs you want to select over.</param>
/// <param name="u">Uri.</param>
/// <returns></returns>
IEnumerable<Triple> GetTriplesWithObject(List<IRefNode> graphNames, Uri u);
/// <summary>
/// Selects all Triples where the Object is a given Node from a Subset of Graphs in the Triple Store.
/// </summary>
/// <param name="graphNames">List of the names of Graphs you want to select over.</param>
/// <param name="n">Node.</param>
/// <returns></returns>
IEnumerable<Triple> GetTriplesWithObject(List<IRefNode> graphNames, INode n);
/// <summary>
/// Selects all Triples where the Predicate is a given Node from a Subset of Graphs in the Triple Store.
/// </summary>
/// <param name="graphNames">List of the names of Graphs you want to select over.</param>
/// <param name="n">Node.</param>
/// <returns></returns>
IEnumerable<Triple> GetTriplesWithPredicate(List<IRefNode> graphNames, INode n);
/// <summary>
/// Selects all Triples where the Predicate is a Uri Node with the given Uri from a Subset of Graphs in the Triple Store.
/// </summary>
/// <param name="graphNames">List of the names of Graphs you want to select over.</param>
/// <param name="u">Uri.</param>
/// <returns></returns>
IEnumerable<Triple> GetTriplesWithPredicate(List<IRefNode> graphNames, Uri u);
/// <summary>
/// Selects all Triples where the Subject is a given Node from a Subset of Graphs in the Triple Store.
/// </summary>
/// <param name="graphNames">List of the names of Graphs you want to select over.</param>
/// <param name="n">Node.</param>
/// <returns></returns>
IEnumerable<Triple> GetTriplesWithSubject(List<IRefNode> graphNames, INode n);
/// <summary>
/// Selects all Triples where the Subject is a Uri Node with the given Uri from a Subset of Graphs in the Triple Store.
/// </summary>
/// <param name="graphNames">List of the names of Graphs you want to select over.</param>
/// <param name="u">Uri.</param>
/// <returns></returns>
IEnumerable<Triple> GetTriplesWithSubject(List<IRefNode> graphNames, Uri u);
#endregion
}
}