Package org.eclipse.rdf4j.sail.lucene

Class QuerySpec

java.lang.Object

org.eclipse.rdf4j.sail.lucene.AbstractSearchQueryEvaluator

org.eclipse.rdf4j.sail.lucene.QuerySpec

All Implemented Interfaces:

SearchQueryEvaluator

public class QuerySpec
extends AbstractSearchQueryEvaluator

A QuerySpec holds information extracted from a TupleExpr corresponding with a single Lucene query. Access the patterns or use the get-methods to get the names of the variables to bind.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QuerySpec.QueryParam	Param in a Lucene query extracted in QuerySpec

Constructor Summary

Constructors

Constructor	Description
QuerySpec(String matchesVarName, String propertyVarName, String scoreVarName, String snippetVarName, Resource subject, String queryString, IRI propertyURI)
QuerySpec(StatementPattern matchesPattern, Collection<QuerySpec.QueryParam> queryPatterns, StatementPattern scorePattern, StatementPattern typePattern, StatementPattern idPattern, Resource subject)
QuerySpec(StatementPattern matchesPattern, Collection<QuerySpec.QueryParam> queryPatterns, StatementPattern scorePattern, StatementPattern typePattern, StatementPattern idPattern, StatementPattern numDocsPattern, Resource subject)

Method Summary

Modifier and Type	Method	Description
String	getCatQuery()
StatementPattern	getIdPattern()
StatementPattern	getMatchesPattern()
String	getMatchesVariableName()	return the name of the bound variable that should match the query
Integer	getNumDocs()
StatementPattern	getNumDocsPattern()
QueryModelNode	getParentQueryModelNode()
Collection<QuerySpec.QueryParam>	getQueryPatterns()
IRI	getQueryType()	the type of query, must equal LuceneSailSchema.LUCENE_QUERY.
StatementPattern	getScorePattern()
String	getScoreVariableName()	The variable name associated with the query score
Resource	getSubject()
StatementPattern	getTypePattern()
boolean	isEvaluable()
boolean	isHighlight()
QueryModelNode	removeQueryPatterns()	Removes the query patterns and returns a placeholder where the query results could be placed.
String	toString()

Methods inherited from class org.eclipse.rdf4j.sail.lucene.AbstractSearchQueryEvaluator

replaceQueryPatternsWithResults

Methods inherited from class java.lang.Object

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

Constructor Details

QuerySpec

public QuerySpec(StatementPattern matchesPattern,
 Collection<QuerySpec.QueryParam> queryPatterns,
 StatementPattern scorePattern,
 StatementPattern typePattern,
 StatementPattern idPattern,
 Resource subject)

QuerySpec

public QuerySpec(StatementPattern matchesPattern,
 Collection<QuerySpec.QueryParam> queryPatterns,
 StatementPattern scorePattern,
 StatementPattern typePattern,
 StatementPattern idPattern,
 StatementPattern numDocsPattern,
 Resource subject)

QuerySpec

public QuerySpec(String matchesVarName,
 String propertyVarName,
 String scoreVarName,
 String snippetVarName,
 Resource subject,
 String queryString,
 IRI propertyURI)

Method Details

getParentQueryModelNode

public QueryModelNode getParentQueryModelNode()

removeQueryPatterns

public QueryModelNode removeQueryPatterns()

Description copied from interface: SearchQueryEvaluator

Removes the query patterns and returns a placeholder where the query results could be placed.

getMatchesPattern

public StatementPattern getMatchesPattern()

getMatchesVariableName

public String getMatchesVariableName()

return the name of the bound variable that should match the query

Returns:

the name of the variable or null, if no name set

getQueryPatterns

public Collection<QuerySpec.QueryParam> getQueryPatterns()

getIdPattern

public StatementPattern getIdPattern()

getScorePattern

public StatementPattern getScorePattern()

getNumDocsPattern

public StatementPattern getNumDocsPattern()

getScoreVariableName

public String getScoreVariableName()

The variable name associated with the query score

Returns:

the name or null, if no score is queried in the pattern

getNumDocs

public Integer getNumDocs()

getTypePattern

public StatementPattern getTypePattern()

getQueryType

public IRI getQueryType()

the type of query, must equal LuceneSailSchema.LUCENE_QUERY. A null type is possible, but not valid.

Returns:

the type of the Query or null, if no type assigned.

getSubject

public Resource getSubject()

isEvaluable

public boolean isEvaluable()

isHighlight

public boolean isHighlight()

toString

public String toString()

Overrides:

toString in class Object

getCatQuery

public String getCatQuery()