net.sf.mmm.search.indexer.base

Class ResourceSearchIndexerImpl

java.lang.Object

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

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

net.sf.mmm.search.indexer.base.AbstractResourceSearchIndexer

net.sf.mmm.search.indexer.base.ResourceSearchIndexerImpl

All Implemented Interfaces:

ResourceSearchIndexer

public class ResourceSearchIndexerImpl
extends AbstractResourceSearchIndexer

This is the implementation of ResourceSearchIndexer.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private FileUtil	fileUtil
private ContentParserService	parserService

Constructor Summary

Constructors

Constructor and Description
ResourceSearchIndexerImpl() The constructor.

Method Summary

Modifier and Type	Method and Description
MutableSearchEntry	createEntry(SearchIndexer indexer, DataResource resource, String resourceUri) This method creates a MutableSearchEntry for a single DataResource.
protected MutableSearchEntry	createEntry(SearchIndexer indexer, DataResource resource, String resourceUri, ContentParserOptions options)
protected void	doInitialize() This method performs the actual initialization.
protected FileUtil	getFileUtil()
protected ContentParserService	getParserService()
void	index(SearchIndexer indexer, DataResource resource, ChangeType changeType, SearchIndexerDataLocation location, EntryUpdateVisitor uriVisitor, DataResource locationResource, String nonUtfEncoding) This method indexes a single DataResource.
void	setFileUtil(FileUtil fileUtil)
void	setParserService(ContentParserService parserService)

Methods inherited from class net.sf.mmm.search.indexer.base.AbstractResourceSearchIndexer

getEntryUri, getStringProperty, index, index, index, setResourceFactory

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

Field Detail

parserService

private ContentParserService parserService

See Also:

getParserService()

fileUtil

private FileUtil fileUtil

See Also:

getFileUtil()

Constructor Detail

ResourceSearchIndexerImpl

public ResourceSearchIndexerImpl()

The constructor.

Method Detail

getParserService

protected ContentParserService getParserService()

Returns:

the parserService

setParserService

@Inject
public void setParserService(ContentParserService parserService)

Parameters:

parserService - the parserService to set

getFileUtil

protected FileUtil getFileUtil()

Returns:

the fileUtil

setFileUtil

@Inject
public void setFileUtil(FileUtil fileUtil)

Parameters:

fileUtil - is the fileUtil 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 AbstractResourceSearchIndexer

createEntry

public MutableSearchEntry createEntry(SearchIndexer indexer,
                                      DataResource resource,
                                      String resourceUri)

This method creates a MutableSearchEntry for a single DataResource. It may be used for specific situations when the ConfiguredSearchIndexer is NOT suitable. You can add additional fields before adding it to the index.
ATTENTION:
This method will NOT index the given resource. You have to do that manually after calling this method.

Parameters:

indexer - is the SearchIndexer used for indexing.

resource - is the DataResource to index.

resourceUri - is the URI for the entry.

Returns:

the created MutableSearchEntry.

createEntry

protected MutableSearchEntry createEntry(SearchIndexer indexer,
                                         DataResource resource,
                                         String resourceUri,
                                         ContentParserOptions options)

Parameters:

indexer - is the SearchIndexer used for indexing.

resource - is the DataResource to index.

resourceUri - is the URI for the entry.

options - are the options.

Returns:

the created MutableSearchEntry.

See Also:

createEntry(SearchIndexer, DataResource, String)

index

public void index(SearchIndexer indexer,
                  DataResource resource,
                  ChangeType changeType,
                  SearchIndexerDataLocation location,
                  EntryUpdateVisitor uriVisitor,
                  DataResource locationResource,
                  String nonUtfEncoding)

This method indexes a single DataResource.

Parameters:

indexer - is the SearchIndexer used for indexing.

resource - is the DataResource to index.

changeType - indicates the change for resource. In case of add it should be added, in case of update it should be updated and in case of remove it should be removed. The changeType can also be null to indicate that the resource was already indexed and remains untouched as it is not modified.

location - is the SearchIndexerDataLocation where the resource comes from.

uriVisitor - is the EntryUpdateVisitor.

locationResource - is the DataResource for SearchIndexerDataLocation.getLocationUri().

nonUtfEncoding - is the non-UTF encoding.