core/org.gnit.lucenekmp.search/RegexpQuery

RegexpQuery

class RegexpQuery(term: Term, syntaxFlags: Int, matchFlags: Int, provider: AutomatonProvider, determinizeWorkLimit: Int, rewriteMethod: MultiTermQuery.RewriteMethod, doDeterminization: Boolean = true) : AutomatonQuery

A fast regular expression query based on the org.gnit.lucenekmp.util.automaton package.

Comparisons are fast
The term dictionary is enumerated in an intelligent way, to avoid comparisons. See [ ] for more details.

The supported syntax is documented in the RegExp class. Note this might be different than other regular expression implementations. For some alternatives with different syntax, look under the sandbox.

Note this query can be slow, as it needs to iterate over many terms. In order to prevent extremely slow RegexpQueries, a Regexp term should not start with the expression .*

Constructors

RegexpQuery

constructor(term: Term, syntaxFlags: Int, matchFlags: Int, provider: AutomatonProvider, determinizeWorkLimit: Int, rewriteMethod: MultiTermQuery.RewriteMethod, doDeterminization: Boolean = true)

constructor(term: Term, flags: Int = RegExp.ALL)

Constructs a query for terms matching term.

constructor(term: Term, flags: Int, determinizeWorkLimit: Int)

Constructs a query for terms matching term.

constructor(term: Term, syntaxFlags: Int, matchFlags: Int, determinizeWorkLimit: Int)

Constructs a query for terms matching term.

constructor(term: Term, syntaxFlags: Int, provider: AutomatonProvider, determinizeWorkLimit: Int)

Constructs a query for terms matching term.

Types

Companion

object Companion

Properties

childResources

open val childResources: MutableCollection<Accountable>

Returns nested resources of this class. The result should be a point-in-time snapshot (to avoid race conditions).

field

open val field: String

Returns the field name for this query

isAutomatonBinary

val isAutomatonBinary: Boolean

Is this a binary (byte) oriented automaton. See the constructor.

regexp

val regexp: Term

rewriteMethod

val rewriteMethod: MultiTermQuery.RewriteMethod

termsCount

open val termsCount: Long

Functions

createWeight

open fun createWeight(searcher: IndexSearcher, scoreMode: ScoreMode, boost: Float): Weight

Expert: Constructs an appropriate Weight implementation for this query.

equals

open operator override fun equals(obj: Any?): Boolean

Override and implement query instance equivalence properly in a subclass. This is required so that QueryCache works properly.

getTermsEnum

fun getTermsEnum(terms: Terms): TermsEnum

Constructs an enumeration that expands the pattern term. This method should only be called if the field exists (ie, implementations can assume the field does exist). This method never returns null. The returned TermsEnum is positioned to the first matching term.

hashCode

open override fun hashCode(): Int

Override and implement query hash code properly in a subclass. This is required so that [ ] works properly.

ramBytesUsed

open override fun ramBytesUsed(): Long

Returns the automaton used to create this query

rewrite