View Javadoc
1   /*
2    * Copyright (c) 2002-2018, Mairie de Paris
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met:
8    *
9    *  1. Redistributions of source code must retain the above copyright notice
10   *     and the following disclaimer.
11   *
12   *  2. Redistributions in binary form must reproduce the above copyright notice
13   *     and the following disclaimer in the documentation and/or other materials
14   *     provided with the distribution.
15   *
16   *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17   *     contributors may be used to endorse or promote products derived from
18   *     this software without specific prior written permission.
19   *
20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30   * POSSIBILITY OF SUCH DAMAGE.
31   *
32   * License 1.0
33   */
34  package fr.paris.lutece.plugins.directory.modules.multiview.business.record.filter.querypart.impl;
35  
36  import java.util.Map;
37  import java.util.Set;
38  
39  import org.apache.commons.lang3.StringUtils;
40  import org.apache.commons.lang3.math.NumberUtils;
41  
42  import fr.paris.lutece.plugins.directory.modules.multiview.business.record.RecordParameters;
43  import fr.paris.lutece.plugins.directory.modules.multiview.business.record.filter.RecordFilterQueryBuilder;
44  import fr.paris.lutece.plugins.directory.modules.multiview.util.RecordEntryNameConstants;
45  
46  /**
47   * Implementation of the IRecordFilterQueryPart for an Entry filter
48   */
49  public class RecordFilterEntryQueryPart extends AbstractRecordFilterQueryPart
50  {
51      // Constants
52      private static final int DEFAULT_POSITION = NumberUtils.INTEGER_MINUS_ONE;
53      private static final String ENTRY_VALUE_QUERY_PATTERN = "column_%1$s.column_%1$s_value = ";
54      private static final String ENTRY_VALUE_NAME_PATTERN = "$column_%s$";
55  
56      /**
57       * {@inheritDoc}
58       */
59      @Override
60      public void buildRecordFilterQuery( RecordParameters recordParameters )
61      {
62          int nPosition = DEFAULT_POSITION;
63  
64          if ( recordParameters != null )
65          {
66              Map<String, Object> mapRecordParametersNameValues = recordParameters.getRecordParametersMap( );
67              if ( mapRecordParametersNameValues != null && !mapRecordParametersNameValues.isEmpty( ) )
68              {
69                  nPosition = findFilterColumnPosition( mapRecordParametersNameValues );
70              }
71          }
72  
73          StringBuilder stringBuilderEntryQueryPattern = new StringBuilder( );
74          if ( nPosition != DEFAULT_POSITION )
75          {
76              String strEntryValueQueryPattern = String.format( ENTRY_VALUE_QUERY_PATTERN, nPosition );
77              String strEntryNamePattern = String.format( ENTRY_VALUE_NAME_PATTERN, nPosition );
78  
79              stringBuilderEntryQueryPattern.append( strEntryValueQueryPattern );
80              stringBuilderEntryQueryPattern.append( strEntryNamePattern );
81          }
82  
83          setRecordFilterQuery( RecordFilterQueryBuilder.buildRecordFilterQuery( stringBuilderEntryQueryPattern.toString( ), recordParameters ) );
84      }
85  
86      /**
87       * Find the position of the column for the filter from the given values
88       * 
89       * @param mapRecordParametersNameValues
90       *            The map used to retrieve the position of the column of the filter
91       * @return the position of the column for the filter from the given values or the {@link DEFAULT_POSITION} if not found
92       */
93      private int findFilterColumnPosition( Map<String, Object> mapRecordParametersNameValues )
94      {
95          int nPosition = DEFAULT_POSITION;
96  
97          Set<String> setParameterName = mapRecordParametersNameValues.keySet( );
98          for ( String strParameterName : setParameterName )
99          {
100             if ( strParameterName.startsWith( RecordEntryNameConstants.FILTER_ENTRY_BASE_NAME_PATTERN ) )
101             {
102                 String strColumnNumber = strParameterName.replaceFirst( RecordEntryNameConstants.FILTER_ENTRY_BASE_NAME_PATTERN, StringUtils.EMPTY );
103                 nPosition = NumberUtils.toInt( strColumnNumber, NumberUtils.INTEGER_MINUS_ONE );
104                 break;
105             }
106         }
107 
108         return nPosition;
109     }
110 }