org.exoplatform.services.jcr.impl.core.query

Interface QueryHandler

public interface QueryHandler

Defines an interface for the actual node indexing and query execution. The goal is to allow different implementations based on the persistent manager in use. Some persistent model might allow to execute a query in an optimized manner, e.g. database persistence.

Level API:

Unsupported

Method Summary

Modifier and Type	Method and Description
void	addNode(org.exoplatform.services.jcr.datamodel.NodeData node) Adds a Node to the search index.
void	apply(org.exoplatform.services.jcr.impl.core.query.lucene.ChangesHolder changes) Applies the given changes to the indes in an atomic operation
void	checkIndex(org.exoplatform.services.jcr.dataflow.ItemDataConsumer itemStateManager, boolean isSystem, org.exoplatform.services.jcr.impl.checker.InspectionReport report) Check index consistency.
void	close() Closes this QueryHandler and frees resources attached to this handler.
org.exoplatform.services.jcr.impl.core.query.ExecutableQuery	createExecutableQuery(org.exoplatform.services.jcr.impl.core.SessionImpl session, org.exoplatform.services.jcr.impl.core.SessionDataManager itemMgr, String statement, String language) Creates a new query by specifying the query statement itself and the language in which the query is stated.
void	deleteNode(String id) Deletes the Node with id from the search index.
org.exoplatform.services.jcr.impl.core.query.lucene.QueryHits	executeQuery(org.apache.lucene.search.Query query) Executes the query on the search index.
org.exoplatform.services.jcr.impl.core.query.lucene.ChangesHolder	getChanges(Iterator<String> remove, Iterator<org.exoplatform.services.jcr.datamodel.NodeData> add) Extracts all the changes and returns them as a ChangesHolder instance
org.exoplatform.services.jcr.impl.core.query.QueryHandlerContext	getContext() Returns the query handler context that passed in setContext(QueryHandlerContext).
org.exoplatform.services.jcr.impl.core.query.IndexerIoModeHandler	getIndexerIoModeHandler()
org.exoplatform.services.jcr.impl.core.query.lucene.IndexInfos	getIndexInfos() Returns IndexInfos instance that was set into QueryHandler.
org.exoplatform.services.jcr.impl.core.query.lucene.IndexUpdateMonitor	getIndexUpdateMonitor()
String	getQueryClass()
void	init() initializes QueryHandler
boolean	isInitialized() Checks whether QueryHandler is initialized or not
boolean	isOnline() Offline mode means that new indexing data is collected but index is guaranteed to be unmodified during offline state.
void	logErrorChanges(Set<String> removed, Set<String> added) Log unindexed changes into error.log
void	setContext(org.exoplatform.services.jcr.impl.core.query.QueryHandlerContext context) Sets QueryHandlerContext
void	setIndexerIoModeHandler(org.exoplatform.services.jcr.impl.core.query.IndexerIoModeHandler handler)
void	setIndexInfos(org.exoplatform.services.jcr.impl.core.query.lucene.IndexInfos indexInfos) Sets IndexInfos instance into QueryHandler, which is later passed to MultiIndex.
void	setIndexUpdateMonitor(org.exoplatform.services.jcr.impl.core.query.lucene.IndexUpdateMonitor indexUpdateMonitor)
void	setOnline(boolean isOnline, boolean allowQuery, boolean dropStaleIndexes) Switches index into corresponding ONLINE or OFFLINE mode.
void	updateNodes(Iterator<String> remove, Iterator<org.exoplatform.services.jcr.datamodel.NodeData> add) Updates the index in an atomic operation.

Method Detail

getContext

org.exoplatform.services.jcr.impl.core.query.QueryHandlerContext getContext()

Returns the query handler context that passed in setContext(QueryHandlerContext).

Returns:

the query handler context.

addNode

void addNode(org.exoplatform.services.jcr.datamodel.NodeData node)
      throws javax.jcr.RepositoryException,
             IOException

Adds a Node to the search index.

Parameters:

node - the NodeState to add.

Throws:

javax.jcr.RepositoryException - if an error occurs while indexing the node.

IOException - if an error occurs while adding the node to the index.

deleteNode

void deleteNode(String id)
         throws IOException

Deletes the Node with id from the search index.

Parameters:

id - the id of the node to delete.

Throws:

IOException - if an error occurs while deleting the node.

updateNodes

void updateNodes(Iterator<String> remove,
                 Iterator<org.exoplatform.services.jcr.datamodel.NodeData> add)
          throws javax.jcr.RepositoryException,
                 IOException

Updates the index in an atomic operation. Some nodes may be removed and added again in the same updateNodes() call, which is equivalent to an node update.

Parameters:

remove - Iterator of NodeIds of nodes to delete

add - Iterator of NodeState instance to add to the index.

Throws:

javax.jcr.RepositoryException - if an error occurs while indexing a node.

IOException - if an error occurs while updating the index.

getChanges

org.exoplatform.services.jcr.impl.core.query.lucene.ChangesHolder getChanges(Iterator<String> remove,
                                                                             Iterator<org.exoplatform.services.jcr.datamodel.NodeData> add)

Extracts all the changes and returns them as a ChangesHolder instance

Parameters:

remove - Iterator of NodeIds of nodes to delete

add - Iterator of NodeState instance to add to the index.

Returns:

a ChangesHolder instance that contains all the changes

apply

void apply(org.exoplatform.services.jcr.impl.core.query.lucene.ChangesHolder changes)
    throws javax.jcr.RepositoryException,
           IOException

Applies the given changes to the indes in an atomic operation

Parameters:

changes - the changes to apply

Throws:

javax.jcr.RepositoryException - if an error occurs while indexing a node.

IOException - if an error occurs while updating the index.

close

void close()

Closes this QueryHandler and frees resources attached to this handler.

setContext

void setContext(org.exoplatform.services.jcr.impl.core.query.QueryHandlerContext context)

Sets QueryHandlerContext

Parameters:

context -

init

void init()
   throws IOException,
          javax.jcr.RepositoryException,
          org.exoplatform.services.jcr.config.RepositoryConfigurationException

initializes QueryHandler

Throws:

IOException

javax.jcr.RepositoryException

org.exoplatform.services.jcr.config.RepositoryConfigurationException

isInitialized

boolean isInitialized()

Checks whether QueryHandler is initialized or not

createExecutableQuery

org.exoplatform.services.jcr.impl.core.query.ExecutableQuery createExecutableQuery(org.exoplatform.services.jcr.impl.core.SessionImpl session,
                                                                                   org.exoplatform.services.jcr.impl.core.SessionDataManager itemMgr,
                                                                                   String statement,
                                                                                   String language)
                                                                            throws javax.jcr.query.InvalidQueryException

Creates a new query by specifying the query statement itself and the language in which the query is stated. If the query statement is syntactically invalid, given the language specified, an InvalidQueryException is thrown. language must specify a query language string from among those returned by QueryManager.getSupportedQueryLanguages(); if it is not then an InvalidQueryException is thrown.

Parameters:

session - the session of the current user creating the query object.

itemMgr - the item manager of the current user.

statement - the query statement.

language - the syntax of the query statement.

Returns:

A Query object.

Throws:

javax.jcr.query.InvalidQueryException - if statement is invalid or language is unsupported.

logErrorChanges

void logErrorChanges(Set<String> removed,
                     Set<String> added)
              throws IOException

Log unindexed changes into error.log

Parameters:

removed - set of removed node uuids

added - map of added node states and uuids

Throws:

IOException

setIndexerIoModeHandler

void setIndexerIoModeHandler(org.exoplatform.services.jcr.impl.core.query.IndexerIoModeHandler handler)
                      throws IOException

Throws:

IOException

getIndexerIoModeHandler

org.exoplatform.services.jcr.impl.core.query.IndexerIoModeHandler getIndexerIoModeHandler()

getQueryClass

String getQueryClass()

Returns:

the name of the query class to use.

executeQuery

org.exoplatform.services.jcr.impl.core.query.lucene.QueryHits executeQuery(org.apache.lucene.search.Query query)
                                                                    throws IOException

Executes the query on the search index.

Parameters:

query - the lucene query.

Returns:

the lucene Hits object.

Throws:

IOException - if an error occurs while searching the index.

setIndexInfos

void setIndexInfos(org.exoplatform.services.jcr.impl.core.query.lucene.IndexInfos indexInfos)

Sets IndexInfos instance into QueryHandler, which is later passed to MultiIndex.

Parameters:

indexInfos -

getIndexInfos

org.exoplatform.services.jcr.impl.core.query.lucene.IndexInfos getIndexInfos()

Returns IndexInfos instance that was set into QueryHandler.

Returns:

Index info instance

getIndexUpdateMonitor

org.exoplatform.services.jcr.impl.core.query.lucene.IndexUpdateMonitor getIndexUpdateMonitor()

Returns:

the indexUpdateMonitor

setIndexUpdateMonitor

void setIndexUpdateMonitor(org.exoplatform.services.jcr.impl.core.query.lucene.IndexUpdateMonitor indexUpdateMonitor)

Parameters:

indexUpdateMonitor - the indexUpdateMonitor to set

setOnline

void setOnline(boolean isOnline,
               boolean allowQuery,
               boolean dropStaleIndexes)
        throws IOException

Switches index into corresponding ONLINE or OFFLINE mode. Offline mode means that new indexing data is collected but index is guaranteed to be unmodified during offline state. Passing the allowQuery flag, can allow or deny performing queries on index during offline mode. AllowQuery is not used when setting index back online. When dropStaleIndexes is set, indexes present on the moment of switching index offline will be marked as stale and removed on switching it back online.

Parameters:

isOnline -

allowQuery - doesn't matter, when switching index to online

dropStaleIndexes - doesn't matter, when switching index to online

Throws:

IOException

isOnline

boolean isOnline()

Offline mode means that new indexing data is collected but index is guaranteed to be unmodified during offline state.

Returns:

the state of index.

checkIndex

void checkIndex(org.exoplatform.services.jcr.dataflow.ItemDataConsumer itemStateManager,
                boolean isSystem,
                org.exoplatform.services.jcr.impl.checker.InspectionReport report)
         throws javax.jcr.RepositoryException,
                IOException

Check index consistency. Iterator goes through index documents and check, does each document have according jcr-node. If autoRepair is true - all broken index-documents will be reindexed, and documents that do not have corresponding jcr-node will be removed.

Parameters:

itemStateManager -

isSystem -

report -

Throws:

javax.jcr.RepositoryException

IOException