net.sf.mmm.search.indexer.base

Class AbstractResourceSearchIndexer

java.lang.Object

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

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

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

All Implemented Interfaces:

ResourceSearchIndexer

Direct Known Subclasses:

ResourceSearchIndexerImpl

public abstract class AbstractResourceSearchIndexer
extends AbstractLoggableComponent
implements ResourceSearchIndexer

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

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private DataResourceFactory	resourceFactory

Constructor Summary

Constructors

Constructor and Description
AbstractResourceSearchIndexer() The constructor.

Method Summary

Modifier and Type	Method and Description
protected void	doInitialize() This method performs the actual initialization.
protected String	getEntryUri(DataResource resource, SearchIndexerDataLocation location, DataResource locationResource) This method determines the entry URI for the given resourceUri.
protected String	getStringProperty(GenericContext context, String key) This method gets the property key from the given properties.
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	setResourceFactory(DataResourceFactory resourceFactory)

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.ResourceSearchIndexer

createEntry, index

Field Detail

resourceFactory

private DataResourceFactory resourceFactory

See Also:

setResourceFactory(DataResourceFactory)

Constructor Detail

AbstractResourceSearchIndexer

public AbstractResourceSearchIndexer()

The constructor.

Method Detail

setResourceFactory

@Inject
public void setResourceFactory(DataResourceFactory resourceFactory)

Parameters:

resourceFactory - is the resourceFactory 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

getEntryUri

protected String getEntryUri(DataResource resource,
                             SearchIndexerDataLocation location,
                             DataResource locationResource)

This method determines the entry URI for the given resourceUri.

Parameters:

resource - is the DataResource for which the URI is requested.

location - is the SearchIndexerDataLocation used to check SearchIndexerDataLocation.isAbsoluteUris().

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

Returns:

the URI for the resource to index.

getStringProperty

protected String getStringProperty(GenericContext context,
                                   String key)

This method gets the property key from the given properties. It will also trim the properties value.

Parameters:

context - is where to get the property from.

key - is the name of the requested property.

Returns:

the trimmed property or null if the property is NOT set or its trimmed value is the empty string.

index

public 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 ResourceSearchIndexer.index(SearchIndexer, DataResource, ChangeType, SearchIndexerDataLocation, EntryUpdateVisitor, DataResource) to avoid performance-overhead.

Specified by:

index in interface ResourceSearchIndexer

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

public 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 ResourceSearchIndexer.index(SearchIndexer, DataResource, ChangeType, SearchIndexerDataLocation, EntryUpdateVisitor, DataResource) to avoid performance-overhead.

Specified by:

index in interface ResourceSearchIndexer

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

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

This method indexes a single DataResource.

Specified by:

index in interface ResourceSearchIndexer

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().