net.sf.mmm.search.api.config

Interface SearchSource

All Superinterfaces:

AttributeReadId<String>

All Known Subinterfaces:

SearchIndexerSource, SearchSourceView

All Known Implementing Classes:

SearchIndexerSourceBean, SearchSourceBean, SearchSourceViewBean

public interface SearchSource
extends AttributeReadId<String>

This is the interface for the configuration of a source of information for the search-engine (e.g. some VCS-instance, a wiki or some website).

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

getId()

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID_ANY The ID of the SearchSource that represents any source.

Method Summary

Modifier and Type	Method and Description
String	getId() This method gets the ID of this source.
String	getTitle() This method gets the display-name of this source.
String	getUrlPrefix() This method gets the prefix for the URL pointing to the content of a SearchEntry.

Field Detail

ID_ANY

static final String ID_ANY

The ID of the SearchSource that represents any source. In a search it can be used as wildcard to match all sources.

See Also:

Constant Field Values

Method Detail

getId

String getId()

This method gets the ID of this source. The ID should be a short, technical and unique name that identifies the source within your list of sources (e.g. "SVN", "Wiki", "MyDocuments", "apache.org"). This ID will be added to the search-index for each according entry. A SearchQuery can be restricted to specific sources via their IDs.

Specified by:

getId in interface AttributeReadId<String>

Returns:

the ID of this source.

See Also:

SearchEntry.getSource()

getTitle

String getTitle()

This method gets the display-name of this source. This title can be displayed to end-users in the application where a SearchQuery is performed so the user can restrict his search to specific sources.
For localization see net.sf.mmm.util.nls.api.

Returns:

the title of this source.

getUrlPrefix

String getUrlPrefix()

This method gets the prefix for the URL pointing to the content of a SearchEntry. The URL that links to this content is build by appending the URI of the SearchEntry to this prefix.
Typical examples are "http://foo.org/svn/trunk" or "http://foo.org/wiki/".

Returns:

the URL-prefix of this source.