org.olat.search.service.indexer
Class ContextHelpIndexer

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

All Implemented Interfaces:

Indexer

public class ContextHelpIndexer
extends AbstractIndexer

Description:
This indexer indexes the context sensitive help system

Initial Date: 05.11.2008

Author:

gnaegi

Constructor Summary

ContextHelpIndexer()

Method Summary

boolean	checkAccess(ContextEntry contextEntry, BusinessControl businessControl, Identity identity, Roles roles) Check access for certain business-control (resourceUrl) and user with roles.
void	doIndex(SearchResourceContext parentResourceContext, java.lang.Object parentObject, OlatFullIndexer indexWriter) Iterate over all child indexer define in indexer-list.
java.lang.String	getSupportedTypeName()

Methods inherited from class org.olat.search.service.indexer.AbstractIndexer

checkAccess, setIndexerList

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextHelpIndexer

public ContextHelpIndexer()

Method Detail

checkAccess

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

Description copied from interface: Indexer

Check access for certain business-control (resourceUrl) and user with roles.

Returns:

See Also:

Indexer.checkAccess(org.olat.core.id.context.ContextEntry, org.olat.core.id.context.BusinessControl, org.olat.core.id.Identity, org.olat.core.id.Roles)

getSupportedTypeName

public java.lang.String getSupportedTypeName()

Returns:

The indexer supports this type name. E.g. ORES_TOOLFOLDER.getResourceableTypeName()

See Also:

Indexer.getSupportedTypeName()

doIndex

public void doIndex(SearchResourceContext parentResourceContext,
                    java.lang.Object parentObject,
                    OlatFullIndexer indexWriter)
             throws java.io.IOException,
                    java.lang.InterruptedException

Description copied from class: AbstractIndexer

Iterate over all child indexer define in indexer-list.

Specified by:

doIndex in interface Indexer

Overrides:

doIndex in class AbstractIndexer

Parameters:

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

indexWriter - 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:

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