net.sf.mmm.search.view.api

Interface SearchViewLogic

All Superinterfaces:

Refreshable

All Known Implementing Classes:

AbstractSearchServlet, GenericSearchServlet

public interface SearchViewLogic
extends Refreshable

This is the interface to access components and logic of the search.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
SearchEngineConfiguration	getConfiguration() This method gets the SearchEngineConfiguration.
String	getDisplayTitle(SearchEntry searchEntry) This method get the display-title from the given searchEntry.
SearchEntryType	getEntryType(String id) This method gets the SearchEntryTypeView or SearchEntryType for the given id .
Collection<? extends SearchEntryTypeView>	getEntryTypeViews() This method gets the list of SearchEntryTypeViews sorted by title.
Iso8601Util	getIso8601Util() This method gets the Iso8601Util that can be used to format and parse dates.
String	getLastRefreshDate() This method gets the date of the last refresh as String.
NlsLocalizer	getNlsLocalizer() This method gets the NlsLocalizer used for localization of the UI.
ManagedSearchEngine	getSearchEngine() This method gets the ManagedSearchEngine.
Collection<? extends SearchSourceView>	getSourceViews() This method gets the list of views on the SearchSourceViews sorted by title.
XmlUtil	getXmlUtil() This method gets the XmlUtil that can be used for escaping to prevent from XSS-attacks.
boolean	refresh() This method reloads the configuration and the SearchEngine on the fly.

Method Detail

getConfiguration

SearchEngineConfiguration getConfiguration()

This method gets the SearchEngineConfiguration.

Returns:

the SearchEngineConfiguration.

See Also:

getEntryTypeViews(), getEntryType(String), getSourceViews()

getEntryTypeViews

Collection<? extends SearchEntryTypeView> getEntryTypeViews()

This method gets the list of SearchEntryTypeViews sorted by title.

Returns:

the SearchEntryTypeViews.

getSourceViews

Collection<? extends SearchSourceView> getSourceViews()

This method gets the list of views on the SearchSourceViews sorted by title.

Returns:

the sources.

getEntryType

SearchEntryType getEntryType(String id)

This method gets the SearchEntryTypeView or SearchEntryType for the given id .

Parameters:

id - is the ID of the requested SearchEntryType.

Returns:

the requested SearchEntryType.

getSearchEngine

ManagedSearchEngine getSearchEngine()

This method gets the ManagedSearchEngine.

Returns:

the ManagedSearchEngine.

getXmlUtil

XmlUtil getXmlUtil()

This method gets the XmlUtil that can be used for escaping to prevent from XSS-attacks.

Returns:

the XmlUtil.

getIso8601Util

Iso8601Util getIso8601Util()

This method gets the Iso8601Util that can be used to format and parse dates.

Returns:

the Iso8601Util.

getNlsLocalizer

NlsLocalizer getNlsLocalizer()

This method gets the NlsLocalizer used for localization of the UI.

Returns:

the NlsLocalizer.

getLastRefreshDate

String getLastRefreshDate()

This method gets the date of the last refresh as String.

Returns:

the last refresh date.

refresh

boolean refresh()

This method reloads the configuration and the SearchEngine on the fly.
ATTENTION:
The search-engine will not be rebuild on reload so configuration-changes only reflect the view and NOT the search-engine. This method refreshes the given object. This can be anything from reloading configuration to rebuilding the internal state. An invocation of this method may be expensive and should only be invoked as needed. The implementation of this method should be thread-safe if the object itself is to be used by separate consumers at all.

Specified by:

refresh in interface Refreshable

Returns:

true if something has changed, false otherwise. If the implementation can not determine the change it should return true.

getDisplayTitle

String getDisplayTitle(SearchEntry searchEntry)

This method get the display-title from the given searchEntry. In advance to SearchEntry.getTitle() this method will create a combination of filename and the actual title and handle null values.

Parameters:

searchEntry - is the SearchEntry where to get the title from.

Returns:

the display title of the SearchEntry.