org.alfresco.repo.search.impl.lucene

Class ADMLuceneIndexerImpl

java.lang.Object

org.alfresco.repo.search.impl.lucene.AbstractLuceneBase

org.alfresco.repo.search.impl.lucene.AbstractLuceneIndexerImpl<org.alfresco.service.cmr.repository.NodeRef>

org.alfresco.repo.search.impl.lucene.ADMLuceneIndexerImpl

All Implemented Interfaces:

BackgroundIndexerAware, ADMLuceneIndexer, LuceneIndexer, Indexer, SupportsBackgroundIndexing, TransactionSynchronisationAwareIndexer

Direct Known Subclasses:

ADMLuceneNoActionIndexerImpl

public class ADMLuceneIndexerImpl
extends AbstractLuceneIndexerImpl<org.alfresco.service.cmr.repository.NodeRef>
implements ADMLuceneIndexer

The implementation of the lucene based indexer. Supports basic transactional behaviour if used on its own.

Author:

andyh, dward

Nested Class Summary

Nested classes/interfaces inherited from class org.alfresco.repo.search.impl.lucene.AbstractLuceneIndexerImpl

AbstractLuceneIndexerImpl.Action, AbstractLuceneIndexerImpl.Command<S>, AbstractLuceneIndexerImpl.FTSStatus, AbstractLuceneIndexerImpl.IndexUpdateStatus

Field Summary

Fields inherited from class org.alfresco.repo.search.impl.lucene.AbstractLuceneIndexerImpl

bulkLoader, commandList, containerDeletions, deletions, docs, indexUpdateStatus, maxAtomicTransformationTime, NOT_INDEXED_CONTENT_MISSING, NOT_INDEXED_NO_TRANSFORMATION, NOT_INDEXED_NO_TYPE_CONVERSION, NOT_INDEXED_TRANSFORMATION_FAILED, transactionService

Fields inherited from class org.alfresco.repo.search.impl.lucene.AbstractLuceneBase

deltaId, store

Method Summary

Modifier and Type	Method and Description
void	createChildRelationship(org.alfresco.service.cmr.repository.ChildAssociationRef relationshipRef) Create a refernce link between a parent and child.
List<org.apache.lucene.document.Document>	createDocuments(String stringNodeRef, AbstractLuceneIndexerImpl.FTSStatus ftsStatus, boolean indexAllProperties, boolean includeDirectoryDocuments, boolean cascade, Set<org.alfresco.repo.search.impl.lucene.ADMLuceneIndexerImpl.Pair<Boolean,org.alfresco.service.cmr.repository.Path>> pathsToRegenerate, Map<org.alfresco.service.cmr.repository.NodeRef,List<org.alfresco.service.cmr.repository.ChildAssociationRef>> childAssociationsSinceFlush, org.apache.lucene.index.IndexReader deltaReader, org.apache.lucene.index.IndexReader mainReader)
void	createNode(org.alfresco.service.cmr.repository.ChildAssociationRef relationshipRef) Create an index entry when a new node is created.
void	deleteChildRelationship(org.alfresco.service.cmr.repository.ChildAssociationRef relationshipRef) Delete a relationship between a parent and child.
protected Set<String>	deleteImpl(String nodeRef, org.apache.lucene.index.IndexReader deltaReader, org.apache.lucene.index.IndexReader mainReader)
void	deleteIndex(org.alfresco.service.cmr.repository.StoreRef storeRef) Delete the index for a store
protected boolean	deleteLeafOnly(String nodeRef, org.apache.lucene.index.IndexReader reader, boolean delete)
void	deleteNode(org.alfresco.service.cmr.repository.ChildAssociationRef relationshipRef) Delete a node entry from an index.
void	detectNodeChanges(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.cmr.search.SearchService searcher, Collection<org.alfresco.service.cmr.repository.ChildAssociationRef> addedParents, Collection<org.alfresco.service.cmr.repository.ChildAssociationRef> deletedParents, Collection<org.alfresco.service.cmr.repository.ChildAssociationRef> createdNodes, Collection<org.alfresco.service.cmr.repository.NodeRef> updatedNodes) Does a database vs index comparison for the given created/updated/renamed/referenced nodeRef in order to determine the set of indexing operations required
protected void	doCommit()
protected void	doPrepare()
protected void	doRollBack()
protected void	doSetRollbackOnly()
void	flushPending()
boolean	getDeleteOnlyNodes() Are we deleting leaves only (not meta data)
static ADMLuceneNoActionIndexerImpl	getNoActionIndexer(org.alfresco.service.cmr.repository.StoreRef storeRef, String deltaId, LuceneConfig config)
static ADMLuceneIndexerImpl	getUpdateIndexer(org.alfresco.service.cmr.repository.StoreRef storeRef, String deltaId, LuceneConfig config) Generate an indexer
protected boolean	indexProperty(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName propertyName, Serializable value, org.apache.lucene.document.Document doc, boolean indexAtomicPropertiesOnly, boolean isContentIndexedForNode)
protected List<org.apache.lucene.document.Document>	readDocuments(String stringNodeRef, AbstractLuceneIndexerImpl.FTSStatus ftsStatus, boolean indexAllProperties, boolean includeDirectoryDocuments, boolean cascade, Set<org.alfresco.repo.search.impl.lucene.ADMLuceneIndexerImpl.Pair<Boolean,org.alfresco.service.cmr.repository.Path>> pathsToRegenerate, Map<org.alfresco.service.cmr.repository.NodeRef,List<org.alfresco.service.cmr.repository.ChildAssociationRef>> childAssociationsSinceFlush, org.apache.lucene.index.IndexReader deltaReader, org.apache.lucene.index.IndexReader mainReader)
void	registerCallBack(FTSIndexerAware callBack) Register call back handler when the indexing chunk is done
void	setAspectIndexFilter(AspectIndexFilter aspectIndexFilter) Setter of the aspectIndexFilter
void	setContentService(ContentService contentService) IOC setting of the content service
void	setFullTextSearchIndexer(FullTextSearchIndexer fullTextSearchIndexer) Set the back ground indexer manager
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService) IOC setting of the node service
void	setTenantService(org.alfresco.repo.tenant.TenantService tenantService) IOC setting of the tenant service
void	setTransformerDebug(TransformerDebug transformerDebug) Setter of the transformer debug.
void	setTypeIndexFilter(TypeIndexFilter typeIndexFilter) Setter of the typeIndexFilter
void	updateChildRelationship(org.alfresco.service.cmr.repository.ChildAssociationRef relationshipBeforeRef, org.alfresco.service.cmr.repository.ChildAssociationRef relationshipAfterRef) Alter the relationship between parent and child nodes in the index.
int	updateFullTextSearch(int size) Peform a chunk of background FTS (and other non atomic property) indexing
void	updateNode(org.alfresco.service.cmr.repository.NodeRef nodeRef) Update an index entry due to property changes on a node.

Methods inherited from class org.alfresco.repo.search.impl.lucene.AbstractLuceneIndexerImpl

checkAbleToDoWork, commit, delete, deleteContainerAndBelow, deletePrimary, deleteReference, doInReadthroughTransaction, getContainerDeletions, getDeletions, index, isModified, locateContainer, prepare, reindex, rollback, setBulkLoader, setMaxAtomicTransformationTime, setReadThrough, setRollbackOnly, setTransactionService

Methods inherited from class org.alfresco.repo.search.impl.lucene.AbstractLuceneBase

closeDeltaReader, closeDeltaWriter, deleteIndex, doReadOnly, getDeltaId, getDeltaReader, getDeltaWriter, getDictionaryService, getLuceneConfig, getReader, getSearcher, getSearcher, getStatus, initialise, saveDelta, setDictionaryService, setInfo, setLuceneConfig, setStatus

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.alfresco.repo.search.impl.lucene.LuceneIndexer

doReadOnly, getContainerDeletions, getDeletions, getDeltaId

Methods inherited from interface org.alfresco.repo.search.Indexer

setReadThrough

Methods inherited from interface org.alfresco.repo.search.TransactionSynchronisationAwareIndexer

commit, isModified, prepare, rollback

Method Detail

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

IOC setting of the node service

Parameters:

nodeService - NodeService

setTenantService

public void setTenantService(org.alfresco.repo.tenant.TenantService tenantService)

IOC setting of the tenant service

Parameters:

tenantService - TenantService

setContentService

public void setContentService(ContentService contentService)

IOC setting of the content service

Parameters:

contentService - ContentService

setTransformerDebug

public void setTransformerDebug(TransformerDebug transformerDebug)

Setter of the transformer debug.

Parameters:

transformerDebug - TransformerDebug

setTypeIndexFilter

public void setTypeIndexFilter(TypeIndexFilter typeIndexFilter)

Setter of the typeIndexFilter

Parameters:

typeIndexFilter -

setAspectIndexFilter

public void setAspectIndexFilter(AspectIndexFilter aspectIndexFilter)

Setter of the aspectIndexFilter

Parameters:

aspectIndexFilter -

createNode

public void createNode(org.alfresco.service.cmr.repository.ChildAssociationRef relationshipRef)
                throws LuceneIndexException

Description copied from interface: Indexer

Create an index entry when a new node is created. A node is always created with a name in a given parent and so a relationship ref is required.

Specified by:

createNode in interface Indexer

Parameters:

relationshipRef - ChildAssociationRef

Throws:

LuceneIndexException

updateNode

public void updateNode(org.alfresco.service.cmr.repository.NodeRef nodeRef)
                throws LuceneIndexException

Description copied from interface: Indexer

Update an index entry due to property changes on a node. There are no strucural impications from such a change.

Specified by:

updateNode in interface Indexer

Parameters:

nodeRef - NodeRef

Throws:

LuceneIndexException

deleteNode

public void deleteNode(org.alfresco.service.cmr.repository.ChildAssociationRef relationshipRef)
                throws LuceneIndexException

Description copied from interface: Indexer

Delete a node entry from an index. This implies structural change. The node will be deleted from the index. This will also remove any remaining refernces to the node from the index. The index has no idea of the primary link.

Specified by:

deleteNode in interface Indexer

Parameters:

relationshipRef - ChildAssociationRef

Throws:

LuceneIndexException

createChildRelationship

public void createChildRelationship(org.alfresco.service.cmr.repository.ChildAssociationRef relationshipRef)
                             throws LuceneIndexException

Description copied from interface: Indexer

Create a refernce link between a parent and child. Implies only (potential) structural changes

Specified by:

createChildRelationship in interface Indexer

Parameters:

relationshipRef - ChildAssociationRef

Throws:

LuceneIndexException

updateChildRelationship

public void updateChildRelationship(org.alfresco.service.cmr.repository.ChildAssociationRef relationshipBeforeRef,
                                    org.alfresco.service.cmr.repository.ChildAssociationRef relationshipAfterRef)
                             throws LuceneIndexException

Description copied from interface: Indexer

Alter the relationship between parent and child nodes in the index. This can be used for:

1. rename,
2. move,
3. move and rename,
4. replace

This could be implemented as a delete and add but some implementations may be able to optimise this operation.

Specified by:

updateChildRelationship in interface Indexer

Parameters:

relationshipBeforeRef - ChildAssociationRef

relationshipAfterRef - ChildAssociationRef

Throws:

LuceneIndexException

deleteChildRelationship

public void deleteChildRelationship(org.alfresco.service.cmr.repository.ChildAssociationRef relationshipRef)
                             throws LuceneIndexException

Description copied from interface: Indexer

Delete a relationship between a parent and child. This will remove a structural route through the index. The index has no idea of reference and primary relationships and will happily remove the primary relationship before refernces which could remain. Use delete to ensure all strctural references are removed or call this sure you are doing an unlink (remove a hard link in the unix file system world).

Specified by:

deleteChildRelationship in interface Indexer

Parameters:

relationshipRef - ChildAssociationRef

Throws:

LuceneIndexException

getDeleteOnlyNodes

public boolean getDeleteOnlyNodes()

Are we deleting leaves only (not meta data)

Specified by:

getDeleteOnlyNodes in interface LuceneIndexer

Returns:

- deleting only nodes.

getUpdateIndexer

public static ADMLuceneIndexerImpl getUpdateIndexer(org.alfresco.service.cmr.repository.StoreRef storeRef,
                                                    String deltaId,
                                                    LuceneConfig config)
                                             throws LuceneIndexException

Generate an indexer

Parameters:

storeRef - StoreRef

deltaId - String

config - LuceneConfig

Returns:

- the indexer instance

Throws:

LuceneIndexException

getNoActionIndexer

public static ADMLuceneNoActionIndexerImpl getNoActionIndexer(org.alfresco.service.cmr.repository.StoreRef storeRef,
                                                              String deltaId,
                                                              LuceneConfig config)
                                                       throws LuceneIndexException

Throws:

LuceneIndexException

deleteLeafOnly

protected boolean deleteLeafOnly(String nodeRef,
                                 org.apache.lucene.index.IndexReader reader,
                                 boolean delete)
                          throws LuceneIndexException

Throws:

LuceneIndexException

deleteImpl

protected Set<String> deleteImpl(String nodeRef,
                                 org.apache.lucene.index.IndexReader deltaReader,
                                 org.apache.lucene.index.IndexReader mainReader)
                          throws LuceneIndexException,
                                 IOException

Throws:

LuceneIndexException

IOException

createDocuments

public List<org.apache.lucene.document.Document> createDocuments(String stringNodeRef,
                                                                 AbstractLuceneIndexerImpl.FTSStatus ftsStatus,
                                                                 boolean indexAllProperties,
                                                                 boolean includeDirectoryDocuments,
                                                                 boolean cascade,
                                                                 Set<org.alfresco.repo.search.impl.lucene.ADMLuceneIndexerImpl.Pair<Boolean,org.alfresco.service.cmr.repository.Path>> pathsToRegenerate,
                                                                 Map<org.alfresco.service.cmr.repository.NodeRef,List<org.alfresco.service.cmr.repository.ChildAssociationRef>> childAssociationsSinceFlush,
                                                                 org.apache.lucene.index.IndexReader deltaReader,
                                                                 org.apache.lucene.index.IndexReader mainReader)

detectNodeChanges

public void detectNodeChanges(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                              org.alfresco.service.cmr.search.SearchService searcher,
                              Collection<org.alfresco.service.cmr.repository.ChildAssociationRef> addedParents,
                              Collection<org.alfresco.service.cmr.repository.ChildAssociationRef> deletedParents,
                              Collection<org.alfresco.service.cmr.repository.ChildAssociationRef> createdNodes,
                              Collection<org.alfresco.service.cmr.repository.NodeRef> updatedNodes)
                       throws LuceneIndexException

Description copied from interface: Indexer

Does a database vs index comparison for the given created/updated/renamed/referenced nodeRef in order to determine the set of indexing operations required

Specified by:

detectNodeChanges in interface Indexer

Parameters:

nodeRef - the nodeRef to process

searcher - searcher to query the indexes

addedParents - set to add new secondary parent associations to

deletedParents - set to add removed secondary parent associations to

createdNodes - set to add created nodes to

updatedNodes - set to add updated nodes to

Throws:

LuceneIndexException

flushPending

public void flushPending()
                  throws LuceneIndexException

Specified by:

flushPending in interface Indexer

Throws:

LuceneIndexException

indexProperty

protected boolean indexProperty(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                org.alfresco.service.namespace.QName propertyName,
                                Serializable value,
                                org.apache.lucene.document.Document doc,
                                boolean indexAtomicPropertiesOnly,
                                boolean isContentIndexedForNode)

Parameters:

indexAtomicPropertiesOnly - true to ignore all properties that must be indexed non-atomically

Returns:

Returns true if the property was indexed atomically, or false if it should be done asynchronously

updateFullTextSearch

public int updateFullTextSearch(int size)
                         throws LuceneIndexException

Description copied from interface: BackgroundIndexerAware

Peform a chunk of background FTS (and other non atomic property) indexing

Specified by:

updateFullTextSearch in interface BackgroundIndexerAware

Parameters:

size - int

Returns:

- the number of docs updates

Throws:

LuceneIndexException

readDocuments

protected List<org.apache.lucene.document.Document> readDocuments(String stringNodeRef,
                                                                  AbstractLuceneIndexerImpl.FTSStatus ftsStatus,
                                                                  boolean indexAllProperties,
                                                                  boolean includeDirectoryDocuments,
                                                                  boolean cascade,
                                                                  Set<org.alfresco.repo.search.impl.lucene.ADMLuceneIndexerImpl.Pair<Boolean,org.alfresco.service.cmr.repository.Path>> pathsToRegenerate,
                                                                  Map<org.alfresco.service.cmr.repository.NodeRef,List<org.alfresco.service.cmr.repository.ChildAssociationRef>> childAssociationsSinceFlush,
                                                                  org.apache.lucene.index.IndexReader deltaReader,
                                                                  org.apache.lucene.index.IndexReader mainReader)

registerCallBack

public void registerCallBack(FTSIndexerAware callBack)

Description copied from interface: BackgroundIndexerAware

Register call back handler when the indexing chunk is done

Specified by:

registerCallBack in interface BackgroundIndexerAware

Parameters:

callBack - FTSIndexerAware

setFullTextSearchIndexer

public void setFullTextSearchIndexer(FullTextSearchIndexer fullTextSearchIndexer)

Description copied from interface: SupportsBackgroundIndexing

Set the back ground indexer manager

Specified by:

setFullTextSearchIndexer in interface SupportsBackgroundIndexing

Parameters:

fullTextSearchIndexer - FullTextSearchIndexer

doPrepare

protected void doPrepare()
                  throws IOException

Specified by:

doPrepare in class AbstractLuceneIndexerImpl<org.alfresco.service.cmr.repository.NodeRef>

Throws:

IOException

doCommit

protected void doCommit()
                 throws IOException

Specified by:

doCommit in class AbstractLuceneIndexerImpl<org.alfresco.service.cmr.repository.NodeRef>

Throws:

IOException

doRollBack

protected void doRollBack()
                   throws IOException

Specified by:

doRollBack in class AbstractLuceneIndexerImpl<org.alfresco.service.cmr.repository.NodeRef>

Throws:

IOException

doSetRollbackOnly

protected void doSetRollbackOnly()
                          throws IOException

Specified by:

doSetRollbackOnly in class AbstractLuceneIndexerImpl<org.alfresco.service.cmr.repository.NodeRef>

Throws:

IOException

deleteIndex

public void deleteIndex(org.alfresco.service.cmr.repository.StoreRef storeRef)

Description copied from interface: Indexer

Delete the index for a store

Specified by:

deleteIndex in interface Indexer

Parameters:

storeRef - StoreRef