org.opencms.jsp.search.controller.CmsSearchController Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of opencms-test Show documentation
Show all versions of opencms-test Show documentation
OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* For further information about Alkacon Software, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.jsp.search.controller;
import org.opencms.jsp.search.config.I_CmsSearchConfiguration;
import org.opencms.search.solr.CmsSolrQuery;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.Map;
/** The main controller that allows to access all single sub-controllers. */
public class CmsSearchController implements I_CmsSearchControllerMain {
/** List of all controllers. */
Collection m_controllers;
/** The controller for the common options. */
I_CmsSearchControllerCommon m_common;
/** The controller for the sort options. */
I_CmsSearchControllerSorting m_sorting;
/** The controller for the pagination options. */
I_CmsSearchControllerPagination m_pagination;
/** The controller for the field facets. */
I_CmsSearchControllerFacetsField m_fieldFacets;
/** The controller for the field facets. */
I_CmsSearchControllerFacetsRange m_rangeFacets;
/** The controller for the query facet. */
I_CmsSearchControllerFacetQuery m_queryFacet;
/** The controller for the highlighting. */
I_CmsSearchControllerHighlighting m_highlighting;
/** The controller for the "Did you mean ...?" feature. */
I_CmsSearchControllerDidYouMean m_didyoumean;
/** Constructor that sets up the controller with a given configuration.
* @param config The search configuration handled by the controller.
*/
public CmsSearchController(final I_CmsSearchConfiguration config) {
m_controllers = new ArrayList();
// create the separate controllers and add them to the list of
// controllers
m_common = new CmsSearchControllerCommon(config.getGeneralConfig());
m_controllers.add(m_common);
m_pagination = new CmsSearchControllerPagination(config.getPaginationConfig());
m_controllers.add(m_pagination);
m_sorting = new CmsSearchControllerSorting(config.getSortConfig());
m_controllers.add(m_sorting);
m_fieldFacets = new CmsSearchControllerFacetsField(config.getFieldFacetConfigs());
m_controllers.add(m_fieldFacets);
m_rangeFacets = new CmsSearchControllerFacetsRange(config.getRangeFacetConfigs());
m_controllers.add(m_rangeFacets);
if (config.getHighlighterConfig() != null) {
m_highlighting = new CmsSearchControllerHighlighting(config.getHighlighterConfig());
m_controllers.add(m_highlighting);
}
if (config.getDidYouMeanConfig() != null) {
m_didyoumean = new CmsSearchControllerDidYouMean(config.getDidYouMeanConfig());
m_controllers.add(m_didyoumean);
}
if (config.getQueryFacetConfig() != null) {
m_queryFacet = new CmsSearchControllerFacetQuery(config.getQueryFacetConfig());
m_controllers.add(m_queryFacet);
}
}
/**
* @see org.opencms.jsp.search.controller.I_CmsSearchController#addParametersForCurrentState(java.util.Map)
*/
@Override
public void addParametersForCurrentState(final Map parameters) {
for (final I_CmsSearchController controller : m_controllers) {
controller.addParametersForCurrentState(parameters);
}
}
/**
* @see org.opencms.jsp.search.controller.I_CmsSearchController#addQueryParts(CmsSolrQuery)
*/
@Override
public void addQueryParts(CmsSolrQuery query) {
final Iterator it = m_controllers.iterator();
it.next().addQueryParts(query);
while (it.hasNext()) {
it.next().addQueryParts(query);
}
// fix for highlighting bug
if ((getHighlighting() != null) && !((query.getParams("df") != null) || (query.getParams("type") != null))) {
String df = getHighlighting().getConfig().getHightlightField().trim();
int index = df.indexOf(' ');
query.add("df", (index > 0 ? df.substring(0, index) : df));
}
}
/**
* @see org.opencms.jsp.search.controller.I_CmsSearchControllerMain#getCommon()
*/
@Override
public I_CmsSearchControllerCommon getCommon() {
return m_common;
}
/**
* @see org.opencms.jsp.search.controller.I_CmsSearchControllerMain#getDidYouMean()
*/
public I_CmsSearchControllerDidYouMean getDidYouMean() {
return m_didyoumean;
}
/**
* @see org.opencms.jsp.search.controller.I_CmsSearchControllerMain#getFieldFacets()
*/
@Override
public I_CmsSearchControllerFacetsField getFieldFacets() {
return m_fieldFacets;
}
/**
* @see org.opencms.jsp.search.controller.I_CmsSearchControllerMain#getHighlighting()
*/
@Override
public I_CmsSearchControllerHighlighting getHighlighting() {
return m_highlighting;
}
/**
* @see org.opencms.jsp.search.controller.I_CmsSearchControllerMain#getPagination()
*/
@Override
public I_CmsSearchControllerPagination getPagination() {
return m_pagination;
}
/**
* @see org.opencms.jsp.search.controller.I_CmsSearchControllerMain#getQueryFacet()
*/
@Override
public I_CmsSearchControllerFacetQuery getQueryFacet() {
return m_queryFacet;
}
/**
* @see org.opencms.jsp.search.controller.I_CmsSearchControllerMain#getRangeFacets()
*/
public I_CmsSearchControllerFacetsRange getRangeFacets() {
return m_rangeFacets;
}
/**
* @see org.opencms.jsp.search.controller.I_CmsSearchControllerMain#getSorting()
*/
@Override
public I_CmsSearchControllerSorting getSorting() {
return m_sorting;
}
/**
* @see org.opencms.jsp.search.controller.I_CmsSearchController#updateForQueryChange()
*/
@Override
public void updateForQueryChange() {
for (final I_CmsSearchController controller : m_controllers) {
controller.updateForQueryChange();
}
}
/**
* @see org.opencms.jsp.search.controller.I_CmsSearchController#updateFromRequestParameters(java.util.Map, boolean)
*/
@Override
public void updateFromRequestParameters(final Map parameters, final boolean unused) {
// Check if query has changed
final String lastQueryParam = m_common.getConfig().getLastQueryParam();
final String queryParam = m_common.getConfig().getQueryParam();
final String firstCallParam = m_common.getConfig().getReloadedParam();
if (!m_common.getConfig().getIgnoreQueryParam()
&& parameters.containsKey(lastQueryParam)
&& parameters.containsKey(queryParam)
&& (parameters.get(lastQueryParam).length > 0)
&& (parameters.get(queryParam).length > 0)
&& !parameters.get(queryParam)[0].equals(parameters.get(lastQueryParam)[0])) {
updateForQueryChange();
}
boolean isReloaded = parameters.containsKey(firstCallParam);
for (final I_CmsSearchController controller : m_controllers) {
controller.updateFromRequestParameters(parameters, isReloaded);
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy