queryparser/org.gnit.lucenekmp.queryparser.complexPhrase/ComplexPhraseQueryParser

ComplexPhraseQueryParser

open class ComplexPhraseQueryParser(f: String, a: Analyzer) : QueryParser

QueryParser which permits complex phrase query syntax eg "(john jon jonathan~) peters*".

Constructors

constructor(f: String, a: Analyzer)

Types

class ComplexPhraseQuery(val field: String, val phrasedQueryStringContents: String, val slopFactor: Int, inOrder: Boolean) : Query

Properties

allowLeadingWildcard

open override var allowLeadingWildcard: Boolean

Set to true to allow leading wildcard characters.

analyzer

var analyzer: Analyzer

autoGenerateMultiTermSynonymsPhraseQuery

var autoGenerateMultiTermSynonymsPhraseQuery: Boolean

autoGeneratePhraseQueries

open override var autoGeneratePhraseQueries: Boolean

Set to true if phrase queries will be automatically generated when the analyzer returns more than one term from whitespace delimited text. NOTE: this behavior may not be suitable for all languages.

dateResolution

open override var dateResolution: DateTools.Resolution

Sets the default Resolution used for certain field when no Resolution is defined for this field.

defaultOperator

val defaultOperator: QueryParser.Operator

determinizeWorkLimit

var determinizeWorkLimit: Int

enableGraphQueries

var enableGraphQueries: Boolean

enablePositionIncrements

var enablePositionIncrements: Boolean

Set to true to enable position increments in result query.

field

lateinit var field: String

fieldToDateResolution

var fieldToDateResolution: MutableMap<String, DateTools.Resolution>?

fuzzyMinSim

open override var fuzzyMinSim: Float

Set the minimum similarity for fuzzy queries. Default is 2f.

fuzzyPrefixLength

open override var fuzzyPrefixLength: Int

Set the prefix length for fuzzy queries. Default is 0.

jj_nt

var jj_nt: Token?

Next token.

locale

open override var locale: Locale

Returns current locale, allowing access by subclasses.

multiTermRewriteMethod

open override var multiTermRewriteMethod: MultiTermQuery.RewriteMethod

nextToken

val nextToken: Token?

operator

var operator: QueryParser.Operator

The actual operator that parser uses to combine query terms

phraseSlop

open override var phraseSlop: Int

Sets the default slop for phrases. If zero, then exact phrase matches are required. Default value is zero.

timeZone

open override var timeZone: TimeZone

token

var token: Token?

Current token.

token_source

var token_source: QueryParserTokenManager

Generated Token Manager.

Functions

Clause

fun Clause(field: String): Query?

Conjunction

fun Conjunction(): Int

createBooleanQuery

fun createBooleanQuery(field: String, queryText: String, operator: BooleanClause.Occur): Query?

createMinShouldMatchQuery

fun createMinShouldMatchQuery(field: String, queryText: String, fraction: Float): Query?

createPhraseQuery

fun createPhraseQuery(field: String, queryText: String, phraseSlop: Int): Query?

disable_tracing

fun disable_tracing()

Disable tracing.

discardEscapeChar

fun discardEscapeChar(input: String): String

Returns a String where the escape char has been removed, or kept only once if there was a double escape.

enable_tracing

fun enable_tracing()

Enable tracing.

generateParseException

fun generateParseException(): ParseException

Generate ParseException.

getDateResolution

fun getDateResolution(fieldName: String): DateTools.Resolution?

Returns the date resolution that is used by RangeQueries for the given field. Returns null, if no default or field specific date resolution has been set for the given field.

getSplitOnWhitespace

fun getSplitOnWhitespace(): Boolean

getToken

fun getToken(index: Int): Token

Get the specific Token.

handleBareFuzzy

open fun handleBareFuzzy(qfield: String, fuzzySlop: Token, termImage: String): Query

handleBareTokenQuery

fun handleBareTokenQuery(qfield: String, term: Token, fuzzySlop: Token?, prefix: Boolean, wildcard: Boolean, fuzzy: Boolean, regexp: Boolean): Query?

handleBoost

fun handleBoost(q: Query?, boost: Token?): Query?

handleQuotedTerm

fun handleQuotedTerm(qfield: String, term: Token, fuzzySlop: Token?): Query?

init

fun init(f: String, a: Analyzer)

Initializes a query parser. Called by the QueryParser constructor

Modifiers

fun Modifiers(): Int

MultiTerm

fun MultiTerm(field: String, clauses: MutableList<BooleanClause>): Query

Returns the first query if splitOnWhitespace=true or otherwise the entire produced query

parse

open override fun parse(query: String): Query?

Parses a query string, returning a Query.

Query

fun Query(field: String): Query?

ReInit

open override fun ReInit(stream: CharStream)

fun ReInit(tm: QueryParserTokenManager)

Reinitialise.

setDateResolution

fun setDateResolution(fieldName: String, dateResolution: DateTools.Resolution)

Sets the date resolution used by RangeQueries for a specific field.

setDefaultOperator

fun setDefaultOperator(op: QueryParser.Operator)

Sets the boolean operator of the QueryParser. In default mode (OR_OPERATOR) terms without any modifiers are considered optional: for example capital of Hungary is equal to capital OR of OR Hungary.

In AND_OPERATOR mode terms are considered to be in conjunction: the above-mentioned query is parsed as capital AND of AND Hungary

setInOrder

fun setInOrder(inOrder: Boolean)

When inOrder is true, the search terms must exists in the documents as the same order as in query.

setSplitOnWhitespace

fun setSplitOnWhitespace(splitOnWhitespace: Boolean)

Whether query text should be split on whitespace prior to analysis. Default is {@value #DEFAULT_SPLIT_ON_WHITESPACE}.

Term

fun Term(field: String): Query?

TopLevelQuery

open override fun TopLevelQuery(field: String): Query?

trace_enabled

fun trace_enabled(): Boolean

Trace enabled.