Additional API to support SPARQL queries for inlined resources. (#210)

eclipse-lyo · Nov 11, 2021 · 44f8430 · 44f8430
1 parent 18ab62b
commit 44f8430
Show file tree

Hide file tree

Showing 3 changed files with 222 additions and 126 deletions.
diff --git a/store/store-core/src/main/java/org/eclipse/lyo/store/Store.java b/store/store-core/src/main/java/org/eclipse/lyo/store/Store.java
@@ -15,6 +15,7 @@
  */
 
 import org.apache.jena.rdf.model.Model;
+import org.apache.jena.arq.querybuilder.SelectBuilder;
 import java.net.URISyntaxException;
 import java.net.URI;
 import java.util.Collection;
@@ -167,8 +168,58 @@ <T extends IResource> List<T> getResources(URI namedGraphUri, Class<T> clazz, in
      *                                     occurred when working with Jena model.
      */
     <T extends IResource> List<T> getResources(URI namedGraphUri, Class<T> clazz,
-    		String prefixes, String where, String searchTerms,
-    		int limit, int offset) throws StoreAccessException, ModelUnmarshallingException;
+            String prefixes, String where, String searchTerms,
+            int limit, int offset) throws StoreAccessException, ModelUnmarshallingException;
+
+    /**
+     * Alternative to {@link Store#getResources(URI, Class, String, String, String, int, int)} with additional paramters for inlined resources.
+     *
+     * These paramters extend the default query from 
+     * 
+     * DESCRIBE ?s
+     * WHERE { 
+     *   ...
+     *   SELECT distinct ?s
+     *     WHERE {
+     *       ?s ?p ?o .
+     *       ?s rdf:type  <http://...> .
+     *       ...
+     *     }
+     * }
+     * 
+     * to
+     * 
+     * DESCRIBE ?s ?a ?b
+     * WHERE { 
+     * ...
+     *   SELECT distinct ?s ?a ?b
+     *   WHERE {
+     *     ?s  ?p        ?o .
+     *     ?s rdf:type  <http://...> .
+     *     ?s <http://...#prp1>  ?a .
+     *     ?a <http://prp2> ?b
+     *   }
+     * }
+     *  
+     *  hence allowing ?a and ?b to be described, as well as ?a 
+     *  
+     *  Corresponding paramters to acheive this:
+     *  List<String> additionalDistinctVars = new ArrayList<String>();
+     *  additionalDistinctVars.add("a");
+     *  additionalDistinctVars.add("b");
+     *  
+     *  SelectBuilder additionalQueryFilter = new SelectBuilder();
+     *  additionalQueryFilter
+     *  .addWhere( "?s", new ResourceImpl("http://...#" + "prp1"), "?a")
+     *  .addWhere( "?a", new ResourceImpl(http://...# + "prp2"), "?b");
+
+     * @param additionalDistinctVars
+     * @param additionalQueryFilter
+     */
+    <T extends IResource> List<T> getResources(URI namedGraphUri, Class<T> clazz,
+            String prefixes, String where, String searchTerms,
+            int limit, int offset, 
+            List<String> additionalDistinctVars, SelectBuilder additionalQueryFilter) throws StoreAccessException, ModelUnmarshallingException;
 
     /**
      * Retrieve a Jena model that satisfies the given where parameter as defined in the OSLC Query language (https://tools.oasis-open.org/version-control/svn/oslc-core/trunk/specs/oslc-query.html)
@@ -184,7 +235,7 @@ <T extends IResource> List<T> getResources(URI namedGraphUri, Class<T> clazz,
      * @return list of resources, size is less or equal to 'limit'
      *
      */
-	Model getResources(URI namedGraph, String prefixes, String where, int limit, int offset);
+    Model getResources(URI namedGraph, String prefixes, String where, int limit, int offset);
 
     /**
      * Retrieve a Jena model that satisfies the given where parameter as defined in the OSLC Query language (https://tools.oasis-open.org/version-control/svn/oslc-core/trunk/specs/oslc-query.html)
@@ -201,7 +252,17 @@ <T extends IResource> List<T> getResources(URI namedGraphUri, Class<T> clazz,
      * @return list of resources, size is less or equal to 'limit'
      *
      */
-	Model getResources(URI namedGraph, String prefixes, String where, String searchTerms, int limit, int offset);
+    Model getResources(URI namedGraph, String prefixes, String where, String searchTerms, int limit, int offset);
+
+
+    /**
+     * Alternative to {@link Store#getResources(URI, String, String, String, int, int)} with additional paramters for inlined resources.
+     *
+     * See {@link Store#getResources(URI, Class, String, String, String, int, int, List<String>, SelectBuilder)} for an explanation of these additional paramters.
+
+     */
+    Model getResources(URI namedGraph, String prefixes, String where, String searchTerms, int limit, int offset, 
+            List<String> additionalDistinctVars, SelectBuilder additionalQueryFilter);
 
     /**
      * Retrieve a single {@link IResource} instance specified by the concrete

diff --git a/store/store-core/src/main/java/org/eclipse/lyo/store/internals/JenaTdbStoreImpl.java b/store/store-core/src/main/java/org/eclipse/lyo/store/internals/JenaTdbStoreImpl.java
@@ -16,6 +16,8 @@
 
 import com.google.common.collect.Sets;
 import java.util.HashSet;
+
+import org.apache.jena.arq.querybuilder.SelectBuilder;
 import org.apache.jena.query.Dataset;
 import org.apache.jena.query.ReadWrite;
 import org.apache.jena.rdf.model.Model;
@@ -163,23 +165,35 @@ public <T extends IResource> List<T> getResources(final URI namedGraph,
         return resources.subList(offset, Math.min(resources.size(), offset + limit));
     }
 
-	@Override
-	public <T extends IResource> List<T> getResources(URI namedGraphUri, Class<T> clazz, String prefixes, String where,
-			String searchTerms, int limit, int offset) throws StoreAccessException, ModelUnmarshallingException {
-		throw new UnsupportedOperationException();
-	}
+    @Override
+    public <T extends IResource> List<T> getResources(URI namedGraphUri, Class<T> clazz, String prefixes, String where,
+            String searchTerms, int limit, int offset) throws StoreAccessException, ModelUnmarshallingException {
+        throw new UnsupportedOperationException();
+    }
+
+    @Override
+    public <T extends IResource> List<T> getResources(URI namedGraphUri, Class<T> clazz, String prefixes, String where,
+            String searchTerms, int limit, int offset, List<String> additionalDistinctVars, SelectBuilder additionalQueryFilter) throws StoreAccessException, ModelUnmarshallingException {
+        throw new UnsupportedOperationException();
+    }
+
+    @Override
+    public Model getResources(URI namedGraph, String prefixes, String where, int limit,
+            int offset) {
+        throw new UnsupportedOperationException();
+    }
 
-	@Override
-	public Model getResources(URI namedGraph, String prefixes, String where, int limit,
-			int offset) {
+    @Override
+    public Model getResources(URI namedGraph, String prefixes, String where, String searchTerms, int limit,
+            int offset) {
         throw new UnsupportedOperationException();
-	}
+    }
 
-	@Override
-	public Model getResources(URI namedGraph, String prefixes, String where, String searchTerms, int limit,
-			int offset) {
+    @Override
+    public Model getResources(URI namedGraph, String prefixes, String where, String searchTerms, int limit,
+            int offset, List<String> additionalDistinctVars, SelectBuilder additionalQueryFilter) {
         throw new UnsupportedOperationException();
-	}
+    }
 
     @Override
     public Set<String> keySet() {