org.olat.search.service.indexer
Class AbstractIndexer

java.lang.Object
  org.olat.search.service.indexer.AbstractIndexer

All Implemented Interfaces:

Indexer

Direct Known Subclasses:

ContextHelpIndexer, FolderIndexer, ForumIndexer, GroupIndexer, IdentityIndexer, MainIndexer, ProfileIndexer

public abstract class AbstractIndexer
extends java.lang.Object
implements Indexer

Common abstract indexer. Used as base class for indexers.

Author:

Christian Guretzki

Constructor Summary

AbstractIndexer()

Method Summary

boolean	checkAccess(BusinessControl businessControl, Identity identity, Roles roles)
void	doIndex(SearchResourceContext searchResourceContext, java.lang.Object object, OlatFullIndexer indexerWriter) Iterate over all child indexer define in indexer-list.
void	setIndexerList(java.util.List<Indexer> indexerList) Bean setter method used by spring.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.olat.search.service.indexer.Indexer

checkAccess, getSupportedTypeName

Constructor Detail

AbstractIndexer

public AbstractIndexer()

Method Detail

setIndexerList

public void setIndexerList(java.util.List<Indexer> indexerList)

Bean setter method used by spring.

Parameters:

indexerList -

doIndex

public void doIndex(SearchResourceContext searchResourceContext,
                    java.lang.Object object,
                    OlatFullIndexer indexerWriter)
             throws java.io.IOException,
                    java.lang.InterruptedException

Iterate over all child indexer define in indexer-list.

Specified by:

doIndex in interface Indexer

Parameters:

searchResourceContext - Current search-resource-context is used to build resouceUrl of an index-element.

indexerWriter - Callback object to add documents to the index.

Throws:

java.io.IOException - Can not write index file.

java.lang.InterruptedException - Indexing is interrupted

See Also:

Indexer.doIndex(org.olat.search.service.SearchResourceContext, java.lang.Object, org.olat.search.service.indexer.OlatFullIndexer)

checkAccess

public boolean checkAccess(BusinessControl businessControl,
                           Identity identity,
                           Roles roles)

Parameters:

businessControl -

identity -

roles -

Returns: