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

Field Summary

Fields

Modifier and Type	Field	Description
private final StatementPattern	idPattern
private final StatementPattern	matchesPattern
private final String	matchesVarName
private final Collection<QuerySpec.QueryParam>	queryPatterns
private final StatementPattern	scorePattern
private final String	scoreVarName
private final Resource	subject
private final StatementPattern	typePattern

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)

Method Summary

Modifier and Type	Method	Description
private static void	append(StatementPattern pattern, StringBuilder buffer)
private static void	append(Var var, StringBuilder buffer)
String	getCatQuery()
StatementPattern	getIdPattern()
StatementPattern	getMatchesPattern()
String	getMatchesVariableName()	return the name of the bound variable that should match the query
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.
private static void	replace(QueryModelNode pattern, Supplier<? extends QueryModelNode> replacement)	Replace the given pattern with a new instance of the given replacement type.
String	toString()

Methods inherited from class AbstractSearchQueryEvaluator

replaceQueryPatternsWithResults

Methods inherited from class Object

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

Field Details

matchesPattern

private final StatementPattern matchesPattern

queryPatterns

private final Collection<QuerySpec.QueryParam> queryPatterns

scorePattern

private final StatementPattern scorePattern

typePattern

private final StatementPattern typePattern

idPattern

private final StatementPattern idPattern

subject

private final Resource subject

matchesVarName

private final String matchesVarName

scoreVarName

private final String scoreVarName

Constructor Details

QuerySpec

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

QuerySpec

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

Method Details

replace

private static void replace(QueryModelNode pattern,
 Supplier<? extends QueryModelNode> replacement)

Replace the given pattern with a new instance of the given replacement type.

Parameters:

pattern - the pattern to remove

replacement - the replacement type

append

private static void append(StatementPattern pattern,
 StringBuilder buffer)

append

private static void append(Var var,
 StringBuilder buffer)

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()

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

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()