Package tools.refinery.interpreter.localsearch.matcher.integration

Class AbstractLocalSearchResultProvider

java.lang.Object

tools.refinery.interpreter.localsearch.matcher.integration.AbstractLocalSearchResultProvider

All Implemented Interfaces:

IQueryResultProvider

Direct Known Subclasses:

GenericLocalSearchResultProvider

public abstract class AbstractLocalSearchResultProvider
extends Object
implements IQueryResultProvider

Since:

1.7

Field Summary

Fields

Modifier and Type	Field	Description
protected final LocalSearchBackend	backend
protected final IQueryBackendContext	backendContext
protected final Map<PQuery,LocalSearchHints>	hintCache
protected final IPlanProvider	planProvider
protected final PQuery	query
protected ResultProviderRequestor	resultProviderRequestor
protected final IQueryRuntimeContext	runtimeContext
protected final ISearchContext	searchContext
protected final QueryEvaluationHint	userHints

Constructor Summary

Constructors

Constructor	Description
AbstractLocalSearchResultProvider(LocalSearchBackend backend, IQueryBackendContext context, PQuery query, IPlanProvider planProvider, QueryEvaluationHint userHints)

Method Summary

Modifier and Type	Method	Description
void	addUpdateListener(IUpdateable listener, Object listenerTag, boolean fireNow)
int	countMatches(Object[] parameters)
int	countMatches(TupleMask parameterSeedMask, ITuple parameters)
Optional<Double>	estimateAverageBucketSize(TupleMask groupMask, Accuracy requiredAccuracy)
Optional<Long>	estimateCardinality(TupleMask groupMask, Accuracy requiredAccuracy)
double	estimateCost(TupleMask inputBindingMask)
void	forgetAllPlans()	Forgets all stored plans in this result provider.
Stream<Tuple>	getAllMatches(Object[] parameters)
Stream<Tuple>	getAllMatches(TupleMask parameterSeedMask, ITuple parameters)
IMatcherCapability	getCapabilites()
Optional<Tuple>	getOneArbitraryMatch(Object[] parameters)
Optional<Tuple>	getOneArbitraryMatch(TupleMask parameterSeedMask, ITuple parameters)
protected abstract IOperationCompiler	getOperationCompiler(IQueryBackendContext backendContext, LocalSearchHints configuration)
IQueryBackend	getQueryBackend()
IPlanDescriptor	getSearchPlan(Set<PParameter> adornment)	Returns a search plan for a given adornment if exists
boolean	hasMatch(Object[] parameters)
boolean	hasMatch(TupleMask parameterSeedMask, ITuple parameters)
protected void	indexInitializationBeforePlanning()	This method is called before planning start to allow indexing.
protected void	indexReferredTypesOfQuery(PQuery query, IndexingService requiredIndexingServices)	Collects and indexes all types _directly_ referred by the PQuery query.
LocalSearchMatcher	newLocalSearchMatcher(Object[] parameters)
LocalSearchMatcher	newLocalSearchMatcher(ITuple parameters)
void	prepare()	Prepare this result provider.
protected void	prepareDirectDependencies()
protected void	preparePlansForExpectedAdornments()
void	removeUpdateListener(Object listenerTag)

Methods inherited from class java.lang.Object

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

Field Details

backend

protected final LocalSearchBackend backend

backendContext

protected final IQueryBackendContext backendContext

runtimeContext

protected final IQueryRuntimeContext runtimeContext

query

protected final PQuery query

userHints

protected final QueryEvaluationHint userHints

hintCache

protected final Map<PQuery,LocalSearchHints> hintCache

planProvider

protected final IPlanProvider planProvider

searchContext

protected final ISearchContext searchContext

resultProviderRequestor

protected ResultProviderRequestor resultProviderRequestor

Since:

2.1

Constructor Details

AbstractLocalSearchResultProvider

public AbstractLocalSearchResultProvider(LocalSearchBackend backend,
 IQueryBackendContext context,
 PQuery query,
 IPlanProvider planProvider,
 QueryEvaluationHint userHints)

Since:

1.5

Method Details

getOperationCompiler

protected abstract IOperationCompiler getOperationCompiler(IQueryBackendContext backendContext,
 LocalSearchHints configuration)

prepare

public void prepare()

Prepare this result provider. This phase is separated from the constructor to allow the backend to cache its instance before requesting preparation for its dependencies.

Since:

1.5

preparePlansForExpectedAdornments

protected void preparePlansForExpectedAdornments()

prepareDirectDependencies

protected void prepareDirectDependencies()

indexInitializationBeforePlanning

protected void indexInitializationBeforePlanning()

This method is called before planning start to allow indexing. It is important to note that this method is called inside a coalesceTraversals block, meaning (1) it is safe to add multiple registration requests as necessary, but (2) no value or statistics is available from the index.

Throws:

InterpreterRuntimeException

indexReferredTypesOfQuery

protected void indexReferredTypesOfQuery(PQuery query,
 IndexingService requiredIndexingServices)

Collects and indexes all types _directly_ referred by the PQuery query. Types indirect

Parameters:

requiredIndexingServices -

newLocalSearchMatcher

public LocalSearchMatcher newLocalSearchMatcher(ITuple parameters)

Throws:

InterpreterRuntimeException

newLocalSearchMatcher

public LocalSearchMatcher newLocalSearchMatcher(Object[] parameters)

Throws:

InterpreterRuntimeException

hasMatch

public boolean hasMatch(Object[] parameters)

Specified by:

hasMatch in interface IQueryResultProvider

hasMatch

public boolean hasMatch(TupleMask parameterSeedMask,
 ITuple parameters)

Specified by:

hasMatch in interface IQueryResultProvider

getOneArbitraryMatch

public Optional<Tuple> getOneArbitraryMatch(Object[] parameters)

Specified by:

getOneArbitraryMatch in interface IQueryResultProvider

getOneArbitraryMatch

public Optional<Tuple> getOneArbitraryMatch(TupleMask parameterSeedMask,
 ITuple parameters)

Specified by:

getOneArbitraryMatch in interface IQueryResultProvider

countMatches

public int countMatches(Object[] parameters)

Specified by:

countMatches in interface IQueryResultProvider

countMatches

public int countMatches(TupleMask parameterSeedMask,
 ITuple parameters)

Specified by:

countMatches in interface IQueryResultProvider

estimateCardinality

public Optional<Long> estimateCardinality(TupleMask groupMask,
 Accuracy requiredAccuracy)

Specified by:

estimateCardinality in interface IQueryResultProvider

estimateAverageBucketSize

public Optional<Double> estimateAverageBucketSize(TupleMask groupMask,
 Accuracy requiredAccuracy)

Specified by:

estimateAverageBucketSize in interface IQueryResultProvider

estimateCost

public double estimateCost(TupleMask inputBindingMask)

Since:

2.1

getAllMatches

public Stream<Tuple> getAllMatches(Object[] parameters)

Specified by:

getAllMatches in interface IQueryResultProvider

getAllMatches

public Stream<Tuple> getAllMatches(TupleMask parameterSeedMask,
 ITuple parameters)

Specified by:

getAllMatches in interface IQueryResultProvider

getQueryBackend

public IQueryBackend getQueryBackend()

Specified by:

getQueryBackend in interface IQueryResultProvider

addUpdateListener

public void addUpdateListener(IUpdateable listener,
 Object listenerTag,
 boolean fireNow)

Specified by:

addUpdateListener in interface IQueryResultProvider

removeUpdateListener

public void removeUpdateListener(Object listenerTag)

Specified by:

removeUpdateListener in interface IQueryResultProvider

getCapabilites

public IMatcherCapability getCapabilites()

Since:

1.4

forgetAllPlans

public void forgetAllPlans()

Forgets all stored plans in this result provider. If no plans are stored, nothing happens.

Since:

2.0

getSearchPlan

public IPlanDescriptor getSearchPlan(Set<PParameter> adornment)

Returns a search plan for a given adornment if exists

Returns:

a search plan for the pattern with the given adornment, or null if none exists

Since:

2.0