net.sf.mmm.search.indexer.api.config

Interface SearchIndexerSource

All Superinterfaces:

AttributeReadId<String>, SearchSource

All Known Implementing Classes:

SearchIndexerSourceBean

public interface SearchIndexerSource
extends SearchSource

This is the interface extends SearchSource with configuration required for the search-indexer.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static String	UPDATE_STRATEGY_LAST_MODIFIED The update-type for delta-updating via date/time of the last modification of the resources to index.
static String	UPDATE_STRATEGY_NONE The update-type for no incremental updates.
static String	UPDATE_STRATEGY_VCS The update-type for delta-updating using a version-control-system (VCS).

Fields inherited from interface net.sf.mmm.search.api.config.SearchSource

ID_ANY

Method Summary

Modifier and Type	Method and Description
List<? extends SearchIndexerDataLocation>	getLocations() This method gets the List of directories.
String	getUpdateStrategy() This method gets the identifier of the strategy used for (incremental) updates of this SearchSource.

Methods inherited from interface net.sf.mmm.search.api.config.SearchSource

getId, getTitle, getUrlPrefix

Field Detail

UPDATE_STRATEGY_NONE

static final String UPDATE_STRATEGY_NONE

The update-type for no incremental updates. In this case all entries for this source will always be removed and everything is re-indexed from scratch.

See Also:

Constant Field Values

UPDATE_STRATEGY_LAST_MODIFIED

static final String UPDATE_STRATEGY_LAST_MODIFIED

The update-type for delta-updating via date/time of the last modification of the resources to index.

See Also:

DataResource.isModifiedSince(java.util.Date), Constant Field Values

UPDATE_STRATEGY_VCS

static final String UPDATE_STRATEGY_VCS

The update-type for delta-updating using a version-control-system (VCS).
In case of a VCS, the location(s) should be a local working copy of a checked out VCS-repository. This initial checkout has to be done once outside of the search-indexer in advance. This is done by intention because you potentially have to deal with verification of certificates (e.g. for SSL in https) and provide authentication credentials. You can still use a wrapper shell script for further automation.
ATTENTION:
Using a VCS as update-strategy requires that the locations for this source are dedicated to the search-indexer and do not get updated form outside of the search-indexer. The indexer will save the revision (or date of update) of the working copy and can thereby detect if this is the initial indexing or a delta-update should be performed. It may also detect if the working copy was updated externally and a delta-update is NOT possible. If you can not guarantee dedication of the locations, simply use UPDATE_STRATEGY_LAST_MODIFIED instead and perform VCS updates in a wrapper script. See SearchIndexDataLocation.getUpdateStrategyVariant() for further details.

See Also:

Constant Field Values

Method Detail

getUpdateStrategy

String getUpdateStrategy()

This method gets the identifier of the strategy used for (incremental) updates of this SearchSource. This property is of interest for the search-indexer and can be ignored for the search-engine (due to the lack of full generic support in JAXB we decided NOT to move this method to a sub-interface in the search-indexer-api).
The default update-type is UPDATE_STRATEGY_LAST_MODIFIED that should work for all locations/resources that have a modification date. Besides UPDATE_STRATEGY_NONE there is also UPDATE_STRATEGY_VCS available.

Returns:

the type of the update mechanism or null if no delta-update-indexing shall be performed. Use one of the UPDATE_TYPE_* constants. The default implementation uses maven-scm as abstraction layer on VCS. In such case this is the role-hint for the scm-provider.

See Also:

UPDATE_STRATEGY_LAST_MODIFIED, UPDATE_STRATEGY_VCS, UPDATE_STRATEGY_NONE

getLocations

List<? extends SearchIndexerDataLocation> getLocations()

This method gets the List of directories.

Returns:

the List of SearchIndexerDataLocation.