Package org.eclipse.rdf4j.sail.lucene

Class AbstractSearchIndex

java.lang.Object

org.eclipse.rdf4j.sail.lucene.AbstractSearchIndex

All Implemented Interfaces:

SearchIndex

Direct Known Subclasses:

AbstractLuceneIndex

public abstract class AbstractSearchIndex
extends Object
implements SearchIndex

Field Summary

Fields

Modifier and Type	Field	Description
protected int	defaultNumDocs
protected int	maxDocs
protected Set<String>	wktFields

Constructor Summary

Constructors

Constructor	Description
AbstractSearchIndex()

Method Summary

Modifier and Type	Method	Description
boolean	accept(org.eclipse.rdf4j.model.Literal literal)	Returns whether the provided literal is accepted by the LuceneIndex to be indexed.
protected abstract void	addDocument(SearchDocument doc)
void	addDocuments(org.eclipse.rdf4j.model.Resource subject, List<org.eclipse.rdf4j.model.Statement> statements)	Add a complete Lucene Document based on these statements.
void	addRemoveStatements(Collection<org.eclipse.rdf4j.model.Statement> added, Collection<org.eclipse.rdf4j.model.Statement> removed)	Add many statements at the same time, remove many statements at the same time.
void	addStatement(org.eclipse.rdf4j.model.Statement statement)	Indexes the specified Statement.
protected abstract SearchDocument	copyDocument(SearchDocument doc)
protected abstract void	deleteDocument(SearchDocument doc)
Collection<org.eclipse.rdf4j.query.BindingSet>	evaluate(SearchQueryEvaluator evaluator)
protected abstract Iterable<? extends DocumentDistance>	geoQuery(org.eclipse.rdf4j.model.IRI geoProperty, org.locationtech.spatial4j.shape.Point p, org.eclipse.rdf4j.model.IRI units, double distance, String distanceVar, org.eclipse.rdf4j.query.algebra.Var context)
protected abstract Iterable<? extends DocumentResult>	geoRelationQuery(String relation, org.eclipse.rdf4j.model.IRI geoProperty, String wkt, org.eclipse.rdf4j.query.algebra.Var context)
protected abstract SearchDocument	getDocument(String id)
protected abstract Iterable<? extends SearchDocument>	getDocuments(String resourceId)
Map<org.eclipse.rdf4j.model.IRI,Set<org.eclipse.rdf4j.model.IRI>>	getIndexedTypeMapping()
protected org.eclipse.rdf4j.model.Resource	getResource(SearchDocument document)	Returns the Resource corresponding with the specified Document.
protected abstract org.locationtech.spatial4j.context.SpatialContext	getSpatialContext(String property)
void	initialize(Properties parameters)
boolean	isGeoField(String fieldName)	Returns true if the given property contains a geometry.
boolean	isIndexedTypeStatement(org.eclipse.rdf4j.model.Statement statement)	Returns true if the given statement is a type statement of the right type, see LuceneSail.INDEXEDTYPES to use.
boolean	isTypeFilteringEnabled()	is the LuceneSail.INDEXEDTYPES parameter set for this index.
boolean	isTypeStatement(org.eclipse.rdf4j.model.Statement statement)	Returns true if the given statement is a type statement, see LuceneSail.INDEXEDTYPES to use.
protected abstract BulkUpdater	newBulkUpdate()
protected abstract SearchDocument	newDocument(String id, String resourceId, String context)
protected Object	parseLuceneQueryShape(String property, String value)
protected org.locationtech.spatial4j.shape.Shape	parseQueryPoint(String property, String value)
protected org.locationtech.spatial4j.shape.Shape	parseQueryShape(String property, String value)
protected abstract Iterable<? extends DocumentScore>	query(org.eclipse.rdf4j.model.Resource subject, QuerySpec param)
void	removeStatement(org.eclipse.rdf4j.model.Statement statement)	Removes the specified Statement from the indexes.This should be called from within a begin-commit-rollback
protected abstract void	updateDocument(SearchDocument doc)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.rdf4j.sail.lucene.SearchIndex

begin, clear, clearContexts, commit, rollback, shutDown

Field Detail

defaultNumDocs

protected int defaultNumDocs

maxDocs

protected int maxDocs

wktFields

protected Set<String> wktFields

Constructor Detail

AbstractSearchIndex

public AbstractSearchIndex()

Method Detail

initialize

public void initialize(Properties parameters)
                throws Exception

Specified by:

initialize in interface SearchIndex

Throws:

Exception

getSpatialContext

protected abstract org.locationtech.spatial4j.context.SpatialContext getSpatialContext(String property)

accept

public boolean accept(org.eclipse.rdf4j.model.Literal literal)

Returns whether the provided literal is accepted by the LuceneIndex to be indexed. It for instance does not make much since to index xsd:float.

Specified by:

accept in interface SearchIndex

Parameters:

literal - the literal to be accepted

Returns:

true if the given literal will be indexed by this LuceneIndex

isGeoField

public boolean isGeoField(String fieldName)

Description copied from interface: SearchIndex

Returns true if the given property contains a geometry.

Specified by:

isGeoField in interface SearchIndex

Returns:

boolean

isTypeStatement

public boolean isTypeStatement(org.eclipse.rdf4j.model.Statement statement)

Description copied from interface: SearchIndex

Returns true if the given statement is a type statement, see LuceneSail.INDEXEDTYPES to use. This method should return false if SearchIndex.isTypeFilteringEnabled() returns false.

Specified by:

isTypeStatement in interface SearchIndex

Parameters:

statement - statement

Returns:

boolean

isTypeFilteringEnabled

public boolean isTypeFilteringEnabled()

Description copied from interface: SearchIndex

is the LuceneSail.INDEXEDTYPES parameter set for this index.

Specified by:

isTypeFilteringEnabled in interface SearchIndex

Returns:

boolean

isIndexedTypeStatement

public boolean isIndexedTypeStatement(org.eclipse.rdf4j.model.Statement statement)

Description copied from interface: SearchIndex

Returns true if the given statement is a type statement of the right type, see LuceneSail.INDEXEDTYPES to use. This method should return false if SearchIndex.isTypeFilteringEnabled() returns false.

Specified by:

isIndexedTypeStatement in interface SearchIndex

Parameters:

statement - statement

Returns:

boolean

getIndexedTypeMapping

public Map<org.eclipse.rdf4j.model.IRI,Set<org.eclipse.rdf4j.model.IRI>> getIndexedTypeMapping()

Specified by:

getIndexedTypeMapping in interface SearchIndex

Returns:

the accepted types for a particular predicate map (predicate -> [objects])

addStatement

public final void addStatement(org.eclipse.rdf4j.model.Statement statement)
                        throws IOException

Indexes the specified Statement.

Specified by:

addStatement in interface SearchIndex

Throws:

IOException

removeStatement

public final void removeStatement(org.eclipse.rdf4j.model.Statement statement)
                           throws IOException

Description copied from interface: SearchIndex

Removes the specified Statement from the indexes.This should be called from within a begin-commit-rollback

block.

Specified by:

removeStatement in interface SearchIndex

Throws:

IOException

addRemoveStatements

public final void addRemoveStatements(Collection<org.eclipse.rdf4j.model.Statement> added,
                                      Collection<org.eclipse.rdf4j.model.Statement> removed)
                               throws IOException

Add many statements at the same time, remove many statements at the same time. Ordering by resource has to be done inside this method. The passed added/removed sets are disjunct, no statement can be in both

Specified by:

addRemoveStatements in interface SearchIndex

Parameters:

added - all added statements, can have multiple subjects

removed - all removed statements, can have multiple subjects

Throws:

IOException

addDocuments

public final void addDocuments(org.eclipse.rdf4j.model.Resource subject,
                               List<org.eclipse.rdf4j.model.Statement> statements)
                        throws IOException

Add a complete Lucene Document based on these statements. Do not search for an existing document with the same subject id. (assume the existing document was deleted)

Specified by:

addDocuments in interface SearchIndex

Parameters:

statements - the statements that make up the resource

Throws:

IOException

evaluate

public final Collection<org.eclipse.rdf4j.query.BindingSet> evaluate(SearchQueryEvaluator evaluator)
                                                              throws SailException

Specified by:

evaluate in interface SearchIndex

Throws:

SailException

parseLuceneQueryShape

protected Object parseLuceneQueryShape(String property,
                                       String value)
                                throws ParseException,
                                       IOException

Throws:

ParseException

IOException

parseQueryShape

protected org.locationtech.spatial4j.shape.Shape parseQueryShape(String property,
                                                                 String value)
                                                          throws ParseException

Throws:

ParseException

parseQueryPoint

protected org.locationtech.spatial4j.shape.Shape parseQueryPoint(String property,
                                                                 String value)
                                                          throws ParseException

Throws:

ParseException

getResource

protected org.eclipse.rdf4j.model.Resource getResource(SearchDocument document)

Returns the Resource corresponding with the specified Document.

getDocument

protected abstract SearchDocument getDocument(String id)
                                       throws IOException

Throws:

IOException

getDocuments

protected abstract Iterable<? extends SearchDocument> getDocuments(String resourceId)
                                                            throws IOException

Throws:

IOException

newDocument

protected abstract SearchDocument newDocument(String id,
                                              String resourceId,
                                              String context)

copyDocument

protected abstract SearchDocument copyDocument(SearchDocument doc)

addDocument

protected abstract void addDocument(SearchDocument doc)
                             throws IOException

Throws:

IOException

updateDocument

protected abstract void updateDocument(SearchDocument doc)
                                throws IOException

Throws:

IOException

deleteDocument

protected abstract void deleteDocument(SearchDocument doc)
                                throws IOException

Throws:

IOException

query

protected abstract Iterable<? extends DocumentScore> query(org.eclipse.rdf4j.model.Resource subject,
                                                           QuerySpec param)
                                                    throws org.eclipse.rdf4j.query.MalformedQueryException,
                                                           IOException

Throws:

org.eclipse.rdf4j.query.MalformedQueryException

IOException

geoQuery

protected abstract Iterable<? extends DocumentDistance> geoQuery(org.eclipse.rdf4j.model.IRI geoProperty,
                                                                 org.locationtech.spatial4j.shape.Point p,
                                                                 org.eclipse.rdf4j.model.IRI units,
                                                                 double distance,
                                                                 String distanceVar,
                                                                 org.eclipse.rdf4j.query.algebra.Var context)
                                                          throws org.eclipse.rdf4j.query.MalformedQueryException,
                                                                 IOException

Throws:

org.eclipse.rdf4j.query.MalformedQueryException

IOException

geoRelationQuery

protected abstract Iterable<? extends DocumentResult> geoRelationQuery(String relation,
                                                                       org.eclipse.rdf4j.model.IRI geoProperty,
                                                                       String wkt,
                                                                       org.eclipse.rdf4j.query.algebra.Var context)
                                                                throws org.eclipse.rdf4j.query.MalformedQueryException,
                                                                       IOException

Throws:

org.eclipse.rdf4j.query.MalformedQueryException

IOException

newBulkUpdate

protected abstract BulkUpdater newBulkUpdate()