Add support of LuceneSail#INDEXEDFIELDS

- add support of LuceneSail#INDEXEDFIELDS into LuceneSpinSail


Signed-off-by:Jacek Grzebyta <grzebyta.dev@gmail.com>

Author: jgrzebyta

core/sail/fts/lucene-spin/src/main/java/org/eclipse/rdf4j/lucene/spin/LuceneSpinSail.java

@@ -8,12 +8,23 @@
 package org.eclipse.rdf4j.lucene.spin;
 
 import java.io.File;
+import java.io.IOException;
+import java.io.Reader;
+import java.io.StringReader;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Map;
 import java.util.Properties;
+import java.util.Set;
+import org.eclipse.rdf4j.model.IRI;
+import org.eclipse.rdf4j.model.Statement;
+import org.eclipse.rdf4j.model.ValueFactory;
 import org.eclipse.rdf4j.sail.NotifyingSailConnection;
 import org.eclipse.rdf4j.sail.SailException;
 import org.eclipse.rdf4j.sail.evaluation.TupleFunctionEvaluationMode;
 import org.eclipse.rdf4j.sail.helpers.NotifyingSailWrapper;
 import org.eclipse.rdf4j.sail.lucene.LuceneSail;
+import static org.eclipse.rdf4j.sail.lucene.LuceneSail.INDEXEDFIELDS;
 import org.eclipse.rdf4j.sail.lucene.SearchIndex;
 import org.eclipse.rdf4j.sail.lucene.SearchIndexQueryContextInitializer;
 import org.eclipse.rdf4j.sail.lucene.util.SearchIndexUtils;
@@ -36,6 +47,10 @@ public class LuceneSpinSail extends NotifyingSailWrapper {
 
 	private Properties parameters = new Properties();
 
+	private Set<IRI> indexedFields;
+
+	private Map<IRI, IRI> indexedFieldsMapping;
+
 	public LuceneSpinSail() {
 	}
 
@@ -58,6 +73,30 @@ public void setParameters(Properties parameters) {
 	public void initialize()
 		throws SailException
 	{
+		// Add support for indexed fields
+		if (parameters.containsKey(INDEXEDFIELDS)) {
+			String indexedfieldsString = parameters.getProperty(INDEXEDFIELDS);
+			Properties prop = new Properties();
+			try (Reader reader = new StringReader(indexedfieldsString)) {
+				prop.load(reader);
+			}
+			catch (IOException e) {
+				throw new SailException("Could read " + INDEXEDFIELDS + ": " + indexedfieldsString, e);
+			}
+			ValueFactory vf = getValueFactory();
+			indexedFields = new HashSet<>();
+			indexedFieldsMapping = new HashMap<>();
+			for (Object key : prop.keySet()) {
+				String keyStr = key.toString();
+				if (keyStr.startsWith("index.")) {
+					indexedFields.add(vf.createIRI(prop.getProperty(keyStr)));
+				}
+				else {
+					indexedFieldsMapping.put(vf.createIRI(keyStr), vf.createIRI(prop.getProperty(keyStr)));
+				}
+			}
+		}
+
 		((SpinSail)getBaseSail()).setEvaluationMode(TupleFunctionEvaluationMode.TRIPLE_SOURCE);
 		parameters.setProperty(LuceneSail.INDEX_CLASS_KEY,
 				getParameters().getProperty(LuceneSail.INDEX_CLASS_KEY, LuceneSail.DEFAULT_INDEX_CLASS));
@@ -94,7 +133,38 @@ public NotifyingSailConnection getConnection()
 			throw new SailException("Index is not created");
 		}
 		// the connection from the super is created only when the index exists
-		return new LuceneSpinSailConnection(super.getConnection(), si);
+		return new LuceneSpinSailConnection(super.getConnection(), si, this);
+	}
+
+	/**
+	 * Copy of {@link LuceneSail#mapStatement(org.eclipse.rdf4j.model.Statement) }
+	 * 
+	 * @param statement
+	 * @return
+	 */
+	public Statement mapStatement(Statement statement) {
+		IRI p = statement.getPredicate();
+		boolean predicateChanged = false;
+		Map<IRI, IRI> nextIndexedFieldsMapping = indexedFieldsMapping;
+		if (nextIndexedFieldsMapping != null) {
+			IRI res = nextIndexedFieldsMapping.get(p);
+			if (res != null) {
+				p = res;
+				predicateChanged = true;
+			}
+		}
+		Set<IRI> nextIndexedFields = indexedFields;
+		if (nextIndexedFields != null && !nextIndexedFields.contains(p)) {
+			return null;
+		}
+
+		if (predicateChanged) {
+			return getValueFactory().createStatement(statement.getSubject(), p, statement.getObject(),
+					statement.getContext());
+		}
+		else {
+			return statement;
+		}
 	}
 
 }

core/sail/fts/lucene-spin/src/main/java/org/eclipse/rdf4j/lucene/spin/LuceneSpinSailConnection.java

@@ -44,6 +44,8 @@ public class LuceneSpinSailConnection extends NotifyingSailConnectionWrapper {
 
 	private final SearchIndex luceneIndex;
 
+	private final LuceneSpinSail sail;
+
 	/**
 	 * the buffer that collects operations
 	 */
@@ -58,6 +60,14 @@ public class LuceneSpinSailConnection extends NotifyingSailConnectionWrapper {
 		public void statementAdded(Statement statement) {
 			// we only consider statements that contain literals
 			if (statement.getObject() instanceof Literal) {
+
+				statement = sail.mapStatement(statement);
+
+				// process only mapped/indexable statements
+				if (statement == null) {
+					return;
+				}
+
 				// we further only index statements where the Literal's datatype is
 				// accepted
 				Literal literal = (Literal)statement.getObject();
@@ -70,6 +80,12 @@ public void statementAdded(Statement statement) {
 		public void statementRemoved(Statement statement) {
 			// we only consider statements that contain literals
 			if (statement.getObject() instanceof Literal) {
+
+				// process oly mapped/indexable statements
+				statement = sail.mapStatement(statement);
+				if (statement == null) {
+					return;
+				}
 				// we further only indexed statements where the Literal's datatype
 				// is accepted
 				Literal literal = (Literal)statement.getObject();
@@ -84,9 +100,12 @@ public void statementRemoved(Statement statement) {
 	 */
 	private final AtomicBoolean closed = new AtomicBoolean(false);
 
-	public LuceneSpinSailConnection(NotifyingSailConnection wrappedConnection, SearchIndex luceneIndex) {
+	public LuceneSpinSailConnection(NotifyingSailConnection wrappedConnection, SearchIndex luceneIndex,
+			LuceneSpinSail sail)
+	{
 		super(wrappedConnection);
 		this.luceneIndex = luceneIndex;
+		this.sail = sail;
 
 		/*
 		 * Using SailConnectionListener, see <a href="#whySailConnectionListener">above</a>

core/sail/fts/lucene-spin/src/test/java/org/eclipse/rdf4j/lucene/spin/AbstractLuceneSailSpinTest.java

@@ -1,11 +1,12 @@
-/*
- * To change this license header, choose License Headers in Project Properties.
- * To change this template file, choose Tools | Templates
- * and open the template in the editor.
+/**
+ * Copyright (c) 2017 Eclipse RDF4J contributors.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Distribution License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/org/documents/edl-v10.php.
  */
 package org.eclipse.rdf4j.lucene.spin;
 
-import com.google.common.base.Function;
 import com.google.common.collect.Lists;
 import java.util.List;
 import org.apache.commons.io.output.ByteArrayOutputStream;
@@ -17,7 +18,6 @@
 import org.eclipse.rdf4j.query.BindingSet;
 import org.eclipse.rdf4j.query.GraphQuery;
 import org.eclipse.rdf4j.query.GraphQueryResult;
-import org.eclipse.rdf4j.query.QueryEvaluationException;
 import org.eclipse.rdf4j.query.QueryLanguage;
 import org.eclipse.rdf4j.query.TupleQuery;
 import org.eclipse.rdf4j.query.TupleQueryResult;