01: package org.apache.lucene.search.regex;
02:
03: /**
04: * Licensed to the Apache Software Foundation (ASF) under one or more
05: * contributor license agreements. See the NOTICE file distributed with
06: * this work for additional information regarding copyright ownership.
07: * The ASF licenses this file to You under the Apache License, Version 2.0
08: * (the "License"); you may not use this file except in compliance with
09: * 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 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: }
|