org.apache.jackrabbit.core.query.lucene

Class JahiaSearchIndex

java.lang.Object

org.apache.jackrabbit.core.query.AbstractQueryHandler

org.apache.jackrabbit.core.query.lucene.SearchIndex

org.apache.jackrabbit.core.query.lucene.JahiaSearchIndex

All Implemented Interfaces:

org.apache.jackrabbit.core.query.QueryHandler

Direct Known Subclasses:

JahiaSecondaryIndex

public class JahiaSearchIndex
extends org.apache.jackrabbit.core.query.lucene.SearchIndex

Implements a QueryHandler using Lucene and handling Jahia specific definitions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JahiaSearchIndex.ReindexJob Background job that performs re-indexing of the repository content for the specified workspaces.

Nested classes/interfaces inherited from class org.apache.jackrabbit.core.query.lucene.SearchIndex

org.apache.jackrabbit.core.query.lucene.SearchIndex.CombinedIndexReader

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	SKIP_VERSION_INDEX
static String	SKIP_VERSION_INDEX_SYSTEM_PROPERTY

Fields inherited from class org.apache.jackrabbit.core.query.lucene.SearchIndex

DEFAULT_EXTRACTOR_BACK_LOG, DEFAULT_EXTRACTOR_POOL_SIZE, DEFAULT_EXTRACTOR_TIMEOUT, DEFAULT_MAX_FIELD_LENGTH, DEFAULT_MAX_MERGE_DOCS, DEFAULT_MERGE_FACTOR, DEFAULT_MIN_MERGE_DOCS, DEFAULT_TERM_INFOS_INDEX_DIVISOR, index, JCR_SYSTEM_PATH, PATH_FACTORY, ROOT_PATH, VALID_SYSTEM_INDEX_NODE_TYPE_NAMES

Fields inherited from class org.apache.jackrabbit.core.query.AbstractQueryHandler

fs

Constructor Summary

Constructors

Constructor and Description
JahiaSearchIndex()

Method Summary

Modifier and Type	Method and Description
protected org.apache.lucene.document.Document	createDocument(org.apache.jackrabbit.core.state.NodeState node, org.apache.jackrabbit.core.query.lucene.NamespaceMappings nsMappings, org.apache.jackrabbit.core.query.lucene.IndexFormatVersion indexFormatVersion)
org.apache.jackrabbit.core.query.ExecutableQuery	createExecutableQuery(org.apache.jackrabbit.core.session.SessionContext sessionContext, String statement, String language)
protected org.apache.jackrabbit.core.query.lucene.IndexingConfiguration	createIndexingConfiguration(org.apache.jackrabbit.core.query.lucene.NamespaceMappings namespaceMappings)
protected org.apache.tika.parser.Parser	createParser()
javax.jcr.query.qom.QueryObjectModel	createQueryObjectModel(org.apache.jackrabbit.core.session.SessionContext sessionContext, org.apache.jackrabbit.spi.commons.query.qom.QueryObjectModelTree qomTree, String language, javax.jcr.Node node)
protected void	doInit()
org.apache.jackrabbit.core.query.lucene.MultiColumnQueryHits	executeQuery(org.apache.jackrabbit.core.SessionImpl session, org.apache.jackrabbit.core.query.lucene.AbstractQueryImpl queryImpl, org.apache.lucene.search.Query query, org.apache.jackrabbit.spi.Path[] orderProps, boolean[] orderSpecs, String[] orderFuncs, long resultFetchHint) Executes the query on the search index.
org.apache.jackrabbit.core.query.lucene.MultiColumnQueryHits	executeQuery(org.apache.jackrabbit.core.SessionImpl session, org.apache.jackrabbit.core.query.lucene.MultiColumnQuery query, org.apache.jackrabbit.core.query.lucene.Ordering[] orderings, long resultFetchHint) Executes the query on the search index.
protected org.apache.jackrabbit.core.query.lucene.AnalyzerRegistry	getAnalyzerRegistry()
int	getBatchSize()
int	getDefaultWaitTime()
protected org.apache.lucene.index.IndexReader	getIndexReader(boolean includeSystemIndex)
int	getMaxClauseCount()
Set<String>	getTypesUsingOptimizedACEIndexation() Return the list of types which can benefit of the optimized ACE indexation.
Iterable<org.apache.jackrabbit.core.id.NodeId>	getWeaklyReferringNodes(org.apache.jackrabbit.core.id.NodeId id)
static boolean	isAclUuidInIndex(org.apache.jackrabbit.core.query.lucene.SearchIndex index) Returns true if the supplied SearchIndex implementation has ACL-UUID stored in index.
boolean	isAddAclUuidInIndex() Returns true if ACL-UUID should be resolved and stored in index.
protected boolean	isNodeExcluded(org.apache.jackrabbit.core.state.NodeState node)
boolean	prepareReindexing() Prepares for a re-indexing of the repository content, creating a secondary index instance.
void	reindexTree(String startNodeId) Re-indexes the full JCR sub-tree, starting from the specified node.
void	scheduleReindexing() Schedules the re-indexing of the repository content in a background job.
void	setAddAclUuidInIndex(boolean addAclUuidInIndex)
void	setBatchSize(int batchSize) Set the maximum number of documents that will be sent in one batch to the index for certain mass indexing requests, like after ACL change
void	setDefaultWaitTime(int defaultWaitTime)
void	setIgnoredTypes(String ignoredTypes)
void	setMaxClauseCount(int maxClauseCount)
void	setTypesUsingOptimizedACEIndexation(String typesUsingOptimizedACEIndexation)
void	switchReadOnlyMode(boolean enable)
void	updateNodes(Iterator<org.apache.jackrabbit.core.id.NodeId> remove, Iterator<org.apache.jackrabbit.core.state.NodeState> add) We override this method in order to trigger re-indexing on translation nodes, when their parent node is getting re-indexed.

Methods inherited from class org.apache.jackrabbit.core.query.lucene.SearchIndex

addNode, checkOpen, close, createDirectoryManager, createExcerptProvider, createOrderings, createRedoLogFactory, createSortFields, createSpellChecker, createSynonymProvider, createSynonymProviderConfigResource, deleteNode, flush, getAnalyzer, getAutoRepair, getBufferSize, getCacheSize, getDirectoryManager, getDirectoryManagerClass, getEnableConsistencyCheck, getExcerptProviderClass, getExtractorBackLogSize, getExtractorPoolSize, getExtractorTimeout, getForceConsistencyCheck, getForkJavaCommand, getIndex, getIndexFormatVersion, getIndexingConfig, getIndexingConfiguration, getIndexingConfigurationClass, getIndexingConfigurationDOM, getIndexReader, getMaxExtractLength, getMaxFieldLength, getMaxHistoryAge, getMaxMergeDocs, getMaxVolatileIndexSize, getMergeFactor, getMinMergeDocs, getNamespaceMappings, getParser, getPath, getQueryNodeFactory, getRedoLogFactory, getRedoLogFactoryClass, getRelativePath, getRespectDocumentOrder, getResultFetchSize, getSimilarity, getSimilarityClass, getSizeEstimate, getSortComparatorSource, getSpellChecker, getSpellCheckerClass, getSupportHighlighting, getSynonymProvider, getSynonymProviderClass, getSynonymProviderConfigPath, getTermInfosIndexDivisor, getTextAnalyzer, getTextFilterClasses, getTikaConfigPath, getUseCompoundFile, getVolatileIdleTime, isInitializeHierarchyCache, isUseSimpleFSDirectory, mergeAggregatedNodeIndexes, retrieveAggregateRoot, retrieveAggregateRoot, runConsistencyCheck, setAnalyzer, setAutoRepair, setBufferSize, setCacheSize, setDirectoryManagerClass, setEnableConsistencyCheck, setExcerptProviderClass, setExtractorBackLogSize, setExtractorPoolSize, setExtractorTimeout, setForceConsistencyCheck, setForkJavaCommand, setIndexingConfiguration, setIndexingConfigurationClass, setInitializeHierarchyCache, setMaxExtractLength, setMaxFieldLength, setMaxHistoryAge, setMaxMergeDocs, setMaxVolatileIndexSize, setMergeFactor, setMinMergeDocs, setPath, setRedoLogFactoryClass, setRespectDocumentOrder, setResultFetchSize, setSimilarityClass, setSizeEstimate, setSpellCheckerClass, setSupportHighlighting, setSynonymProviderClass, setSynonymProviderConfigPath, setTermInfosIndexDivisor, setTextFilterClasses, setTikaConfigPath, setUseCompoundFile, setUseSimpleFSDirectory, setVolatileIdleTime

Methods inherited from class org.apache.jackrabbit.core.query.AbstractQueryHandler

getContext, getIdleTime, getOnWorkspaceInconsistency, getOnWorkspaceInconsistencyHandler, getQueryClass, init, setIdleTime, setOnWorkspaceInconsistency, setQueryClass

Methods inherited from class java.lang.Object

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

Field Detail

SKIP_VERSION_INDEX_SYSTEM_PROPERTY

public static final String SKIP_VERSION_INDEX_SYSTEM_PROPERTY

See Also:

Constant Field Values

SKIP_VERSION_INDEX

public static final boolean SKIP_VERSION_INDEX

Constructor Detail

JahiaSearchIndex

public JahiaSearchIndex()

Method Detail

isAclUuidInIndex

public static boolean isAclUuidInIndex(org.apache.jackrabbit.core.query.lucene.SearchIndex index)

Returns true if the supplied SearchIndex implementation has ACL-UUID stored in index.

Returns:

true if the supplied SearchIndex implementation has ACL-UUID stored in index

getMaxClauseCount

public int getMaxClauseCount()

setMaxClauseCount

public void setMaxClauseCount(int maxClauseCount)

getBatchSize

public int getBatchSize()

setBatchSize

public void setBatchSize(int batchSize)

Set the maximum number of documents that will be sent in one batch to the index for certain mass indexing requests, like after ACL change

Parameters:

batchSize -

isAddAclUuidInIndex

public boolean isAddAclUuidInIndex()

Returns true if ACL-UUID should be resolved and stored in index. This can have a negative effect on performance, when setting rights on a node, which has a large subtree using the same rights, as all these nodes will need to be reindexed. On the other side the advantage is that the queries are faster, as the user rights are resolved faster.

Returns:

Returns true if ACL-UUID should be resolved and stored in index.

setAddAclUuidInIndex

public void setAddAclUuidInIndex(boolean addAclUuidInIndex)

getTypesUsingOptimizedACEIndexation

public Set<String> getTypesUsingOptimizedACEIndexation()

Return the list of types which can benefit of the optimized ACE indexation.

Returns:

setTypesUsingOptimizedACEIndexation

public void setTypesUsingOptimizedACEIndexation(String typesUsingOptimizedACEIndexation)

setIgnoredTypes

public void setIgnoredTypes(String ignoredTypes)

getDefaultWaitTime

public int getDefaultWaitTime()

setDefaultWaitTime

public void setDefaultWaitTime(int defaultWaitTime)

doInit

protected void doInit()
               throws IOException

Overrides:

doInit in class org.apache.jackrabbit.core.query.lucene.SearchIndex

Throws:

IOException

getAnalyzerRegistry

protected org.apache.jackrabbit.core.query.lucene.AnalyzerRegistry getAnalyzerRegistry()

Overrides:

getAnalyzerRegistry in class org.apache.jackrabbit.core.query.lucene.SearchIndex

createIndexingConfiguration

protected org.apache.jackrabbit.core.query.lucene.IndexingConfiguration createIndexingConfiguration(org.apache.jackrabbit.core.query.lucene.NamespaceMappings namespaceMappings)

Overrides:

createIndexingConfiguration in class org.apache.jackrabbit.core.query.lucene.SearchIndex

getIndexReader

protected org.apache.lucene.index.IndexReader getIndexReader(boolean includeSystemIndex)
                                                      throws IOException

Overrides:

getIndexReader in class org.apache.jackrabbit.core.query.lucene.SearchIndex

Throws:

IOException

updateNodes

public void updateNodes(Iterator<org.apache.jackrabbit.core.id.NodeId> remove,
                        Iterator<org.apache.jackrabbit.core.state.NodeState> add)
                 throws javax.jcr.RepositoryException,
                        IOException

We override this method in order to trigger re-indexing on translation nodes, when their parent node is getting re-indexed.

After that we just call the updateNodes from the Jackrabbut SearchIndex implementation.

Specified by:

updateNodes in interface org.apache.jackrabbit.core.query.QueryHandler

Overrides:

updateNodes in class org.apache.jackrabbit.core.query.lucene.SearchIndex

Parameters:

remove - ids of nodes to remove.

add - NodeStates to add. Calls to next() on this iterator may return null, to indicate that a node could not be indexed successfully.

Throws:

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

IOException - if an error occurs while updating the index.

createDocument

protected org.apache.lucene.document.Document createDocument(org.apache.jackrabbit.core.state.NodeState node,
                                                             org.apache.jackrabbit.core.query.lucene.NamespaceMappings nsMappings,
                                                             org.apache.jackrabbit.core.query.lucene.IndexFormatVersion indexFormatVersion)
                                                      throws javax.jcr.RepositoryException

Overrides:

createDocument in class org.apache.jackrabbit.core.query.lucene.SearchIndex

Throws:

javax.jcr.RepositoryException

isNodeExcluded

protected boolean isNodeExcluded(org.apache.jackrabbit.core.state.NodeState node)
                          throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

createQueryObjectModel

public javax.jcr.query.qom.QueryObjectModel createQueryObjectModel(org.apache.jackrabbit.core.session.SessionContext sessionContext,
                                                                   org.apache.jackrabbit.spi.commons.query.qom.QueryObjectModelTree qomTree,
                                                                   String language,
                                                                   javax.jcr.Node node)
                                                            throws javax.jcr.RepositoryException

Specified by:

createQueryObjectModel in interface org.apache.jackrabbit.core.query.QueryHandler

Overrides:

createQueryObjectModel in class org.apache.jackrabbit.core.query.lucene.SearchIndex

Throws:

javax.jcr.RepositoryException

createExecutableQuery

public org.apache.jackrabbit.core.query.ExecutableQuery createExecutableQuery(org.apache.jackrabbit.core.session.SessionContext sessionContext,
                                                                              String statement,
                                                                              String language)
                                                                       throws javax.jcr.query.InvalidQueryException

Specified by:

createExecutableQuery in interface org.apache.jackrabbit.core.query.QueryHandler

Overrides:

createExecutableQuery in class org.apache.jackrabbit.core.query.lucene.SearchIndex

Throws:

javax.jcr.query.InvalidQueryException

getWeaklyReferringNodes

public Iterable<org.apache.jackrabbit.core.id.NodeId> getWeaklyReferringNodes(org.apache.jackrabbit.core.id.NodeId id)
                                                                       throws javax.jcr.RepositoryException,
                                                                              IOException

Specified by:

getWeaklyReferringNodes in interface org.apache.jackrabbit.core.query.QueryHandler

Overrides:

getWeaklyReferringNodes in class org.apache.jackrabbit.core.query.lucene.SearchIndex

Throws:

javax.jcr.RepositoryException

IOException

createParser

protected org.apache.tika.parser.Parser createParser()

Overrides:

createParser in class org.apache.jackrabbit.core.query.lucene.SearchIndex

prepareReindexing

public boolean prepareReindexing()

Prepares for a re-indexing of the repository content, creating a secondary index instance.

scheduleReindexing

public void scheduleReindexing()

Schedules the re-indexing of the repository content in a background job.

reindexTree

public void reindexTree(String startNodeId)
                 throws javax.jcr.RepositoryException,
                        org.apache.jackrabbit.core.state.NoSuchItemStateException,
                        IllegalArgumentException,
                        org.apache.jackrabbit.core.state.ItemStateException,
                        IOException

Re-indexes the full JCR sub-tree, starting from the specified node.

Parameters:

startNodeId - the UUID of the node to start re-indexing with

Throws:

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

org.apache.jackrabbit.core.state.NoSuchItemStateException - in case of JCR errors

IllegalArgumentException - in case of JCR errors

org.apache.jackrabbit.core.state.ItemStateException - in case of JCR errors

IOException - if an error occurs while updating the index

executeQuery

public org.apache.jackrabbit.core.query.lucene.MultiColumnQueryHits executeQuery(org.apache.jackrabbit.core.SessionImpl session,
                                                                                 org.apache.jackrabbit.core.query.lucene.AbstractQueryImpl queryImpl,
                                                                                 org.apache.lucene.search.Query query,
                                                                                 org.apache.jackrabbit.spi.Path[] orderProps,
                                                                                 boolean[] orderSpecs,
                                                                                 String[] orderFuncs,
                                                                                 long resultFetchHint)
                                                                          throws IOException

Executes the query on the search index.

Overrides:

executeQuery in class org.apache.jackrabbit.core.query.lucene.SearchIndex

Parameters:

session - the session that executes the query.

queryImpl - the query impl.

query - the lucene query.

orderProps - name of the properties for sort order.

orderSpecs - the order specs for the sort order properties. true indicates ascending order, false indicates descending.

orderFuncs - functions for the properties for sort order.

resultFetchHint - a hint on how many results should be fetched. @return the query hits.

Throws:

IOException - if an error occurs while searching the index.

executeQuery

public org.apache.jackrabbit.core.query.lucene.MultiColumnQueryHits executeQuery(org.apache.jackrabbit.core.SessionImpl session,
                                                                                 org.apache.jackrabbit.core.query.lucene.MultiColumnQuery query,
                                                                                 org.apache.jackrabbit.core.query.lucene.Ordering[] orderings,
                                                                                 long resultFetchHint)
                                                                          throws IOException

Executes the query on the search index.

Overrides:

executeQuery in class org.apache.jackrabbit.core.query.lucene.SearchIndex

Parameters:

session - the session that executes the query.

query - the query.

orderings - the order specs for the sort order.

resultFetchHint - a hint on how many results should be fetched.

Returns:

the query hits.

Throws:

IOException - if an error occurs while searching the index.

switchReadOnlyMode

public void switchReadOnlyMode(boolean enable)