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

Interface SearchIndexerDataLocation

All Known Implementing Classes:

SearchIndexerDataLocationBean

public interface SearchIndexerDataLocation

This is the interface for the configuration of a data-location that should be indexed by the indexer and is then available for search via the SearchEngine.

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_VCS_VARIANT_BAZAAR The variant of SearchIndexerSource.UPDATE_STRATEGY_VCS for Bazaar (bzr).
static String	UPDATE_STRATEGY_VCS_VARIANT_CVS The variant of SearchIndexerSource.UPDATE_STRATEGY_VCS for Concurrent Version System.
static String	UPDATE_STRATEGY_VCS_VARIANT_GIT The variant of SearchIndexerSource.UPDATE_STRATEGY_VCS for Git.
static String	UPDATE_STRATEGY_VCS_VARIANT_MERCURIAL The variant of SearchIndexerSource.UPDATE_STRATEGY_VCS for Mercurial (hg).
static String	UPDATE_STRATEGY_VCS_VARIANT_PERFORCE The variant of SearchIndexerSource.UPDATE_STRATEGY_VCS for Perforce (p4).
static String	UPDATE_STRATEGY_VCS_VARIANT_SVN The variant of SearchIndexerSource.UPDATE_STRATEGY_VCS for Subversion (svn).
static String	UPDATE_STRATEGY_VCS_VARIANT_TFS The variant of SearchIndexerSource.UPDATE_STRATEGY_VCS for Team Foundation Server.
static String	UPDATE_STRATEGY_VCS_VARIANT_VSS The variant of SearchIndexerSource.UPDATE_STRATEGY_VCS for Visual Source Safe.

Method Summary

Modifier and Type	Method and Description
String	getBaseUri() This method gets the base-URI used to build the search-entry-URI for the location itself.
String	getEncoding() This method gets the encoding of the resources in this location.
Filter<String>	getFilter() This method gets the Filter that decides which resource-URIs should be accepted for indexing.
String	getLocationUri() This method gets the location (typically an URL) with the data that should be part of the search index.
SearchIndexerSource	getSource() This method gets the Source associated with this directory.
String	getUpdateStrategyVariant() This method determines the optional variant of the update-strategy.
Transformer<String>	getUriTransformer() This method gets the Transformer used to convert the (relative) URI of a resource to the indexed URI.
boolean	isAbsoluteUris() This method determines if search-entry-URIs should be set to the absolute location.

Field Detail

UPDATE_STRATEGY_VCS_VARIANT_CVS

static final String UPDATE_STRATEGY_VCS_VARIANT_CVS

The variant of SearchIndexerSource.UPDATE_STRATEGY_VCS for Concurrent Version System.

See Also:

Constant Field Values

UPDATE_STRATEGY_VCS_VARIANT_SVN

static final String UPDATE_STRATEGY_VCS_VARIANT_SVN

The variant of SearchIndexerSource.UPDATE_STRATEGY_VCS for Subversion (svn).

See Also:

Constant Field Values

UPDATE_STRATEGY_VCS_VARIANT_GIT

static final String UPDATE_STRATEGY_VCS_VARIANT_GIT

The variant of SearchIndexerSource.UPDATE_STRATEGY_VCS for Git.

See Also:

Constant Field Values

UPDATE_STRATEGY_VCS_VARIANT_MERCURIAL

static final String UPDATE_STRATEGY_VCS_VARIANT_MERCURIAL

The variant of SearchIndexerSource.UPDATE_STRATEGY_VCS for Mercurial (hg).

See Also:

Constant Field Values

UPDATE_STRATEGY_VCS_VARIANT_BAZAAR

static final String UPDATE_STRATEGY_VCS_VARIANT_BAZAAR

The variant of SearchIndexerSource.UPDATE_STRATEGY_VCS for Bazaar (bzr).

See Also:

Constant Field Values

UPDATE_STRATEGY_VCS_VARIANT_PERFORCE

static final String UPDATE_STRATEGY_VCS_VARIANT_PERFORCE

The variant of SearchIndexerSource.UPDATE_STRATEGY_VCS for Perforce (p4).

See Also:

Constant Field Values

UPDATE_STRATEGY_VCS_VARIANT_VSS

static final String UPDATE_STRATEGY_VCS_VARIANT_VSS

The variant of SearchIndexerSource.UPDATE_STRATEGY_VCS for Visual Source Safe.

See Also:

Constant Field Values

UPDATE_STRATEGY_VCS_VARIANT_TFS

static final String UPDATE_STRATEGY_VCS_VARIANT_TFS

The variant of SearchIndexerSource.UPDATE_STRATEGY_VCS for Team Foundation Server.

See Also:

Constant Field Values

Method Detail

getLocationUri

String getLocationUri()

This method gets the location (typically an URL) with the data that should be part of the search index. This location will be indexed recursively according to the filter.

• File-URLs should point to a directory to index (e.g. "file:///data/documents")
• HTTP(S)-URLs should point to a web-site to index via a crawler.

Returns:

the URI to index.

getBaseUri

String getBaseUri()

This method gets the base-URI used to build the search-entry-URI for the location itself.
This will typically be the empty string. However if you want to index multiple locations of the same source you can use this attribute. E.g. when source is "svn" and you have one location that points to where you checked out "trunk/documents" of a subversion repository then the base-URI may be "documents". Analog you may also have another location with a base-URI of "development/code". Therefore SearchSource.getUrlPrefix() may be something like "http://svn.foo.bar/trunk/".

Returns:

the base-URI for this location. If the base-URI is NOT empty, it should end with a slash ("/").

isAbsoluteUris

boolean isAbsoluteUris()

This method determines if search-entry-URIs should be set to the absolute location. This can make sense if you want to index a web-site via an HTTP-location but also some related sites linked from there. In all other cases this should be false.

Returns:

true if the absolute URIs should be stored in the search-index, false if the URIs should be relative to location with respect to the base-URI.

See Also:

getBaseUri()

getSource

SearchIndexerSource getSource()

This method gets the Source associated with this directory.

Returns:

the SearchIndexerSource.

getEncoding

String getEncoding()

This method gets the encoding of the resources in this location. If the encoding is specified (e.g. via content formats as XML or HTML) that specific encoding is used. - otherwise the default encoding returned by this method is used. Therefore you should typically not choose an UTF encoding.

Returns:

the encoding used as fallback or null for automatic unicode detection.

getFilter

Filter<String> getFilter()

This method gets the Filter that decides which resource-URIs should be accepted for indexing.
ATTENTION:
This filter is applied to files AND folders. If a folder is NOT accepted then this entire folder is NOT crawled any further and therefore its children are NOT indexed. All files that are crawled and accepted will be added to the search-index.

Returns:

the Filter.

getUriTransformer

Transformer<String> getUriTransformer()

This method gets the Transformer used to convert the (relative) URI of a resource to the indexed URI. By default the transformer will keep the URI untouched. However the Transformer can rewrite the URI if it differs from the path to access the file online. E.g. the relevant files in the data directory of a twiki/foswiki installation have the extension .txt while their URLs do NOT contain this extension.

Returns:

the URI-Transformer.

getUpdateStrategyVariant

String getUpdateStrategyVariant()

This method determines the optional variant of the update-strategy.
E.g. if the update-strategy of the according SearchIndexerSource is SearchIndexerSource.UPDATE_STRATEGY_VCS, then this variant can determine the actual VCS to use (see UPDATE_STRATEGY_VCS_VARIANT_* constants like UPDATE_STRATEGY_VCS_VARIANT_SVN). However if not set ( null) the VCS will be auto detected (by looking for folders like .svn, .hg, .git, etc.)

Returns:

the variant for the update-strategy or null for default.