org.apache.jackrabbit.core.query.lucene
Class AbstractQueryImpl

java.lang.Object
  org.apache.jackrabbit.core.query.lucene.AbstractQueryImpl

All Implemented Interfaces:

ExecutableQuery

Direct Known Subclasses:

QueryImpl

public abstract class AbstractQueryImpl
extends Object
implements ExecutableQuery

AbstractQueryImpl provides a base class for executable queries based on SearchIndex.

Field Summary

protected SearchIndex	index The actual search index
protected PropertyTypeRegistry	propReg The property type registry for type lookup.
protected SessionContext	sessionContext Component context of the current session

Constructor Summary

AbstractQueryImpl(SessionContext sessionContext, SearchIndex index, PropertyTypeRegistry propReg)
Creates a new query instance from a query string.

Method Summary

protected QueryObjectModelFactory	getQOMFactory()
boolean	getRespectDocumentOrder() If set true the result nodes will be in document order per default (if no order by clause is specified).
abstract boolean	needsSystemTree() Returns true if this query node needs items under /jcr:system to be queried.
void	setRespectDocumentOrder(boolean documentOrder) Sets a new value for this property.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.jackrabbit.core.query.ExecutableQuery

execute

Field Detail

sessionContext

protected final SessionContext sessionContext

Component context of the current session

index

protected final SearchIndex index

The actual search index

propReg

protected final PropertyTypeRegistry propReg

The property type registry for type lookup.

Constructor Detail

AbstractQueryImpl

public AbstractQueryImpl(SessionContext sessionContext,
                         SearchIndex index,
                         PropertyTypeRegistry propReg)

Creates a new query instance from a query string.

Parameters:

sessionContext - component context of the current session

index - the search index.

propReg - the property type registry.

Method Detail

getRespectDocumentOrder

public boolean getRespectDocumentOrder()

If set true the result nodes will be in document order per default (if no order by clause is specified). If set to false the result nodes are returned in whatever sequence the index has stored the nodes. That sequence is stable over multiple invocations of the same query, but will change when nodes get added or removed from the index.

The default value for this property is true.

Returns:

the current value of this property.

setRespectDocumentOrder

public void setRespectDocumentOrder(boolean documentOrder)

Sets a new value for this property.

Parameters:

documentOrder - if true the result nodes are in document order per default.

See Also:

getRespectDocumentOrder()

getQOMFactory

protected QueryObjectModelFactory getQOMFactory()
                                         throws RepositoryException

Returns:

the query object model factory.

Throws:

RepositoryException - if an error occurs.

needsSystemTree

public abstract boolean needsSystemTree()

Returns true if this query node needs items under /jcr:system to be queried.

Returns:

true if this query node needs content under /jcr:system to be queried; false otherwise.