content: /*
   * This library is part of OpenCms -
   * the Open Source Content Management System
   *
   * Copyright (c) Alkacon Software GmbH & Co. KG (https://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: https://www.alkacon.com
   *
   * For further information about OpenCms, please see the
   * project website: https://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.file.CmsObject;
  import org.opencms.jsp.search.config.I_CmsSearchConfigurationFacetRange;
  import org.opencms.jsp.search.state.CmsSearchStateFacet;
  import org.opencms.jsp.search.state.I_CmsSearchStateFacet;
  import org.opencms.search.solr.CmsSolrQuery;
  
  import java.util.Iterator;
  import java.util.Map;
  
  /** Search controller for the field facet options. */
  public class CmsSearchControllerFacetRange implements I_CmsSearchControllerFacetRange {
  
      /** Configuration of the field facet options. */
      private final I_CmsSearchConfigurationFacetRange m_config;
      /** State of the field facets. */
      private final I_CmsSearchStateFacet m_state;
  
      /** Constructor taking the managed configuration.
       * @param config The configuration to manage by the controller.
       */
      public CmsSearchControllerFacetRange(final I_CmsSearchConfigurationFacetRange config) {
  
          m_config = config;
          m_state = new CmsSearchStateFacet();
      }
  
      /**
       * @see org.opencms.jsp.search.controller.I_CmsSearchController#addParametersForCurrentState(java.util.Map)
       */
      @Override
      public void addParametersForCurrentState(final Map<String, String[]> parameters) {
  
          if (!m_state.getCheckedEntries().isEmpty()) {
              parameters.put(
                  m_config.getParamKey(),
                  m_state.getCheckedEntries().toArray(new String[m_state.getCheckedEntries().size()]));
          }
          if (m_state.getIgnoreChecked()) {
              parameters.put(m_config.getIgnoreMaxParamKey(), null);
          }
  
      }
  
      /**
       * @see org.opencms.jsp.search.controller.I_CmsSearchController#addQueryParts(CmsSolrQuery, CmsObject)
       */
      @Override
      public void addQueryParts(CmsSolrQuery query, CmsObject cms) {
  
          addFacetPart(query);
          addFilterQueryParts(query);
      }
  
      /**
       * @see org.opencms.jsp.search.controller.I_CmsSearchControllerFacetRange#getConfig()
       */
      @Override
      public I_CmsSearchConfigurationFacetRange getConfig() {
  
          return m_config;
      }
  
      /**
       * @see org.opencms.jsp.search.controller.I_CmsSearchControllerFacetRange#getState()
       */
      @Override
      public I_CmsSearchStateFacet getState() {
  
          return m_state;
      }
  
      /**
       * @see org.opencms.jsp.search.controller.I_CmsSearchController#updateForQueryChange()
       */
      @Override
      public void updateForQueryChange() {
  
          m_state.setIgnoreChecked(true);
  
      }
  
      /**
       * @see org.opencms.jsp.search.controller.I_CmsSearchController#updateFromRequestParameters(java.util.Map, boolean)
       */
      @Override
      public void updateFromRequestParameters(final Map<String, String[]> parameters, boolean isReloaded) {
  
          m_state.setUseLimit(!parameters.containsKey(m_config.getIgnoreMaxParamKey()));
  
          if (isReloaded) {
              // update checked fields
              m_state.clearChecked();
              if (!m_state.getIgnoreChecked() && parameters.containsKey(m_config.getParamKey())) {
                  final String[] checked = parameters.get(m_config.getParamKey());
                  for (int i = 0; i < checked.length; i++) {
                      String checkedEntry = checked[i];
                      if ((null != checkedEntry) && !checkedEntry.isEmpty()) {
                          m_state.addChecked(checkedEntry);
                      }
                  }
  
              }
          } else { // use the preselection on first load
              for (String checked : m_config.getPreSelection()) {
                  m_state.addChecked(checked);
              }
          }
      }
  
      /** Adds the query parts for the facet options, except the filter parts.
       * @param query The query part that is extended with the facet options.
       */
      protected void addFacetOptions(StringBuffer query) {
  
          // start
          appendFacetOption(query, "range.start", m_config.getStart());
          // end
          appendFacetOption(query, "range.end", m_config.getEnd());
          // gap
          appendFacetOption(query, "range.gap", m_config.getGap());
          // method
          if (m_config.getMethod() != null) {
              appendFacetOption(query, "range.method", m_config.getMethod().toString());
          }
          // other
          for (I_CmsSearchConfigurationFacetRange.Other o : m_config.getOther()) {
              appendFacetOption(query, "range.other", o.toString());
          }
          // hardend
          appendFacetOption(query, "range.hardend", Boolean.toString(m_config.getHardEnd()));
          // mincount
          if (m_config.getMinCount() != null) {
              appendFacetOption(query, "mincount", m_config.getMinCount().toString());
          }
      }
  
      /** Generate query part for the facet, without filters.
       * @param query The query, where the facet part should be added
       */
      protected void addFacetPart(CmsSolrQuery query) {
  
          StringBuffer value = new StringBuffer();
          value.append("{!key=").append(m_config.getName());
          addFacetOptions(value);
          if (!m_config.getIgnoreTags().isEmpty()) {
              value.append(" ex=").append(m_config.getIgnoreTags());
          }
          value.append("}");
          value.append(m_config.getRange());
          query.add("facet.range", value.toString());
      }
  
      /** Adds filter parts to the query.
       * @param query The query.
       */
      protected void addFilterQueryParts(CmsSolrQuery query) {
  
          if (!m_state.getCheckedEntries().isEmpty()) {
              StringBuffer value = new StringBuffer();
              value.append("{!tag=").append(m_config.getName()).append('}');
              value.append(m_config.getRange());
              value.append(":(");
              final Iterator<String> fieldIterator = m_state.getCheckedEntries().iterator();
              value.append(generateRange(fieldIterator.next()));
              final String concater = m_config.getIsAndFacet() ? " AND " : " OR ";
              while (fieldIterator.hasNext()) {
                  value.append(concater);
                  value.append(generateRange(fieldIterator.next()));
              }
              if (m_config.getHardEnd()) {
                  value.append(concater);
                  value.append("[" + m_config.getStart() + " TO " + m_config.getEnd() + "}");
              }
              value.append(')');
              query.add("fq", value.toString());
          }
      }
  
      /** Appends the query part for the facet to the query string.
       * @param query The current query string.
       * @param name The name of the facet parameter, e.g. "limit", "order", ....
       * @param value The value to set for the parameter specified by name.
       */
      protected void appendFacetOption(StringBuffer query, final String name, final String value) {
  
          query.append(" facet.").append(name).append("=").append(value);
      }
  
      /**
       * Generates the range for the filter query with a given start value.
       * @param startValue the facet item's value (start value of the range)
       * @return the range as to put in the query
       */
      private Object generateRange(String startValue) {
  
          return "[" + startValue + " TO " + startValue + m_config.getGap() + "}";
      }
  
  }
  