AutocompletePlaceholderFilterChain.java

/*
 * Copyright (c) 2002-2017, 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.gruindexing.web.elasticsearch.template;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;

/**
 * This class represents a chain to filter the placeholder map for the autocomplete query
 *
 */
public class AutocompletePlaceholderFilterChain
{
    private final List<IAutocompletePlaceholderFilter> _listAutocompletePlaceholderFilter;
    private int _nIndex;

    /**
     * Constructor
     */
    public AutocompletePlaceholderFilterChain( )
    {
        _listAutocompletePlaceholderFilter = new ArrayList<>( );
    }

    /**
     * Launches the chain to filter the specified map of placeholders
     * 
     * @param request
     *            the request containing the data to filter the map
     * @param mapPlaceholderValues
     *            the map of placeholders
     */
    public void doFilter( HttpServletRequest request, Map<String, String> mapPlaceholderValues )
    {
        if ( _nIndex < _listAutocompletePlaceholderFilter.size( ) )
        {
            IAutocompletePlaceholderFilter autocompletePlaceholderFilter = _listAutocompletePlaceholderFilter.get( _nIndex );
            _nIndex++;

            autocompletePlaceholderFilter.doFilter( request, mapPlaceholderValues, this );
        }
    }

    /**
     * Adds a filter in the chain
     * 
     * @param autocompletePlaceholderFilter
     *            the filter to add
     */
    public void addFilter( IAutocompletePlaceholderFilter autocompletePlaceholderFilter )
    {
        _listAutocompletePlaceholderFilter.add( autocompletePlaceholderFilter );
    }
}