org.apache.lucene.search.regex

Interface RegexCapabilities

All Known Implementing Classes:

JakartaRegexpCapabilities, JavaUtilRegexCapabilities

public interface RegexCapabilities

Defines basic operations needed by RegexQuery for a regular expression implementation.

Method Summary

Modifier and Type	Method and Description
void	compile(java.lang.String pattern) Called by the constructor of RegexTermEnum allowing implementations to cache a compiled version of the regular expression pattern.
boolean	match(java.lang.String string)
java.lang.String	prefix() A wise prefix implementation can reduce the term enumeration (and thus increase performance) of RegexQuery dramatically!

Method Detail

compile

void compile(java.lang.String pattern)

Called by the constructor of RegexTermEnum allowing implementations to cache a compiled version of the regular expression pattern.

Parameters:

pattern - regular expression pattern

match

boolean match(java.lang.String string)

Parameters:

string -

Returns:

true if string matches the pattern last passed to compile(java.lang.String).

prefix

java.lang.String prefix()

A wise prefix implementation can reduce the term enumeration (and thus increase performance) of RegexQuery dramatically!

Returns:

static non-regex prefix of the pattern last passed to compile(java.lang.String). May return null.