Class ViatraQueryEngineOptions
- java.lang.Object
-
- org.eclipse.viatra.query.runtime.api.ViatraQueryEngineOptions
-
public final class ViatraQueryEngineOptions extends java.lang.ObjectThis class is intended to provide options to a createdViatraQueryEngineinstance. TheDEFAULTinstance represents the configuration that is selected when no explicit options are provided by the user. To create new configurations, use the static builder methodsdefineOptions()(starts with empty options) orcopyOptions(ViatraQueryEngineOptions)(starts with all options from an existing configuration).- Since:
- 1.4
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classViatraQueryEngineOptions.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ViatraQueryEngineOptions.BuildercopyOptions(ViatraQueryEngineOptions options)Initializes an option builder with settings from an existing configuration.static ViatraQueryEngineOptions.BuilderdefineOptions()Initializes an option builder with no previously set options.static ViatraQueryEngineOptionsgetDefault()IQueryBackendFactorygetDefaultBackendFactory()Returns the configured default backendIQueryBackendFactorygetDefaultCachingBackendFactory()Returns the configured default caching backend.IQueryBackendFactorygetDefaultSearchBackendFactory()Returns the configured default search-based backend.QueryEvaluationHintgetEngineDefaultHints()IQueryBackendFactorygetQueryBackendFactory(QueryEvaluationHint hint)static voidsetSystemDefaultBackends(IQueryBackendFactory systemDefaultBackendFactory, IQueryBackendFactory systemDefaultCachingBackendFactory, IQueryBackendFactory systemDefaultSearchBackendFactory)java.lang.StringtoString()
-
-
-
Method Detail
-
setSystemDefaultBackends
public static void setSystemDefaultBackends(IQueryBackendFactory systemDefaultBackendFactory, IQueryBackendFactory systemDefaultCachingBackendFactory, IQueryBackendFactory systemDefaultSearchBackendFactory)
- Since:
- 2.0
-
getDefault
public static final ViatraQueryEngineOptions getDefault()
- Since:
- 2.0
-
defineOptions
public static ViatraQueryEngineOptions.Builder defineOptions()
Initializes an option builder with no previously set options.
-
copyOptions
public static ViatraQueryEngineOptions.Builder copyOptions(ViatraQueryEngineOptions 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 java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
getQueryBackendFactory
public IQueryBackendFactory getQueryBackendFactory(QueryEvaluationHint hint)
- Since:
- 2.0
-
-