View Javadoc
1   /*
2    * Copyright (c) 2002-2022, City of 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.forms.business.form;
35  
36  import java.util.List;
37  
38  import fr.paris.lutece.plugins.forms.business.form.filter.querypart.IFormFilterLuceneQueryPart;
39  import fr.paris.lutece.plugins.forms.business.form.filter.querypart.IFormFilterQueryPart;
40  import fr.paris.lutece.plugins.forms.business.form.panel.initializer.querypart.IFormPanelInitializerLuceneQueryPart;
41  import fr.paris.lutece.plugins.forms.business.form.panel.initializer.querypart.IFormPanelInitializerQueryPart;
42  import org.apache.lucene.search.BooleanClause;
43  import org.apache.lucene.search.BooleanQuery;
44  import org.apache.lucene.search.Query;
45  
46  /**
47   * Class use to build a SQL query from part of query inside FormFilter and FormColumn
48   */
49  public final class LuceneQueryBuilder
50  {
51      /**
52       * Constructor
53       */
54      private LuceneQueryBuilder( )
55      {
56  
57      }
58  
59      /**
60       * Build a Lucene query from different parts from a list of FormColumn and a list of FormFilter
61       * 
62       * @param listFormPanelInitializerQueryPart
63       *            The list of all FormPanelInitializerQueryPart to use for built the query
64       * @param listFormFilterQueryPart
65       *            The list of FormFilterQueryPart to retrieve the where parts of the query
66       * @return the global lucene query build from the FormColmuns and FormFilters
67       */
68      public static Query buildQuery( List<IFormPanelInitializerQueryPart> listFormPanelInitializerQueryPart, List<IFormFilterQueryPart> listFormFilterQueryPart )
69      {
70          BooleanQuery.Builder booleanQueryBuilder = new BooleanQuery.Builder( );
71          for ( IFormFilterQueryPart formFilterQueryPart : listFormFilterQueryPart )
72          {
73              if ( formFilterQueryPart instanceof IFormFilterLuceneQueryPart )
74              {
75                  Query queryFormFilterQueryPart = ( (IFormFilterLuceneQueryPart) formFilterQueryPart ).getFormFilterQuery( );
76                  if ( queryFormFilterQueryPart != null )
77                  {
78                      booleanQueryBuilder.add( queryFormFilterQueryPart, BooleanClause.Occur.FILTER );
79                  }
80              }
81          }
82          for ( IFormPanelInitializerQueryPart formPanelInitializerQueryPart : listFormPanelInitializerQueryPart )
83          {
84              if ( formPanelInitializerQueryPart instanceof IFormPanelInitializerLuceneQueryPart )
85              {
86                  Query queryFormFilterQueryPart = ( (IFormPanelInitializerLuceneQueryPart) formPanelInitializerQueryPart ).getFormPanelInitializerSelectQuery( );
87                  if ( queryFormFilterQueryPart != null )
88                  {
89                      booleanQueryBuilder.add( queryFormFilterQueryPart, BooleanClause.Occur.FILTER );
90                  }
91              }
92          }
93          return booleanQueryBuilder.build( );
94      }
95  
96  }