/*
    * Copyright (c) 2002-2018, Mairie de Paris
    * All rights reserved.
    *
    * Redistribution and use in source and binary forms, with or without
    * modification, are permitted provided that the following conditions
    * are met:
    *
    *  1. Redistributions of source code must retain the above copyright notice
   *     and the following disclaimer.
   *
   *  2. Redistributions in binary form must reproduce the above copyright notice
   *     and the following disclaimer in the documentation and/or other materials
   *     provided with the distribution.
   *
   *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
   *     contributors may be used to endorse or promote products derived from
   *     this software without specific prior written permission.
   *
   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   * POSSIBILITY OF SUCH DAMAGE.
   *
   * License 1.0
   */
  package fr.paris.lutece.plugins.directory.modules.multiview.web.record.filter.display.impl;
  
  import java.util.LinkedHashMap;
  import java.util.Map;
  
  import javax.servlet.http.HttpServletRequest;
  
  import org.apache.commons.lang3.StringUtils;
  
  import fr.paris.lutece.plugins.directory.modules.multiview.business.record.RecordParameters;
  import fr.paris.lutece.plugins.directory.modules.multiview.business.record.filter.IRecordFilter;
  import fr.paris.lutece.plugins.directory.modules.multiview.web.record.filter.display.IRecordFilterDisplay;
  import fr.paris.lutece.portal.service.template.AppTemplateService;
  import fr.paris.lutece.util.ReferenceList;
  import fr.paris.lutece.util.html.HtmlTemplate;
  
  /**
   * Abstract class for the RecordFilterDisplay objects
   */
  public abstract class AbstractRecordFilterDisplay implements IRecordFilterDisplay
  {
      // Template
      protected static final String FILTER_TEMPLATE_NAME = "admin/plugins/directory/modules/multiview/record_filter.html";
  
      // Marks
      protected static final String MARK_FILTER_LIST = "filter_list";
      protected static final String MARK_FILTER_NAME = "filter_name";
      protected static final String MARK_FILTER_LIST_VALUE = "filter_list_value";
  
      // Constants
      private static final String DEFAULT_RECORD_FILTER_LABEL = "-";
  
      // Variables
      private int _nPosition;
      private String _strValue = StringUtils.EMPTY;
      private String _strTemplate = StringUtils.EMPTY;
      private IRecordFilter _recordFilter;
  
      /**
       * {@inheritDoc}
       */
      @Override
      public String getValue( )
      {
          return _strValue;
      }
  
      /**
       * Set the value for the RecordFilterDisplay
       * 
       * @param strValue
       *            The value to set to the RecordFilterDisplay
       */
      protected void setValue( String strValue )
      {
          _strValue = strValue;
      }
  
      /**
       * {@inheritDoc}
       */
      @Override
      public int getPosition( )
      {
          return _nPosition;
      }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void setPosition( int nPosition )
     {
         _nPosition = nPosition;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String getTemplate( )
     {
         return _strTemplate;
     }
 
     /**
      * Set the template
      * 
      * @param strTemplate
      *            The template to setto the filter
      */
     protected void setTemplate( String strTemplate )
     {
         _strTemplate = strTemplate;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public IRecordFilter getRecordFilter( )
     {
         return _recordFilter;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void setRecordFilter( IRecordFilter recordFilter )
     {
         _recordFilter = recordFilter;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public abstract void buildTemplate( HttpServletRequest request );
 
     /**
      * Get the map of all parameter names and values used by the filter
      * 
      * @param request
      *            The request used to retrieve the informations of the filter
      * @return the map which contains all the parameter names and values of the filter
      */
     protected abstract Map<String, Object> getFilterDisplayMapValues( HttpServletRequest request );
 
     /**
      * {@inheritDoc}
      */
     @Override
     public RecordParameters createRecordParameters( HttpServletRequest request )
     {
         RecordParameters recordParameters = null;
 
         if ( _recordFilter != null )
         {
             recordParameters = new RecordParameters( );
 
             Map<String, Object> mapKeyNameValues = getFilterDisplayMapValues( request );
             recordParameters.setRecordParametersMap( mapKeyNameValues );
 
             _recordFilter.setRecordParameters( recordParameters );
         }
 
         return recordParameters;
     }
 
     /**
      * Build the filter template with the given list for the specified parameter and set it to the filter
      * 
      * @param request
      *            The HttpServletRequest to use for building the template
      * @param referenceList
      *            The ReferenceList to use to populate the filter template
      * @param strParameterName
      *            The name of the parameter to attached the value of the ReferenceList
      */
     protected void manageFilterTemplate( HttpServletRequest request, ReferenceList referenceList, String strParameterName )
     {
         String strTemplateResult = StringUtils.EMPTY;
 
         Map<String, Object> model = new LinkedHashMap<>( );
         model.put( MARK_FILTER_LIST, referenceList );
         model.put( MARK_FILTER_LIST_VALUE, getValue( ) );
         model.put( MARK_FILTER_NAME, strParameterName );
 
         HtmlTemplate htmlTemplate = AppTemplateService.getTemplate( FILTER_TEMPLATE_NAME, request.getLocale( ), model );
         if ( htmlTemplate != null )
         {
             strTemplateResult = htmlTemplate.getHtml( );
         }
 
         setTemplate( strTemplateResult );
     }
 
     /**
      * Return the label of the RecordFilter from its configuration
      * 
      * @return the label of the RecordFilter from its configuration or the default label if not found
      */
     protected String getRecordFilterDisplayLabel( )
     {
         String strRecordFilterDisplayLabel = DEFAULT_RECORD_FILTER_LABEL;
 
         IRecordFilter recordFilter = getRecordFilter( );
         if ( recordFilter != null && recordFilter.getRecordFilterConfiguration( ) != null )
         {
             strRecordFilterDisplayLabel = recordFilter.getRecordFilterConfiguration( ).getRecordFilterLabel( );
         }
 
         return strRecordFilterDisplayLabel;
     }
 }