public class FedXConfig extends Object
| Modifier and Type | Field and Description |
|---|---|
static FedXConfig |
DEFAULT_CONFIG |
| Constructor and Description |
|---|
FedXConfig() |
| Modifier and Type | Method and Description |
|---|---|
int |
getBoundJoinBlockSize()
The block size for a bound join, i.e.
|
int |
getConsumingIterationMax()
Returns the max number of results to be consumed by
ConsumingIteration |
boolean |
getEnableServiceAsBoundJoin()
Returns a flag indicating whether vectored evaluation using the VALUES clause shall be applied for SERVICE
expressions.
|
int |
getEnforceMaxQueryTime()
Get the maximum query time in seconds used for query evaluation.
|
boolean |
getIncludeInferredDefault() |
int |
getJoinWorkerThreads()
The (maximum) number of join worker threads used in the
ControlledWorkerScheduler for join operations. |
int |
getLeftJoinWorkerThreads()
The (maximum) number of left join worker threads used in the
ControlledWorkerScheduler for join
operations. |
String |
getPrefixDeclarations()
Returns the path to a property file containing prefix declarations as "namespace=prefix" pairs (one per line).
|
Class<? extends FederationEvalStrategy> |
getSailEvaluationStrategy()
Returns the class of the
FederationEvalStrategy implementation that is used in the case of SAIL
implementations, e.g. |
String |
getSourceSelectionCacheSpec()
Returns the configured
CacheBuilderSpec (if any) for the SourceSelectionMemoryCache. |
Class<? extends FederationEvalStrategy> |
getSPARQLEvaluationStrategy()
Returns the class of the
FederationEvalStrategy implementation that is used in the case of SPARQL
implementations, e.g. |
Optional<TaskWrapper> |
getTaskWrapper()
Returns a
TaskWrapper which may be used for wrapping any background Runnables. |
int |
getUnionWorkerThreads()
The (maximum) number of union worker threads used in the
ControlledWorkerScheduler for join operations. |
Class<? extends WriteStrategyFactory> |
getWriteStrategyFactory()
Returns the class of the
WriteStrategyFactory implementation. |
boolean |
isDebugQueryPlan()
The debug mode for query plan.
|
boolean |
isEnableMonitoring()
Flag to enable/disable monitoring features.
|
boolean |
isLogQueries()
Flag to enable/disable query logging via
QueryLog. |
boolean |
isLogQueryPlan()
Flag to enable/disable query plan logging via
QueryPlanLog. |
FedXConfig |
withBoundJoinBlockSize(int boundJoinBlockSize)
Set the bound join block size.
|
FedXConfig |
withConsumingIterationMax(int max)
Set the max number of results to be consumed by
ConsumingIteration. |
FedXConfig |
withDebugQueryPlan(boolean flag)
Set whether the query plan shall be debugged.
|
FedXConfig |
withEnableMonitoring(boolean flag)
Enable monitoring.
|
FedXConfig |
withEnableServiceAsBoundJoin(boolean flag)
Whether external SERVICE clauses are evaluated using bound join (i.e.
|
FedXConfig |
withEnforceMaxQueryTime(int enforceMaxQueryTime)
Set enforce max query time.
|
FedXConfig |
withIncludeInferredDefault(boolean flag)
Set the default value supplied to
Operation.setIncludeInferred(boolean) |
FedXConfig |
withJoinWorkerThreads(int joinWorkerThreads)
Set the number of join worker threads.
|
FedXConfig |
withLeftJoinWorkerThreads(int leftJoinWorkerThreads)
Set the number of left join worker threads.
|
FedXConfig |
withLogQueries(boolean flag)
Set whether to log queries.
|
FedXConfig |
withLogQueryPlan(boolean flag)
Whether to log the query plan with
QueryPlanLog. |
FedXConfig |
withPrefixDeclarations(String prefixFile)
Set the optional prefix declarations file.
|
FedXConfig |
withSailEvaluationStrategy(Class<? extends FederationEvalStrategy> sailEvaluationStrategy)
Set the
FederationEvalStrategy for SAIL federations. |
FedXConfig |
withSourceSelectionCacheSpec(String cacheSpec)
The cache specification for the
SourceSelectionMemoryCache. |
FedXConfig |
withSparqlEvaluationStrategy(Class<? extends FederationEvalStrategy> sparqlEvaluationStrategy)
Set the
FederationEvalStrategy for SPARQL federations. |
FedXConfig |
withTaskWrapper(TaskWrapper taskWrapper)
Sets a
TaskWrapper which may be used for wrapping any background Runnables. |
FedXConfig |
withUnionWorkerThreads(int unionWorkerThreads)
Set the number of union worker threads.
|
FedXConfig |
withWriteStrategyFactory(Class<? extends WriteStrategyFactory> writeStrategyFactory)
Set the
WriteStrategyFactory to be used. |
public static FedXConfig DEFAULT_CONFIG
public FedXConfig withDebugQueryPlan(boolean flag)
isDebugQueryPlan().
Can be set after federation construction and initialize.
flag - public FedXConfig withLogQueries(boolean flag)
isLogQueries().
Can only be set before federation initialization.
flag - public FedXConfig withSparqlEvaluationStrategy(Class<? extends FederationEvalStrategy> sparqlEvaluationStrategy)
FederationEvalStrategy for SPARQL federations. See getSPARQLEvaluationStrategy().
Can only be set before federation initialization.
sparqlEvaluationStrategy - public FedXConfig withSailEvaluationStrategy(Class<? extends FederationEvalStrategy> sailEvaluationStrategy)
FederationEvalStrategy for SAIL federations. See getSailEvaluationStrategy().
Can only be set before federation initialization.
sailEvaluationStrategy - public FedXConfig withWriteStrategyFactory(Class<? extends WriteStrategyFactory> writeStrategyFactory)
WriteStrategyFactory to be used.writeStrategyFactory - public FedXConfig withEnforceMaxQueryTime(int enforceMaxQueryTime)
getEnforceMaxQueryTime().
Can be set after federation construction and initialize.
enforceMaxQueryTime - time in seconds, 0 to disablepublic FedXConfig withIncludeInferredDefault(boolean flag)
Operation.setIncludeInferred(boolean)flag - public FedXConfig withEnableMonitoring(boolean flag)
isEnableMonitoring().
Can only be set before federation initialization.
flag - public FedXConfig withBoundJoinBlockSize(int boundJoinBlockSize)
getBoundJoinBlockSize().
Can only be set before federation initialization.
boundJoinBlockSize - public FedXConfig withJoinWorkerThreads(int joinWorkerThreads)
getJoinWorkerThreads().
Can only be set before federation initialization.
joinWorkerThreads - public FedXConfig withLeftJoinWorkerThreads(int leftJoinWorkerThreads)
getLeftJoinWorkerThreads().
Can only be set before federation initialization.
leftJoinWorkerThreads - public FedXConfig withUnionWorkerThreads(int unionWorkerThreads)
getUnionWorkerThreads().
Can only be set before federation initialization.
unionWorkerThreads - public FedXConfig withPrefixDeclarations(String prefixFile)
getPrefixDeclarations().
Can only be set before federation initialization.
prefixFile - public FedXConfig withLogQueryPlan(boolean flag)
QueryPlanLog. See isLogQueryPlan().
Can only be set before federation initialization.
flag - public FedXConfig withEnableServiceAsBoundJoin(boolean flag)
flag - public FedXConfig withSourceSelectionCacheSpec(String cacheSpec)
SourceSelectionMemoryCache. If not set explicitly, the
SourceSelectionMemoryCache.DEFAULT_CACHE_SPEC is used.cacheSpec - the CacheBuilderSpec for the SourceSelectionCacheSourceSelectionMemoryCachepublic FedXConfig withTaskWrapper(TaskWrapper taskWrapper)
TaskWrapper which may be used for wrapping any background Runnables. If no such wrapper is
explicitly configured, the unmodified task is returned. See TaskWrapper for more information.taskWrapper - the TaskWrapperTaskWrapperpublic int getJoinWorkerThreads()
ControlledWorkerScheduler for join operations.
Default is 20.public int getUnionWorkerThreads()
ControlledWorkerScheduler for join operations.
Default is 20public int getLeftJoinWorkerThreads()
ControlledWorkerScheduler for join
operations. Default is 10.public int getBoundJoinBlockSize()
public boolean getEnableServiceAsBoundJoin()
public int getEnforceMaxQueryTime()
QueryManager is used to
create queries.
Set to 0 to disable query timeouts.
The timeout is also applied for individual fine-granular join or union operations as a max time.public boolean getIncludeInferredDefault()
Operation.getIncludeInferred()public boolean isEnableMonitoring()
public boolean isLogQueryPlan()
QueryPlanLog. Default=false The QueryPlanLog
facility allows to retrieve the query execution plan from a variable local to the executing thread.public boolean isLogQueries()
QueryLog. Default=false The QueryLog facility allows to
log all queries to a file. See QueryLog for details.
Requires isEnableMonitoring() to be active.public String getPrefixDeclarations()
Default: no prefixes are replaced. Note that prefixes are only replaced when using the QueryManager to
create/evaluate queries.
Example:
foaf=http://xmlns.com/foaf/0.1/
rdf=http://www.w3.org/1999/02/22-rdf-syntax-ns#
=http://mydefaultns.org/
null if not configuredpublic String getSourceSelectionCacheSpec()
CacheBuilderSpec (if any) for the SourceSelectionMemoryCache. If not
defined, the SourceSelectionMemoryCache.DEFAULT_CACHE_SPEC is used.CacheBuilderSpec or nullpublic Class<? extends FederationEvalStrategy> getSailEvaluationStrategy()
FederationEvalStrategy implementation that is used in the case of SAIL
implementations, e.g. for native stores.
Default SailFederationEvalStrategy
public Class<? extends FederationEvalStrategy> getSPARQLEvaluationStrategy()
FederationEvalStrategy implementation that is used in the case of SPARQL
implementations, e.g. SPARQL repository or remote repository.
Default SparqlFederationEvalStrategy
public Class<? extends WriteStrategyFactory> getWriteStrategyFactory()
WriteStrategyFactory implementation.
Default: DefaultWriteStrategyFactory
WriteStrategyFactory classpublic boolean isDebugQueryPlan()
public Optional<TaskWrapper> getTaskWrapper()
TaskWrapper which may be used for wrapping any background Runnables. If no such wrapper
is explicitly configured, the unmodified task is returned. See TaskWrapper for more information.TaskWrapper, an empty Optional if none is explicitly configuredpublic FedXConfig withConsumingIterationMax(int max)
ConsumingIteration. See
getConsumingIterationMax().
Can only be set before federation initialization.
max - public int getConsumingIterationMax()
ConsumingIterationCopyright © 2015-2022 Eclipse Foundation. All Rights Reserved.