X-Git-Url: https://gerrit.simantics.org/r/gitweb?p=simantics%2Fplatform.git;a=blobdiff_plain;f=bundles%2Forg.simantics.browsing.ui.common%2Fsrc%2Forg%2Fsimantics%2Fbrowsing%2Fui%2Fcommon%2Fviews%2FIFilterStrategy.java;fp=bundles%2Forg.simantics.browsing.ui.common%2Fsrc%2Forg%2Fsimantics%2Fbrowsing%2Fui%2Fcommon%2Fviews%2FIFilterStrategy.java;h=ea7c9bf12087d0864ac9348ceaa7a408eb529108;hp=0000000000000000000000000000000000000000;hb=969bd23cab98a79ca9101af33334000879fb60c5;hpb=866dba5cd5a3929bbeae85991796acb212338a08

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