Package tools.refinery.interpreter.api

Class InterpreterEngineOptions

java.lang.Object

tools.refinery.interpreter.api.InterpreterEngineOptions

public final class InterpreterEngineOptions
extends Object

This class is intended to provide options to a created InterpreterEngine instance. The DEFAULT instance represents the configuration that is selected when no explicit options are provided by the user. To create new configurations, use the static builder methods defineOptions() (starts with empty options) or copyOptions(InterpreterEngineOptions) (starts with all options from an existing configuration).

Since:

1.4

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	InterpreterEngineOptions.Builder

Method Summary

Modifier and Type	Method	Description
static InterpreterEngineOptions.Builder	copyOptions(InterpreterEngineOptions options)	Initializes an option builder with settings from an existing configuration.
static InterpreterEngineOptions.Builder	defineOptions()	Initializes an option builder with no previously set options.
static final InterpreterEngineOptions	getDefault()
IQueryBackendFactory	getDefaultBackendFactory()	Returns the configured default backend
IQueryBackendFactory	getDefaultCachingBackendFactory()	Returns the configured default caching backend.
IQueryBackendFactory	getDefaultSearchBackendFactory()	Returns the configured default search-based backend.
QueryEvaluationHint	getEngineDefaultHints()
IQueryBackendFactory	getQueryBackendFactory(QueryEvaluationHint hint)
static void	setSystemDefaultBackends(IQueryBackendFactory systemDefaultBackendFactory, IQueryBackendFactory systemDefaultCachingBackendFactory, IQueryBackendFactory systemDefaultSearchBackendFactory)
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

setSystemDefaultBackends

public static void setSystemDefaultBackends(IQueryBackendFactory systemDefaultBackendFactory,
 IQueryBackendFactory systemDefaultCachingBackendFactory,
 IQueryBackendFactory systemDefaultSearchBackendFactory)

Since:

2.0

getDefault

public static final InterpreterEngineOptions getDefault()

Since:

2.0

defineOptions

public static InterpreterEngineOptions.Builder defineOptions()

Initializes an option builder with no previously set options.

copyOptions

public static InterpreterEngineOptions.Builder copyOptions(InterpreterEngineOptions options)

Initializes an option builder with settings from an existing configuration.

getEngineDefaultHints

public QueryEvaluationHint getEngineDefaultHints()

getDefaultBackendFactory

public IQueryBackendFactory getDefaultBackendFactory()

Returns the configured default backend

Returns:

the defaultBackendFactory

getDefaultCachingBackendFactory

public IQueryBackendFactory getDefaultCachingBackendFactory()

Returns the configured default caching backend. If the default backend caches matches, it is usually expected, but not mandatory for the two default backends to be the same.

getDefaultSearchBackendFactory

public IQueryBackendFactory getDefaultSearchBackendFactory()

Returns the configured default search-based backend. If the default backend is search-based, it is usually expected, but not mandatory for the two default backends to be the same.

Since:

2.0

toString

public String toString()

Overrides:

toString in class Object

getQueryBackendFactory

public IQueryBackendFactory getQueryBackendFactory(QueryEvaluationHint hint)

Since:

2.0