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

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