Package com.jalios.jcms.search.queryparser

Class ParseOptions

java.lang.Object

com.jalios.jcms.search.queryparser.ParseOptions

public class ParseOptions
extends java.lang.Object

Holder class for text search options

Since:

jcms-6.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ParseOptions.Engine	Search engine for which an operation is requested.
static class	ParseOptions.TextMode

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ParseOptions(java.lang.String[] fields, AbstractQueryHandler<?> qh, ParseOptions.Engine engine)
	ParseOptions(java.lang.String[] fields, AllMemberQueryHandler amqh)	Build a new ParseOptions from the specified AllMemberQueryHandler
	ParseOptions(java.lang.String[] fields, QueryHandler qh, ParseOptions.Engine engine)	Build a new ParseOptions from the specified QueryHandler

Method Summary

Modifier and Type	Method	Description
ParseOptions.Engine	getEngine()	Retrieve the Engine for which the search operation was requested.
java.lang.String[]	getFields()	Retrieve the lucene fields in which to perform the search
java.lang.String	getLang()	Retrieve the lang in which the parsing is requested.
java.util.Locale	getLocale()	Retrieve the locale in which the parsing is requested.
ParseOptions.TextMode	getMode()	Retrieve the TextMode to use during the text search
AbstractQueryHandler<?>	getQueryHandler()	Retrieve the QueryHandler associated to this ParseOptions (if any).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParseOptions

public ParseOptions(java.lang.String[] fields,
                    QueryHandler qh,
                    ParseOptions.Engine engine)

Build a new ParseOptions from the specified QueryHandler

Parameters:

fields - the fields in which search should be performed

qh - the QueryHandler from which options should be retrieved

engine - the search engine for which the search is being performed

Since:

jcms-8.0.0

ParseOptions

public ParseOptions(java.lang.String[] fields,
                    AllMemberQueryHandler amqh)

Build a new ParseOptions from the specified AllMemberQueryHandler

Parameters:

fields - the fields in which search should be performed

amqh - the QueryHandler from which options should be retrieved

Since:

jcms-6.1.0

ParseOptions

protected ParseOptions(java.lang.String[] fields,
                       AbstractQueryHandler<?> qh,
                       ParseOptions.Engine engine)

Method Detail

getMode

public ParseOptions.TextMode getMode()

Retrieve the TextMode to use during the text search

Returns:

a TextMode

Since:

jcms-6.1.0

getFields

public java.lang.String[] getFields()

Retrieve the lucene fields in which to perform the search

Returns:

an array of lucene fields name

Since:

jcms-6.1.0

getQueryHandler

public AbstractQueryHandler<?> getQueryHandler()

Retrieve the QueryHandler associated to this ParseOptions (if any).

Returns:

an AbstractQueryHandler instance, or null if this ParseOptions was not created with a QueryHandler.

Since:

jcms-10.0.2 / JCMS-6800

getLocale

public java.util.Locale getLocale()

Retrieve the locale in which the parsing is requested.

Returns:

a Locale instance (maybe return null)

getLang

public java.lang.String getLang()

Retrieve the lang in which the parsing is requested.

Returns:

a ISO-639 coed (maybe return null)

getEngine

public ParseOptions.Engine getEngine()

Retrieve the Engine for which the search operation was requested.

Returns:

a Engine

Since:

jcms-8.0.0