View Javadoc

1   /**
2    * This file Copyright (c) 2003-2011 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.module.admininterface.lists;
35  
36  import info.magnolia.cms.gui.control.FunctionBar;
37  import info.magnolia.cms.gui.controlx.list.ListControl;
38  import info.magnolia.cms.gui.controlx.search.SearchConfig;
39  import info.magnolia.cms.gui.controlx.search.SearchableListModel;
40  import info.magnolia.cms.gui.controlx.search.SimpleSearchUtil;
41  import info.magnolia.cms.gui.query.SearchQuery;
42  import info.magnolia.cms.gui.query.StringSearchQueryParameter;
43  import info.magnolia.freemarker.FreemarkerUtil;
44  
45  import javax.servlet.http.HttpServletRequest;
46  import javax.servlet.http.HttpServletResponse;
47  
48  import org.apache.commons.lang.StringUtils;
49  
50  
51  /**
52   * @author Philipp Bracher
53   * @version $Revision$ ($Author$)
54   */
55  public abstract class AbstractSimpleSearchList extends AbstractList {
56  
57      /**
58       * @param name
59       * @param request
60       * @param response
61       */
62      public AbstractSimpleSearchList(String name, HttpServletRequest request, HttpServletResponse response) {
63          super(name, request, response);
64      }
65  
66      private String searchStr = "";
67  
68      /**
69       * @see info.magnolia.module.admininterface.lists.AbstractList#onRender()
70       */
71      public String onRender() {
72          String str = super.onRender();
73          str += FreemarkerUtil.process(AbstractSimpleSearchList.class, this);
74          return str;
75      }
76  
77      /**
78       * @return Returns the searchStr.
79       */
80      public String getSearchStr() {
81          return this.searchStr;
82      }
83  
84      /**
85       * @param searchStr The searchStr to set.
86       */
87      public void setSearchStr(String searchStr) {
88          this.searchStr = searchStr;
89      }
90  
91      /**
92       * @see info.magnolia.module.admininterface.lists.AbstractList#configureList(info.magnolia.cms.gui.controlx.list.ListControl)
93       */
94      public void initList(ListControl list) {
95          if(StringUtils.isNotBlank(this.searchStr)){
96              super.initList(list);
97              ((SearchableListModel) list.getModel()).setQuery(this.getQuery());
98          }else{
99              super.initList(list);
100             SearchQuery query = new SearchQuery();
101             query.setRootExpression(new StringSearchQueryParameter("*", "*$", StringSearchQueryParameter.CONTAINS));
102             ((SearchableListModel) list.getModel()).setQuery(query);            
103         }
104     }
105 
106     /**
107      * @return
108      */
109     public SearchQuery getQuery() {
110         if(this.getSearchConfig() == null){
111             return SimpleSearchUtil.getSimpleSearchQuery(this.getSearchStr());
112         }
113         return SimpleSearchUtil.getSimpleSearchQuery(this.getSearchStr(), this.getSearchConfig());
114     }
115 
116     protected void configureFunctionBar(FunctionBar bar) {
117         super.configureFunctionBar(bar);
118         bar.setSearchable(true);
119         bar.setSearchStr(this.getSearchStr());
120         bar.setOnSearchFunction(this.getList().getName() + ".search");
121     }
122 
123     /**
124      * @return
125      */
126     public abstract SearchConfig getSearchConfig();
127 
128 }