net.sf.mmm.search.indexer.api

Interface ResourceSearchIndexer

All Known Implementing Classes:

AbstractResourceSearchIndexer, ResourceSearchIndexerImpl

@ComponentSpecification
public interface ResourceSearchIndexer

This is the interface for a higher-level SearchIndexer. It can index

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

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.
void	index(SearchIndexer indexer, DataResource resource, ChangeType changeType, SearchIndexerDataLocation location) This method indexes a single DataResource.
void	index(SearchIndexer indexer, DataResource resource, ChangeType changeType, SearchIndexerDataLocation location, EntryUpdateVisitor uriVisitor) This method indexes a single DataResource.
void	index(SearchIndexer indexer, DataResource resource, ChangeType changeType, SearchIndexerDataLocation location, EntryUpdateVisitor uriVisitor, DataResource locationFolder) This method indexes a single DataResource.
void	index(SearchIndexer indexer, DataResource resource, ChangeType changeType, SearchIndexerDataLocation location, EntryUpdateVisitor uriVisitor, DataResource locationFolder, String nonUtfEncoding) This method indexes a single DataResource.

Method Detail

createEntry

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.

index

void index(SearchIndexer indexer,
           DataResource resource,
           ChangeType changeType,
           SearchIndexerDataLocation location)

This method indexes a single DataResource.
ATTENTION:
If you are indexing many resources, you should use index(SearchIndexer, DataResource, ChangeType, SearchIndexerDataLocation, EntryUpdateVisitor, DataResource) to avoid performance-overhead.

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.

index

void index(SearchIndexer indexer,
           DataResource resource,
           ChangeType changeType,
           SearchIndexerDataLocation location,
           EntryUpdateVisitor uriVisitor)

This method indexes a single DataResource.
ATTENTION:
If you are indexing many resources, you should use index(SearchIndexer, DataResource, ChangeType, SearchIndexerDataLocation, EntryUpdateVisitor, DataResource) to avoid performance-overhead.

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.

index

void index(SearchIndexer indexer,
           DataResource resource,
           ChangeType changeType,
           SearchIndexerDataLocation location,
           EntryUpdateVisitor uriVisitor,
           DataResource locationFolder)

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.

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

index

void index(SearchIndexer indexer,
           DataResource resource,
           ChangeType changeType,
           SearchIndexerDataLocation location,
           EntryUpdateVisitor uriVisitor,
           DataResource locationFolder,
           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.

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

nonUtfEncoding - is the non-UTF encoding.

Since:

1.0.1