Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.browsing.ui.common / src / org / simantics / browsing / ui / common / views / IFilterStrategy.java

diff --git a/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/views/IFilterStrategy.java b/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/views/IFilterStrategy.java
new file mode 100644 (file)
index 0000000..ea7c9bf
--- /dev/null
+++ b/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/views/IFilterStrategy.java
@@ -0,0 +1,37 @@
+/*******************************************************************************\r
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
+ * in Industry THTH ry.\r
+ * All rights reserved. This program and the accompanying materials\r
+ * are made available under the terms of the Eclipse Public License v1.0\r
+ * which accompanies this distribution, and is available at\r
+ * http://www.eclipse.org/legal/epl-v10.html\r
+ *\r
+ * Contributors:\r
+ *     VTT Technical Research Centre of Finland - initial API and implementation\r
+ *******************************************************************************/\r
+package org.simantics.browsing.ui.common.views;\r
+\r
+import java.util.regex.Pattern;\r
+\r
+import org.simantics.browsing.ui.common.processors.FilterSelectionRequestQueryProcessor;\r
+\r
+/**\r
+ * This is an interface for specifying a strategy for converting client-specified\r
+ * search strings into regular expressions (see {@link Pattern}), that are used\r
+ * to filter non-matches out of shown results.\r
+ * \r
+ * @author Tuukka Lehtonen\r
+ * \r
+ * @see FilterSelectionRequestQueryProcessor\r
+ * @see Pattern\r
+ */\r
+public interface IFilterStrategy {\r
+\r
+    /**\r
+     * @param filterText the client-specified filter text\r
+     * @return a regular expression String adhering to the specifications of\r
+     *         {@link Pattern} or <code>null</code> to denote <em>no filter</em>.\r
+     */\r
+    String toPatternString(String filterText);\r
+\r
+}\r