net.sf.mmm.search.base.config

Class SearchSourceBean

java.lang.Object

net.sf.mmm.util.lang.base.attribute.AbstractAttributeReadId<String>

net.sf.mmm.search.base.config.SearchSourceBean

All Implemented Interfaces:

SearchSource, AttributeReadId<String>

Direct Known Subclasses:

SearchIndexerSourceBean, SearchSourceViewBean

public class SearchSourceBean
extends AbstractAttributeReadId<String>
implements SearchSource

This is the implementation of SearchSource as JAXB-ready Java-Bean.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private String	id
private String	title
private String	urlPrefix

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

ID_ANY

Constructor Summary

Constructors

Constructor and Description
SearchSourceBean() The constructor.
SearchSourceBean(SearchSource template) The copy constructor.

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.
void	setId(String id)
void	setTitle(String title)
void	setUrlPrefix(String urlPrefix)
String	toString()

Methods inherited from class net.sf.mmm.util.lang.base.attribute.AbstractAttributeReadId

equals, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

id

private String id

See Also:

getId()

title

private String title

See Also:

getTitle()

urlPrefix

private String urlPrefix

See Also:

getUrlPrefix()

Constructor Detail

SearchSourceBean

public SearchSourceBean()

The constructor.

SearchSourceBean

public SearchSourceBean(SearchSource template)

The copy constructor.

Parameters:

template - is the SearchSource to copy.

Method Detail

getId

public 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 SearchSource

Specified by:

getId in interface AttributeReadId<String>

Returns:

the ID of this source.

See Also:

SearchEntry.getSource()

getTitle

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

Specified by:

getTitle in interface SearchSource

Returns:

the title of this source.

getUrlPrefix

public 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/".

Specified by:

getUrlPrefix in interface SearchSource

Returns:

the URL-prefix of this source.

setId

public void setId(String id)

Parameters:

id - is the id to set

setTitle

public void setTitle(String title)

Parameters:

title - is the title to set

setUrlPrefix

public void setUrlPrefix(String urlPrefix)

Parameters:

urlPrefix - is the urlPrefix to set

toString

public String toString()

Overrides:

toString in class AbstractAttributeReadId<String>