View Javadoc

1   /**
2    * This file Copyright (c) 2003-2010 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.cms.gui.controlx.search;
35  
36  import info.magnolia.cms.gui.controlx.impl.AbstractControl;
37  import info.magnolia.cms.gui.query.SearchQueryExpression;
38  import info.magnolia.cms.gui.query.StringSearchQueryParameter;
39  
40  import org.apache.commons.lang.StringUtils;
41  
42  
43  /**
44   * This is a real control instance
45   * @author Philipp Bracher
46   * @version $Revision: 34820 $ ($Author: gjoseph $)
47   */
48  public class SearchControl extends AbstractControl {
49  
50      public static final String RENDER_TYPE = "searchControl";
51  
52      private SearchControlDefinition definition;
53  
54      private String value;
55  
56      private String constraint;
57  
58      public SearchControl() {
59          this.setRenderType(RENDER_TYPE);
60      }
61  
62      /**
63       * @param definition
64       * @param value
65       * @param constraint
66       */
67      public SearchControl(SearchControlDefinition definition, String value, String condition) {
68          this();
69          this.definition = definition;
70          this.value = value;
71          this.constraint = condition;
72      }
73  
74      /**
75       * @return Returns the constraint.
76       */
77      public String getConstraint() {
78          return constraint;
79      }
80  
81      /**
82       * @param constraint The constraint to set.
83       */
84      public void setConstraint(String condition) {
85          this.constraint = condition;
86      }
87  
88      /**
89       * @return Returns the definition.
90       */
91      public SearchControlDefinition getDefinition() {
92          return definition;
93      }
94  
95      /**
96       * @param definition The definition to set.
97       */
98      public void setDefinition(SearchControlDefinition definition) {
99          this.definition = definition;
100     }
101 
102     /**
103      * @return Returns the value.
104      */
105     public String getValue() {
106         return value;
107     }
108 
109     /**
110      * @param value The value to set.
111      */
112     public void setValue(String value) {
113         this.value = value;
114     }
115 
116     /**
117      * @return
118      */
119     public SearchQueryExpression getExpression() {
120         String value = this.getValue().toString();
121         if (StringUtils.isNotEmpty(value)) {
122             return new StringSearchQueryParameter(this.getDefinition().getColumn(), value, this.getConstraint());
123         }
124         return null;
125     }
126 
127 }