Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
IRegexCapabilities.cs
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 namespace Contrib.Regex
19 {
20  /// <summary>
21  /// Defines basic operations needed by <see cref="RegexQuery"/> for a regular expression implementation.
22  /// </summary>
23  /// <remarks>http://www.java2s.com/Open-Source/Java-Document/Net/lucene-connector/org/apache/lucene/search/regex/RegexCapabilities.java.htm</remarks>
24  public interface IRegexCapabilities
25  {
26  /// <summary>
27  /// Called by the constructor of <see cref="RegexTermEnum"/> allowing implementations to cache
28  /// a compiled version of the regular expression pattern.
29  /// </summary>
30  /// <param name="pattern">regular expression pattern</param>
31  void Compile(string pattern);
32 
33  /// <summary>
34  /// True on match.
35  /// </summary>
36  /// <param name="s">text to match</param>
37  /// <returns>true on match</returns>
38  bool Match(string s);
39 
40  /// <summary>
41  /// A wise prefix implementation can reduce the term enumeration (and thus performance)
42  /// of RegexQuery dramatically.
43  /// </summary>
44  /// <returns>static non-regex prefix of the pattern last passed to <see cref="Compile"/>.
45  /// May return null</returns>
46  string Prefix();
47  }
48 }