001/* 002 * This library is part of OpenCms - 003 * the Open Source Content Management System 004 * 005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com) 006 * 007 * This library is free software; you can redistribute it and/or 008 * modify it under the terms of the GNU Lesser General Public 009 * License as published by the Free Software Foundation; either 010 * version 2.1 of the License, or (at your option) any later version. 011 * 012 * This library is distributed in the hope that it will be useful, 013 * but WITHOUT ANY WARRANTY; without even the implied warranty of 014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 015 * Lesser General Public License for more details. 016 * 017 * For further information about Alkacon Software, please see the 018 * company website: http://www.alkacon.com 019 * 020 * For further information about OpenCms, please see the 021 * project website: http://www.opencms.org 022 * 023 * You should have received a copy of the GNU Lesser General Public 024 * License along with this library; if not, write to the Free Software 025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 026 */ 027 028package org.opencms.jsp.search.config.parser; 029 030import org.opencms.file.CmsObject; 031import org.opencms.jsp.search.config.I_CmsSearchConfigurationCommon; 032import org.opencms.jsp.search.config.I_CmsSearchConfigurationDidYouMean; 033import org.opencms.jsp.search.config.I_CmsSearchConfigurationFacetField; 034import org.opencms.jsp.search.config.I_CmsSearchConfigurationFacetQuery; 035import org.opencms.jsp.search.config.I_CmsSearchConfigurationFacetRange; 036import org.opencms.jsp.search.config.I_CmsSearchConfigurationGeoFilter; 037import org.opencms.jsp.search.config.I_CmsSearchConfigurationHighlighting; 038import org.opencms.jsp.search.config.I_CmsSearchConfigurationPagination; 039import org.opencms.jsp.search.config.I_CmsSearchConfigurationSorting; 040 041import java.util.Map; 042 043/** The interface that must be implemented by search (form) configuration parsers. */ 044public interface I_CmsSearchConfigurationParser { 045 046 /** Returns the common search configuration. 047 * @param cms the current context 048 * @return The common search configuration. 049 */ 050 I_CmsSearchConfigurationCommon parseCommon(CmsObject cms); 051 052 /** Returns the configuration for the "Did you mean ...?" feature. 053 * @return The configuration for the "Did you mean ...?" feature. 054 */ 055 I_CmsSearchConfigurationDidYouMean parseDidYouMean(); 056 057 /** Returns the configuration for the field facets. 058 * @return The configuration for the field facets. 059 */ 060 Map<String, I_CmsSearchConfigurationFacetField> parseFieldFacets(); 061 062 /** Returns the configuration for the Geo filter. 063 * @return The configuration for the Geo filter. 064 */ 065 I_CmsSearchConfigurationGeoFilter parseGeoFilter(); 066 067 /** Returns the configuration for the highlighting. 068 * @return The configuration for the highlighting. 069 */ 070 I_CmsSearchConfigurationHighlighting parseHighlighter(); 071 072 /** Returns the configuration for the pagination. 073 * @return The configuration for the pagination. 074 */ 075 I_CmsSearchConfigurationPagination parsePagination(); 076 077 /** Returns the configuration for the query facet. 078 * @return The configuration for the query facet. 079 */ 080 I_CmsSearchConfigurationFacetQuery parseQueryFacet(); 081 082 /** Returns the configuration for the range facets. 083 * @return The configuration for the range facets. 084 */ 085 Map<String, I_CmsSearchConfigurationFacetRange> parseRangeFacets(); 086 087 /** Returns the configuration for sorting. 088 * @return The configuration for sorting. 089 */ 090 I_CmsSearchConfigurationSorting parseSorting(); 091}