← Back to branch summary

~slub.team/goobi-indexserver/3.x

« back to all changes in this revision

Viewing changes to lucene/contrib/queries/src/java/org/apache/lucene/search/regex/RegexCapabilities.java

  • Committer: Sebastian Meyer
  • Date: 2012-08-03 09:12:40 UTC
  • Revision ID: sebastian.meyer@slub-dresden.de-20120803091240-x6861b0vabq1xror
https://launchpad.net/bugs/985487
Remove Lucene and Solr source code and add patches instead
Fix Bug #985487: Auto-suggestion for the search interface

Show diffs side-by-side

added added

removed removed

Lines of Context:
lucene/contrib/queries/src/java/org/apache/lucene/search/regex/RegexCapabilities.java
1
 
package org.apache.lucene.search.regex;
2
 
 
3
 
/**
4
 
 * Licensed to the Apache Software Foundation (ASF) under one or more
5
 
 * contributor license agreements.  See the NOTICE file distributed with
6
 
 * this work for additional information regarding copyright ownership.
7
 
 * The ASF licenses this file to You under the Apache License, Version 2.0
8
 
 * (the "License"); you may not use this file except in compliance with
9
 
 * the License.  You may obtain a copy of the License at
10
 
 *
11
 
 *     http://www.apache.org/licenses/LICENSE-2.0
12
 
 *
13
 
 * Unless required by applicable law or agreed to in writing, software
14
 
 * distributed under the License is distributed on an "AS IS" BASIS,
15
 
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
 
 * See the License for the specific language governing permissions and
17
 
 * limitations under the License.
18
 
 */
19
 
 
20
 
/**
21
 
 * Defines basic operations needed by {@link RegexQuery} for a regular
22
 
 * expression implementation.
23
 
 */
24
 
public interface RegexCapabilities {
25
 
  /**
26
 
   * Called by the constructor of {@link RegexTermEnum} allowing
27
 
   * implementations to cache a compiled version of the regular
28
 
   * expression pattern.
29
 
   *
30
 
   * @param pattern regular expression pattern
31
 
   */
32
 
  void compile(String pattern);
33
 
 
34
 
  /**
35
 
   *
36
 
   * @param string
37
 
   * @return true if string matches the pattern last passed to {@link #compile}.
38
 
   */
39
 
  boolean match(String string);
40
 
 
41
 
  /**
42
 
   * A wise prefix implementation can reduce the term enumeration (and thus increase performance)
43
 
   * of RegexQuery dramatically!
44
 
   *
45
 
   * @return static non-regex prefix of the pattern last passed to {@link #compile}.  May return null.
46
 
   */
47
 
  String prefix();
48
 
}