nl.inl.blacklab.search.textpattern

Class TextPatternRegex

java.lang.Object

nl.inl.blacklab.search.textpattern.TextPattern

nl.inl.blacklab.search.textpattern.TextPatternTerm

nl.inl.blacklab.search.textpattern.TextPatternRegex

public class TextPatternRegex
extends TextPatternTerm

A TextPattern matching a regular expression.

Field Summary

Fields inherited from class nl.inl.blacklab.search.textpattern.TextPatternTerm

value

Fields inherited from class nl.inl.blacklab.search.textpattern.TextPattern

MAX_UNLIMITED

Constructor Summary

Constructors

Constructor and Description
TextPatternRegex(String value) Instantiate a regex TextPattern.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	hashCode()
TextPattern	rewrite() Rewrite to TextPatternTerm if value only contains letters and numbers.
String	toString()
BLSpanQuery	translate(QueryExecutionContext context) Translate this TextPattern into a BLSpanQuery.

Methods inherited from class nl.inl.blacklab.search.textpattern.TextPatternTerm

getTerm, getValue

Methods inherited from class nl.inl.blacklab.search.textpattern.TextPattern

clausesToString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TextPatternRegex

public TextPatternRegex(String value)

Instantiate a regex TextPattern.

Parameters:

value -

Method Detail

translate

public BLSpanQuery translate(QueryExecutionContext context)
                      throws InvalidQuery

Description copied from class: TextPattern

Translate this TextPattern into a BLSpanQuery.

Overrides:

translate in class TextPatternTerm

Parameters:

context - query execution context to use

Returns:

result of the translation

Throws:

RegexpTooLarge - if a regular expression was too large

InvalidQuery - if something else was wrong about the query (e.g. error in regex expression)

rewrite

public TextPattern rewrite()

Rewrite to TextPatternTerm if value only contains letters and numbers. Also looks at (?i), (?-i), (?c) at the start of the pattern and converts that into an appropriate TextPatternSensitive() wrapper. In all other cases, we keep TextPatternRegex because Lucene's regex, wildcard and prefix queries all work in the same basic way (are converted into AutomatonQuery's), so they are equally fast.

Returns:

the TextPattern

equals

public boolean equals(Object obj)

Overrides:

equals in class TextPatternTerm

hashCode

public int hashCode()

Overrides:

hashCode in class TextPatternTerm

toString

public String toString()

Overrides:

toString in class TextPatternTerm