net.sf.mmm.search.indexer.base.strategy

Class AbstractSearchIndexerUpdateStrategy

java.lang.Object

net.sf.mmm.util.component.base.AbstractComponent

net.sf.mmm.util.component.base.AbstractLoggableComponent

net.sf.mmm.search.indexer.base.strategy.AbstractSearchIndexerUpdateStrategy

All Implemented Interfaces:

SearchIndexerUpdateStrategy

Direct Known Subclasses:

BasicSearchIndexerUpdateStrategy

public abstract class AbstractSearchIndexerUpdateStrategy
extends AbstractLoggableComponent
implements SearchIndexerUpdateStrategy

This is the abstract base-implementation of the SearchIndexerUpdateStrategy interface.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CONTEXT_VARIABLE_ENTRY_UPDATE_VISITOR The key for the CountingEntryUpdateVisitor.
protected static String	CONTEXT_VARIABLE_RESOURCE_URI_SET The key for the Set of resource-URIs.
private IndexerDependencies	indexerDependencies

Constructor Summary

Constructors

Constructor and Description
AbstractSearchIndexerUpdateStrategy() The constructor.

Method Summary

Modifier and Type	Method and Description
protected CountingEntryUpdateVisitor	createEntryUpdateVisitor() This method creates the CountingEntryUpdateVisitor to use.
protected void	doInitialize() This method performs the actual initialization.
protected ChangeType	getChangeType(BrowsableResource resource, UpdateStrategyArguments arguments) This method determines the ChangeType of the given resource.
protected CountingEntryUpdateVisitor	getEntryUpdateVisitor(UpdateStrategyArguments arguments) This method gets the CountingEntryUpdateVisitor to use.
protected IndexerDependencies	getIndexerDependencies()
void	index(UpdateStrategyArguments arguments) This method performs the actual indexing.
abstract void	index(UpdateStrategyArguments arguments, SearchIndexerDataLocation location, EntryUpdateVisitor entryUpdateVisitor) This method indexes as single location.
void	indexRecursive(UpdateStrategyArguments arguments, SearchIndexerDataLocation location, BrowsableResource resource, Set<String> visitedResources, EntryUpdateVisitor entryUpdateVisitor, BrowsableResource locationResource) This method starts the indexing from the given directory adding the given source as metadata.
void	indexRecursive(UpdateStrategyArguments arguments, SearchIndexerDataLocation location, EntryUpdateVisitor entryUpdateVisitor) This method indexes as single location by recursively crawling the resources.
protected boolean	isFullIndexing(UpdateStrategyArguments arguments) This method determines if full indexing from scratch shall be performed.
protected void	postIndex(UpdateStrategyArguments arguments) This method is called at the end of index(UpdateStrategyArguments) to complete the indexing.
protected void	preIndex(UpdateStrategyArguments arguments) This method is called at the beginning of index(UpdateStrategyArguments) to setup the indexing.
void	setIndexerDependencies(IndexerDependencies indexerDependencies)

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableComponent

createLogger, getLogger

Methods inherited from class net.sf.mmm.util.component.base.AbstractComponent

doInitialized, getInitializationState, initialize

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.search.indexer.api.strategy.SearchIndexerUpdateStrategy

isResponsible

Field Detail

CONTEXT_VARIABLE_RESOURCE_URI_SET

protected static final String CONTEXT_VARIABLE_RESOURCE_URI_SET

The key for the Set of resource-URIs.

See Also:

Constant Field Values

CONTEXT_VARIABLE_ENTRY_UPDATE_VISITOR

protected static final String CONTEXT_VARIABLE_ENTRY_UPDATE_VISITOR

The key for the CountingEntryUpdateVisitor.

indexerDependencies

private IndexerDependencies indexerDependencies

See Also:

getIndexerDependencies()

Constructor Detail

AbstractSearchIndexerUpdateStrategy

public AbstractSearchIndexerUpdateStrategy()

The constructor.

Method Detail

getIndexerDependencies

protected IndexerDependencies getIndexerDependencies()

Returns:

the deltaIndexerDependencies

setIndexerDependencies

@Inject
public void setIndexerDependencies(IndexerDependencies indexerDependencies)

Parameters:

indexerDependencies - is the deltaIndexerDependencies to set

doInitialize

protected void doInitialize()

This method performs the actual initialization. It is called when AbstractComponent.initialize() is invoked for the first time.
ATTENTION:
When you override this method from a sub-class you need to do a super.AbstractComponent.doInitialize().

Overrides:

doInitialize in class AbstractLoggableComponent

isFullIndexing

protected boolean isFullIndexing(UpdateStrategyArguments arguments)

This method determines if full indexing from scratch shall be performed.

Parameters:

arguments - are the UpdateStrategyArgumentsBean.

Returns:

true if all resources shall be added to the indexed, false if only modified resources shall be updated in the index.

preIndex

protected void preIndex(UpdateStrategyArguments arguments)

This method is called at the beginning of index(UpdateStrategyArguments) to setup the indexing.

Parameters:

arguments - are the UpdateStrategyArgumentsBean.

postIndex

protected void postIndex(UpdateStrategyArguments arguments)

This method is called at the end of index(UpdateStrategyArguments) to complete the indexing.

Parameters:

arguments - are the UpdateStrategyArgumentsBean.

index

public void index(UpdateStrategyArguments arguments)

This method performs the actual indexing.

Specified by:

index in interface SearchIndexerUpdateStrategy

Parameters:

arguments - are the UpdateStrategyArguments for the indexing.

index

public abstract void index(UpdateStrategyArguments arguments,
                           SearchIndexerDataLocation location,
                           EntryUpdateVisitor entryUpdateVisitor)

This method indexes as single location.

Parameters:

arguments - are the UpdateStrategyArgumentsBean.

location - is the SearchIndexerDataLocation to index.

entryUpdateVisitor - is the EntryUpdateVisitor.

indexRecursive

public final void indexRecursive(UpdateStrategyArguments arguments,
                                 SearchIndexerDataLocation location,
                                 EntryUpdateVisitor entryUpdateVisitor)

This method indexes as single location by recursively crawling the resources.

Parameters:

arguments - are the UpdateStrategyArgumentsBean.

location - is the SearchIndexerDataLocation to index.

entryUpdateVisitor - is the EntryUpdateVisitor.

createEntryUpdateVisitor

protected CountingEntryUpdateVisitor createEntryUpdateVisitor()

This method creates the CountingEntryUpdateVisitor to use.

Returns:

the CountingEntryUpdateVisitor.

See Also:

ResourceSearchIndexer.index(net.sf.mmm.search.indexer.api.SearchIndexer, net.sf.mmm.util.resource.api.DataResource, ChangeType, SearchIndexerDataLocation, EntryUpdateVisitor)

getEntryUpdateVisitor

protected final CountingEntryUpdateVisitor getEntryUpdateVisitor(UpdateStrategyArguments arguments)

This method gets the CountingEntryUpdateVisitor to use.

Parameters:

arguments - are the UpdateStrategyArguments.

Returns:

the CountingEntryUpdateVisitor.

See Also:

createEntryUpdateVisitor()

getChangeType

protected ChangeType getChangeType(BrowsableResource resource,
                                   UpdateStrategyArguments arguments)

This method determines the ChangeType of the given resource.

Parameters:

resource - is the BrowsableResource for which to determine the ChangeType.

arguments - are the UpdateStrategyArguments.

Returns:

the ChangeType indicating how the given resource shall be updated or null to indicate that the resource shall remain unchanged.

See Also:

SearchIndexerSourceState.getIndexingDate()

indexRecursive

public void indexRecursive(UpdateStrategyArguments arguments,
                           SearchIndexerDataLocation location,
                           BrowsableResource resource,
                           Set<String> visitedResources,
                           EntryUpdateVisitor entryUpdateVisitor,
                           BrowsableResource locationResource)

This method starts the indexing from the given directory adding the given source as metadata.

Parameters:

arguments - are the UpdateStrategyArguments.

location - is the SearchIndexerDataLocation.

resource - is the resource (directory) to index recursively.

visitedResources - is the Set with the URIs of the resources that have already been crawled.

entryUpdateVisitor - is the EntryUpdateVisitor.

locationResource - is the resource for SearchIndexerDataLocation.getLocationUri() of the given location.

See Also:

SearchEntry.getSource()