org.apache.jackrabbit.oak.query

Class QueryEngineSettingsMBeanImpl

java.lang.Object

javax.management.StandardMBean

org.apache.jackrabbit.oak.commons.jmx.AnnotatedStandardMBean

org.apache.jackrabbit.oak.query.QueryEngineSettingsMBeanImpl

All Implemented Interfaces:

DynamicMBean, MBeanRegistration, QueryEngineSettingsMBean

public class QueryEngineSettingsMBeanImpl
extends AnnotatedStandardMBean
implements QueryEngineSettingsMBean

Settings of the query engine. This instance is an AnnotatedStandardMBean.

Field Summary

Fields inherited from interface org.apache.jackrabbit.oak.api.jmx.QueryEngineSettingsMBean

TYPE

Constructor Summary

Constructors

Constructor and Description
QueryEngineSettingsMBeanImpl() Create a new query engine settings object.
QueryEngineSettingsMBeanImpl(QueryEngineSettings settings) Create a new query engine settings object.

Method Summary

Modifier and Type	Method and Description
boolean	getFailTraversal() Whether queries that don't use an index will fail (throw an exception).
boolean	getFullTextComparisonWithoutIndex()
long	getLimitInMemory() Get the limit on how many nodes a query may read at most into memory, for "order by" and "distinct" queries.
long	getLimitReads() Get the limit on how many nodes a query may read at most (raw read operations, including skipped nodes).
boolean	isFastQuerySize() Whether the query result size should return an estimation for large queries.
boolean	isSql2Optimisation()
void	setFailTraversal(boolean failQueriesWithoutIndex) Set whether queries that don't use an index will fail (throw an exception).
void	setFastQuerySize(boolean fastQuerySize)
void	setFullTextComparisonWithoutIndex(boolean fullTextComparisonWithoutIndex)
void	setLimitInMemory(long limitInMemory) Change the limit.
void	setLimitReads(long limitReads) Change the limit.
String	toString()
QueryEngineSettings	unwrap()

Methods inherited from class javax.management.StandardMBean

getAttribute, getAttributes, getImplementation, getImplementationClass, getMBeanInfo, getMBeanInterface, invoke, postDeregister, postRegister, preDeregister, preRegister, setAttribute, setAttributes, setImplementation

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

QueryEngineSettingsMBeanImpl

public QueryEngineSettingsMBeanImpl(QueryEngineSettings settings)

Create a new query engine settings object. Creating the object is relatively slow, and at runtime, as few such objects as possible should be created (ideally, only one per Oak instance). Creating new instances also means they can not be configured using JMX, as one would expect.

QueryEngineSettingsMBeanImpl

public QueryEngineSettingsMBeanImpl()

Create a new query engine settings object. Creating the object is relatively slow, and at runtime, as few such objects as possible should be created (ideally, only one per Oak instance). Creating new instances also means they can not be configured using JMX, as one would expect.

Method Detail

getLimitInMemory

public long getLimitInMemory()

Description copied from interface: QueryEngineSettingsMBean

Get the limit on how many nodes a query may read at most into memory, for "order by" and "distinct" queries. If this limit is exceeded, the query throws an exception.

Specified by:

getLimitInMemory in interface QueryEngineSettingsMBean

Returns:

the limit

setLimitInMemory

public void setLimitInMemory(long limitInMemory)

Description copied from interface: QueryEngineSettingsMBean

Change the limit.

Specified by:

setLimitInMemory in interface QueryEngineSettingsMBean

Parameters:

limitInMemory - the new limit

getLimitReads

public long getLimitReads()

Description copied from interface: QueryEngineSettingsMBean

Get the limit on how many nodes a query may read at most (raw read operations, including skipped nodes). If this limit is exceeded, the query throws an exception.

Specified by:

getLimitReads in interface QueryEngineSettingsMBean

Returns:

the limit

setLimitReads

public void setLimitReads(long limitReads)

Description copied from interface: QueryEngineSettingsMBean

Change the limit.

Specified by:

setLimitReads in interface QueryEngineSettingsMBean

Parameters:

limitReads - the new limit

getFailTraversal

public boolean getFailTraversal()

Description copied from interface: QueryEngineSettingsMBean

Whether queries that don't use an index will fail (throw an exception). The default is false.

Specified by:

getFailTraversal in interface QueryEngineSettingsMBean

Returns:

true if they fail

setFailTraversal

public void setFailTraversal(boolean failQueriesWithoutIndex)

Description copied from interface: QueryEngineSettingsMBean

Set whether queries that don't use an index will fail (throw an exception).

Specified by:

setFailTraversal in interface QueryEngineSettingsMBean

Parameters:

failQueriesWithoutIndex - the new value for this setting

isFastQuerySize

public boolean isFastQuerySize()

Description copied from interface: QueryEngineSettingsMBean

Whether the query result size should return an estimation for large queries.

Specified by:

isFastQuerySize in interface QueryEngineSettingsMBean

Returns:

true if enabled

setFastQuerySize

public void setFastQuerySize(boolean fastQuerySize)

Specified by:

setFastQuerySize in interface QueryEngineSettingsMBean

setFullTextComparisonWithoutIndex

public void setFullTextComparisonWithoutIndex(boolean fullTextComparisonWithoutIndex)

getFullTextComparisonWithoutIndex

public boolean getFullTextComparisonWithoutIndex()

isSql2Optimisation

public boolean isSql2Optimisation()

unwrap

public QueryEngineSettings unwrap()

toString

public String toString()

Overrides:

toString in class Object