net.sf.mmm.search.view.base

Class AbstractSearchServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

net.sf.mmm.search.view.base.AbstractSearchServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, SearchViewConfiguration, SearchViewLogic, Refreshable

Direct Known Subclasses:

GenericSearchServlet

public abstract class AbstractSearchServlet
extends javax.servlet.http.HttpServlet
implements SearchViewLogic, SearchViewConfiguration

This is the abstract base implementation of the controller servlet of the search.
ATTENTION:
Please set URIEncoding="UTF-8" or better useBodyEncodingForURI="true" for the connector in the server.xml of your tomcat.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private String	bundleName
private SearchEngineConfigurationHolder	configurationHolder
private SearchEngineConfigurationLoader	configurationReader
private String	configurationUri
private String	detailsPath The name of the view (URL segment) for the details.
private Collection<? extends SearchEntryTypeView>	entryTypeViews
private String	errorPath The name of the view (JSP without ".jsp") for the error page or null to dispatch to the current view even in case of an error.
private Map<String,SearchEntryTypeViewBean>	id2viewMap
private Iso8601Util	iso8601Util
private String	lastRefreshDate
private org.slf4j.Logger	logger The Logger.
private NlsLocalizer	nlsLocalizer
private ManagedSearchEngine	searchEngine
private String	searchPath The name of the view (URL segment) for the actual search.
private static long	serialVersionUID The UID for serialization.
private Collection<SearchSourceViewBean>	sourceViews
private XmlUtil	xmlUtil

Fields inherited from interface net.sf.mmm.search.view.api.SearchViewConfiguration

DEFAULT_BUNDLE_NAME, DEFAULT_DETAILS_PATH, DEFAULT_SEARCH_PATH, PARAMETER_BUNDLE_NAME, PARAMETER_CONFIGURATION_URL, PARAMETER_DETAILS_PATH, PARAMETER_ERROR_PATH, PARAMETER_SEARCH_PATH

Constructor Summary

Constructors

Constructor and Description
AbstractSearchServlet() The constructor.

Method Summary

Modifier and Type	Method and Description
private void	appendFieldQuery(ComplexSearchQuery complexQuery, String field, String value) This method extends the given complexQuery with a query for the given property.
void	destroy()
protected void	doDispatch(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, boolean exception) This method dispatches the request to the according view (by default according JSP).
protected void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
String	getBundleName() This method gets the qualified name of the ResourceBundle used if texts for the UI from the configuration are specified in the from {<KEY>}.
SearchEngineConfiguration	getConfiguration() This method gets the SearchEngineConfiguration.
String	getDetailsPath() The servlet-path for the view of the details of a particular SearchHit.
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.
String	getErrorPath() This method get the name of the path to dispatch to in case of an error (e.g.
protected abstract IocContainer	getIocContainer() This method gets the IocContainer used to manage components with their implementation.
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.
protected org.slf4j.Logger	getLogger() This method gets the Logger.
NlsLocalizer	getNlsLocalizer() This method gets the NlsLocalizer used for localization of the UI.
private static String	getParameter(javax.servlet.ServletConfig config, String key, String defaultValue) This method gets an init-parameter.
ManagedSearchEngine	getSearchEngine() This method gets the ManagedSearchEngine.
String	getSearchPath() The servlet-path for the view of the actual search (enter query and show results).
Collection<SearchSourceViewBean>	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.
void	init(javax.servlet.ServletConfig config)
boolean	refresh() This method reloads the configuration and the SearchEngine on the fly.
private void	update() This method updates the internal state and views.
private void	updateEntryTypeViews() This method updates the entry type views.
private void	updateSourceViews() This method updates the entry type views.

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

private final org.slf4j.Logger logger

The Logger.

serialVersionUID

private static final long serialVersionUID

The UID for serialization.

See Also:

Constant Field Values

searchPath

private String searchPath

The name of the view (URL segment) for the actual search.

detailsPath

private String detailsPath

The name of the view (URL segment) for the details.

errorPath

private String errorPath

The name of the view (JSP without ".jsp") for the error page or null to dispatch to the current view even in case of an error.

configurationReader

private SearchEngineConfigurationLoader configurationReader

See Also:

refresh()

configurationUri

private String configurationUri

See Also:

init(ServletConfig)

configurationHolder

private SearchEngineConfigurationHolder configurationHolder

See Also:

getConfiguration()

searchEngine

private ManagedSearchEngine searchEngine

See Also:

getSearchEngine()

xmlUtil

private XmlUtil xmlUtil

See Also:

getXmlUtil()

iso8601Util

private Iso8601Util iso8601Util

See Also:

getIso8601Util()

entryTypeViews

private Collection<? extends SearchEntryTypeView> entryTypeViews

See Also:

getEntryTypeViews()

id2viewMap

private Map<String,SearchEntryTypeViewBean> id2viewMap

See Also:

updateEntryTypeViews()

sourceViews

private Collection<SearchSourceViewBean> sourceViews

See Also:

getSourceViews()

lastRefreshDate

private String lastRefreshDate

See Also:

getLastRefreshDate()

nlsLocalizer

private NlsLocalizer nlsLocalizer

See Also:

getNlsLocalizer()

bundleName

private String bundleName

See Also:

getBundleName()

Constructor Detail

AbstractSearchServlet

public AbstractSearchServlet()

The constructor.

Method Detail

getLogger

protected org.slf4j.Logger getLogger()

This method gets the Logger.

Returns:

the Logger.

getSearchEngine

public ManagedSearchEngine getSearchEngine()

This method gets the ManagedSearchEngine.

Specified by:

getSearchEngine in interface SearchViewLogic

Returns:

the ManagedSearchEngine.

getConfiguration

public SearchEngineConfiguration getConfiguration()

This method gets the SearchEngineConfiguration.

Specified by:

getConfiguration in interface SearchViewLogic

Returns:

the SearchEngineConfiguration.

See Also:

SearchViewLogic.getEntryTypeViews(), SearchViewLogic.getEntryType(String), SearchViewLogic.getSourceViews()

getXmlUtil

public XmlUtil getXmlUtil()

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

Specified by:

getXmlUtil in interface SearchViewLogic

Returns:

the XmlUtil.

getIso8601Util

public Iso8601Util getIso8601Util()

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

Specified by:

getIso8601Util in interface SearchViewLogic

Returns:

the Iso8601Util.

getLastRefreshDate

public String getLastRefreshDate()

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

Specified by:

getLastRefreshDate in interface SearchViewLogic

Returns:

the last refresh date.

getSearchPath

public String getSearchPath()

The servlet-path for the view of the actual search (enter query and show results).

Specified by:

getSearchPath in interface SearchViewConfiguration

Returns:

the search path.

See Also:

SearchViewConfiguration.DEFAULT_SEARCH_PATH

getDetailsPath

public String getDetailsPath()

The servlet-path for the view of the details of a particular SearchHit.

Specified by:

getDetailsPath in interface SearchViewConfiguration

Returns:

the search path.

See Also:

SearchViewConfiguration.DEFAULT_DETAILS_PATH

getErrorPath

public String getErrorPath()

This method get the name of the path to dispatch to in case of an error (e.g. "error.jsp") or null to dispatch to the current view even in case of an error.

Specified by:

getErrorPath in interface SearchViewConfiguration

Returns:

the error view.

getEntryTypeViews

public Collection<? extends SearchEntryTypeView> getEntryTypeViews()

This method gets the list of SearchEntryTypeViews sorted by title.

Specified by:

getEntryTypeViews in interface SearchViewLogic

Returns:

the SearchEntryTypeViews.

getSourceViews

public Collection<SearchSourceViewBean> getSourceViews()

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

Specified by:

getSourceViews in interface SearchViewLogic

Returns:

the sources.

getNlsLocalizer

public NlsLocalizer getNlsLocalizer()

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

Specified by:

getNlsLocalizer in interface SearchViewLogic

Returns:

the NlsLocalizer.

getBundleName

public String getBundleName()

This method gets the qualified name of the ResourceBundle used if texts for the UI from the configuration are specified in the from {<KEY>}.

Specified by:

getBundleName in interface SearchViewConfiguration

Returns:

the bundle-name.

See Also:

NlsTemplateImpl.getName()

getEntryType

public SearchEntryType getEntryType(String id)

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

Specified by:

getEntryType in interface SearchViewLogic

Parameters:

id - is the ID of the requested SearchEntryType.

Returns:

the requested SearchEntryType.

getIocContainer

protected abstract IocContainer getIocContainer()

This method gets the IocContainer used to manage components with their implementation. The IocContainer will be created and initialized on the first call of this method.

Returns:

the IocContainer.

getParameter

private static String getParameter(javax.servlet.ServletConfig config,
                                   String key,
                                   String defaultValue)

This method gets an init-parameter.

Parameters:

config - is the ServletConfig.

key - is the name of the requested parameter.

defaultValue - the default value returned if the actual parameter is NOT set (null). May also be null.

Returns:

the requested parameter or defaultValue if NOT set.

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet

appendFieldQuery

private void appendFieldQuery(ComplexSearchQuery complexQuery,
                              String field,
                              String value)

This method extends the given complexQuery with a query for the given property.

Parameters:

complexQuery - is the existing query to extend.

field - is the name of the field to add to the query.

value - is the value to search in the given property.

doDispatch

protected void doDispatch(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response,
                          boolean exception)
                   throws javax.servlet.ServletException,
                          IOException

This method dispatches the request to the according view (by default according JSP).

Parameters:

request - is the HttpServletRequest.

response - is the HttpServletResponse.

exception - - true if an Exception occurred, false on success.

Throws:

javax.servlet.ServletException - if something goes wrong.

IOException - if something goes wrong.

doGet

protected void doGet(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws javax.servlet.ServletException,
                     IOException

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

updateSourceViews

private void updateSourceViews()

This method updates the entry type views.
The SearchEngineConfiguration defines the SearchEntryTypes. For this view these SearchEntryTypes are reduced to those types that actually exist in the search-index. Then they are combined and finally sorted according to the title.
This way the view can present the proper titles of the types and the search can filter even on combined types.

update

private void update()

This method updates the internal state and views.

updateEntryTypeViews

private void updateEntryTypeViews()

This method updates the entry type views.
The SearchEngineConfiguration defines the SearchEntryTypes. For this view these SearchEntryTypes are reduced to those types that actually exist in the search-index. Then they are combined and finally sorted according to the title.
This way the view can present the proper titles of the types and the search can filter even on combined types.

refresh

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

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

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

Specified by:

getDisplayTitle in interface SearchViewLogic

Parameters:

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

Returns:

the display title of the SearchEntry.