bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/views/IFilterStrategy.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
   3  * in Industry THTH ry.\r
   4  * All rights reserved. This program and the accompanying materials\r
   5  * are made available under the terms of the Eclipse Public License v1.0\r
   6  * which accompanies this distribution, and is available at\r
   7  * http://www.eclipse.org/legal/epl-v10.html\r
   8  *\r
   9  * Contributors:\r
  10  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  11  *******************************************************************************/\r
  12 package org.simantics.browsing.ui.common.views;\r
  13 \r
  14 import java.util.regex.Pattern;\r
  15 \r
  16 import org.simantics.browsing.ui.common.processors.FilterSelectionRequestQueryProcessor;\r
  17 \r
  18 /**\r
  19  * This is an interface for specifying a strategy for converting client-specified\r
  20  * search strings into regular expressions (see {@link Pattern}), that are used\r
  21  * to filter non-matches out of shown results.\r
  22  * \r
  23  * @author Tuukka Lehtonen\r
  24  * \r
  25  * @see FilterSelectionRequestQueryProcessor\r
  26  * @see Pattern\r
  27  */\r
  28 public interface IFilterStrategy {\r
  29 \r
  30     /**\r
  31      * @param filterText the client-specified filter text\r
  32      * @return a regular expression String adhering to the specifications of\r
  33      *         {@link Pattern} or <code>null</code> to denote <em>no filter</em>.\r
  34      */\r
  35     String toPatternString(String filterText);\r
  36 \r
  37 }\r