1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.util.lucene;
24  
25  import com.liferay.portal.kernel.util.StringPool;
26  import com.liferay.portal.kernel.util.StringUtil;
27  
28  /**
29   * <a href="KeywordsUtil.java.html"><b><i>View Source</i></b></a>
30   *
31   * @author Brian Wing Shun Chan
32   * @author Mirco Tamburini
33   * @author Josiah Goh
34   *
35   */
36  public class KeywordsUtil {
37  
38      public static final String[] SPECIAL = new String[] {
39          "+", "-", "&&", "||", "!", "(", ")", "{", "}", "[", "]", "^", "\"", "~",
40          "*", "?", ":", "\\"
41      };
42  
43      public static String escape(String text) {
44          for (int i = SPECIAL.length - 1; i >= 0; i--) {
45              text = StringUtil.replace(
46                  text, SPECIAL[i], StringPool.BACK_SLASH + SPECIAL[i]);
47          }
48  
49          return text;
50      }
51  
52      public static String toFuzzy(String keywords) {
53          if (keywords == null) {
54              return null;
55          }
56  
57          if (!keywords.endsWith(StringPool.TILDE)) {
58              keywords = keywords + StringPool.TILDE;
59          }
60  
61          return keywords;
62      }
63  
64      public static String toWildcard(String keywords) {
65          if (keywords == null) {
66              return null;
67          }
68  
69          if (!keywords.endsWith(StringPool.STAR)) {
70              keywords = keywords + StringPool.STAR;
71          }
72  
73          return keywords;
74      }
75  
76  }