com.exalead.search.v30

Class ParsingConfig

java.lang.Object

com.exalead.search.v30.ParsingConfig

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class ParsingConfig
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

No documentation for this element.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParsingConfig.FallbackReportMode
static class	ParsingConfig.ImplicitSequenceOperator
static class	ParsingConfig.OversizedQueryReportMode

Field Summary

Fields

Modifier and Type	Field and Description
boolean	allowOptions
static boolean	DEFAULT_ALLOW_OPTIONS
static boolean	DEFAULT_FALLBACK_ON_ERROR
static java.lang.String	DEFAULT_FALLBACK_REPORT_MODE
static java.lang.String	DEFAULT_IMPLICIT_SEQUENCE_OPERATOR
static int	DEFAULT_NEAR_DISTANCE
static java.lang.String	DEFAULT_OVERSIZED_QUERY_REPORT_MODE
boolean	fallbackOnError
java.lang.String	fallbackReportMode
java.lang.String	implicitSequenceOperator
int	maxQuerySize
int	nearDistance
java.lang.String	oversizedQueryReportMode

Constructor Summary

Constructors

Constructor and Description
ParsingConfig()
ParsingConfig(ParsingConfig o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this ParsingConfig.
static ParsingConfig	fromString(java.lang.String s) String representation of this ParsingConfig.
java.lang.String	getFallbackReportMode() Specifies how to report a search error in 'Troubleshooting > Logs': quiet: No log. local: Error is reported in the Process log. global: Error is reported in both Process and Global logs.
ParsingConfig.FallbackReportMode	getFallbackReportModeAsEnum() Specifies how to report a search error in 'Troubleshooting > Logs': quiet: No log. local: Error is reported in the Process log. global: Error is reported in both Process and Global logs.
java.lang.String	getImplicitSequenceOperator() The default query operator.
ParsingConfig.ImplicitSequenceOperator	getImplicitSequenceOperatorAsEnum() The default query operator.
int	getMaxQuerySize() Queries larger than N are rejected. 0 means no limit.
int	getNearDistance() Default distance for NEAR queries
java.lang.String	getOversizedQueryReportMode() Specifies how to report an oversized query error in 'Troubleshooting > Logs': quiet: No log. local: Error is reported in the Process log. global: Error is reported in both Process and Global logs.
ParsingConfig.OversizedQueryReportMode	getOversizedQueryReportModeAsEnum() Specifies how to report an oversized query error in 'Troubleshooting > Logs': quiet: No log. local: Error is reported in the Process log. global: Error is reported in both Process and Global logs.
static boolean	isA(java.lang.String str, ParsingConfig.FallbackReportMode item)
static boolean	isA(java.lang.String str, ParsingConfig.ImplicitSequenceOperator item)
static boolean	isA(java.lang.String str, ParsingConfig.OversizedQueryReportMode item)
boolean	isAllowOptions() Allows word options in user query.
boolean	isFallbackOnError() If the standard parsing fails, parses the query with a relaxed grammar, meaning it will split words on white spaces. Note that in some cases, operators and prefix handlers will not be taken into account for the query. For example, a query that ends with an AND will normally return an error. If this option is selected, CloudView will search for "AND" instead of considering it as an operator.
static boolean	isOneOf(java.lang.String str, ParsingConfig.FallbackReportMode... items)
static boolean	isOneOf(java.lang.String str, ParsingConfig.ImplicitSequenceOperator... items)
static boolean	isOneOf(java.lang.String str, ParsingConfig.OversizedQueryReportMode... items)
ParsingConfig	makeCopy() Creates and returns a deep copy of this ParsingConfig.
static ParsingConfig	readFrom(java.io.InputStream is) Read this ParsingConfig from an XML fragment.
void	setAllowOptions(boolean allowOptions) Allows word options in user query.
void	setFallbackOnError(boolean fallbackOnError) If the standard parsing fails, parses the query with a relaxed grammar, meaning it will split words on white spaces. Note that in some cases, operators and prefix handlers will not be taken into account for the query. For example, a query that ends with an AND will normally return an error. If this option is selected, CloudView will search for "AND" instead of considering it as an operator.
void	setFallbackReportMode(ParsingConfig.FallbackReportMode item) Specifies how to report a search error in 'Troubleshooting > Logs': quiet: No log. local: Error is reported in the Process log. global: Error is reported in both Process and Global logs.
void	setFallbackReportMode(java.lang.String fallbackReportMode) Specifies how to report a search error in 'Troubleshooting > Logs': quiet: No log. local: Error is reported in the Process log. global: Error is reported in both Process and Global logs.
void	setImplicitSequenceOperator(ParsingConfig.ImplicitSequenceOperator item) The default query operator.
void	setImplicitSequenceOperator(java.lang.String implicitSequenceOperator) The default query operator.
void	setMaxQuerySize(int maxQuerySize) Queries larger than N are rejected. 0 means no limit.
void	setNearDistance(int nearDistance) Default distance for NEAR queries
void	setOversizedQueryReportMode(ParsingConfig.OversizedQueryReportMode item) Specifies how to report an oversized query error in 'Troubleshooting > Logs': quiet: No log. local: Error is reported in the Process log. global: Error is reported in both Process and Global logs.
void	setOversizedQueryReportMode(java.lang.String oversizedQueryReportMode) Specifies how to report an oversized query error in 'Troubleshooting > Logs': quiet: No log. local: Error is reported in the Process log. global: Error is reported in both Process and Global logs.
java.lang.String	toString() String representation of this ParsingConfig.
ParsingConfig	withAllowOptions(boolean allowOptions)
ParsingConfig	withAllowOptions(java.lang.Boolean allowOptions)
ParsingConfig	withFallbackOnError(boolean fallbackOnError)
ParsingConfig	withFallbackOnError(java.lang.Boolean fallbackOnError)
ParsingConfig	withFallbackReportMode(java.lang.String fallbackReportMode)
ParsingConfig	withImplicitSequenceOperator(java.lang.String implicitSequenceOperator)
ParsingConfig	withMaxQuerySize(int maxQuerySize)
ParsingConfig	withMaxQuerySize(java.lang.Integer maxQuerySize)
ParsingConfig	withNearDistance(int nearDistance)
ParsingConfig	withNearDistance(java.lang.Integer nearDistance)
ParsingConfig	withOversizedQueryReportMode(java.lang.String oversizedQueryReportMode)
void	writeTo(java.io.OutputStream os) Write this ParsingConfig as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

allowOptions

public boolean allowOptions

DEFAULT_ALLOW_OPTIONS

public static final boolean DEFAULT_ALLOW_OPTIONS

See Also:

Constant Field Values

nearDistance

public int nearDistance

DEFAULT_NEAR_DISTANCE

public static final int DEFAULT_NEAR_DISTANCE

See Also:

Constant Field Values

fallbackOnError

public boolean fallbackOnError

DEFAULT_FALLBACK_ON_ERROR

public static final boolean DEFAULT_FALLBACK_ON_ERROR

See Also:

Constant Field Values

fallbackReportMode

public java.lang.String fallbackReportMode

DEFAULT_FALLBACK_REPORT_MODE

public static final java.lang.String DEFAULT_FALLBACK_REPORT_MODE

See Also:

Constant Field Values

maxQuerySize

public int maxQuerySize

oversizedQueryReportMode

public java.lang.String oversizedQueryReportMode

DEFAULT_OVERSIZED_QUERY_REPORT_MODE

public static final java.lang.String DEFAULT_OVERSIZED_QUERY_REPORT_MODE

See Also:

Constant Field Values

implicitSequenceOperator

public java.lang.String implicitSequenceOperator

DEFAULT_IMPLICIT_SEQUENCE_OPERATOR

public static final java.lang.String DEFAULT_IMPLICIT_SEQUENCE_OPERATOR

See Also:

Constant Field Values

Constructor Detail

ParsingConfig

public ParsingConfig()

ParsingConfig

public ParsingConfig(ParsingConfig o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          ParsingConfig.FallbackReportMode item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              ParsingConfig.FallbackReportMode... items)

setFallbackReportMode

public void setFallbackReportMode(ParsingConfig.FallbackReportMode item)

Specifies how to report a search error in 'Troubleshooting > Logs':

• quiet: No log.
• local: Error is reported in the Process log.
• global: Error is reported in both Process and Global logs.

getFallbackReportModeAsEnum

public ParsingConfig.FallbackReportMode getFallbackReportModeAsEnum()

Specifies how to report a search error in 'Troubleshooting > Logs':

• quiet: No log.
• local: Error is reported in the Process log.
• global: Error is reported in both Process and Global logs.

isA

public static boolean isA(java.lang.String str,
                          ParsingConfig.OversizedQueryReportMode item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              ParsingConfig.OversizedQueryReportMode... items)

setOversizedQueryReportMode

public void setOversizedQueryReportMode(ParsingConfig.OversizedQueryReportMode item)

Specifies how to report an oversized query error in 'Troubleshooting > Logs':

• quiet: No log.
• local: Error is reported in the Process log.
• global: Error is reported in both Process and Global logs.

getOversizedQueryReportModeAsEnum

public ParsingConfig.OversizedQueryReportMode getOversizedQueryReportModeAsEnum()

Specifies how to report an oversized query error in 'Troubleshooting > Logs':

• quiet: No log.
• local: Error is reported in the Process log.
• global: Error is reported in both Process and Global logs.

isA

public static boolean isA(java.lang.String str,
                          ParsingConfig.ImplicitSequenceOperator item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              ParsingConfig.ImplicitSequenceOperator... items)

setImplicitSequenceOperator

public void setImplicitSequenceOperator(ParsingConfig.ImplicitSequenceOperator item)

The default query operator. If a user enters this query: exalead cloudview (without quotes), by default, it will be parsed as "exalead AND cloudview".

getImplicitSequenceOperatorAsEnum

public ParsingConfig.ImplicitSequenceOperator getImplicitSequenceOperatorAsEnum()

The default query operator. If a user enters this query: exalead cloudview (without quotes), by default, it will be parsed as "exalead AND cloudview".

setAllowOptions

public void setAllowOptions(boolean allowOptions)

Allows word options in user query.

isAllowOptions

public boolean isAllowOptions()

Allows word options in user query.

withAllowOptions

public ParsingConfig withAllowOptions(boolean allowOptions)

withAllowOptions

public ParsingConfig withAllowOptions(java.lang.Boolean allowOptions)

setNearDistance

public void setNearDistance(int nearDistance)

Default distance for NEAR queries

getNearDistance

public int getNearDistance()

Default distance for NEAR queries

withNearDistance

public ParsingConfig withNearDistance(int nearDistance)

withNearDistance

public ParsingConfig withNearDistance(java.lang.Integer nearDistance)

setFallbackOnError

public void setFallbackOnError(boolean fallbackOnError)

If the standard parsing fails, parses the query with a relaxed grammar, meaning it will split words on white spaces.
Note that in some cases, operators and prefix handlers will not be taken into account for the query.
For example, a query that ends with an AND will normally return an error.
If this option is selected, CloudView will search for "AND" instead of considering it as an operator. See also missingPrefixBehaviour in UQLConfig

isFallbackOnError

public boolean isFallbackOnError()

If the standard parsing fails, parses the query with a relaxed grammar, meaning it will split words on white spaces.
Note that in some cases, operators and prefix handlers will not be taken into account for the query.
For example, a query that ends with an AND will normally return an error.
If this option is selected, CloudView will search for "AND" instead of considering it as an operator. See also missingPrefixBehaviour in UQLConfig

withFallbackOnError

public ParsingConfig withFallbackOnError(boolean fallbackOnError)

withFallbackOnError

public ParsingConfig withFallbackOnError(java.lang.Boolean fallbackOnError)

setFallbackReportMode

public void setFallbackReportMode(java.lang.String fallbackReportMode)

Specifies how to report a search error in 'Troubleshooting > Logs':

• quiet: No log.
• local: Error is reported in the Process log.
• global: Error is reported in both Process and Global logs.

getFallbackReportMode

public java.lang.String getFallbackReportMode()

Specifies how to report a search error in 'Troubleshooting > Logs':

• quiet: No log.
• local: Error is reported in the Process log.
• global: Error is reported in both Process and Global logs.

withFallbackReportMode

public ParsingConfig withFallbackReportMode(java.lang.String fallbackReportMode)

setMaxQuerySize

public void setMaxQuerySize(int maxQuerySize)

Queries larger than N are rejected.
0 means no limit.

getMaxQuerySize

public int getMaxQuerySize()

Queries larger than N are rejected.
0 means no limit.

withMaxQuerySize

public ParsingConfig withMaxQuerySize(int maxQuerySize)

withMaxQuerySize

public ParsingConfig withMaxQuerySize(java.lang.Integer maxQuerySize)

setOversizedQueryReportMode

public void setOversizedQueryReportMode(java.lang.String oversizedQueryReportMode)

Specifies how to report an oversized query error in 'Troubleshooting > Logs':

• quiet: No log.
• local: Error is reported in the Process log.
• global: Error is reported in both Process and Global logs.

getOversizedQueryReportMode

public java.lang.String getOversizedQueryReportMode()

Specifies how to report an oversized query error in 'Troubleshooting > Logs':

• quiet: No log.
• local: Error is reported in the Process log.
• global: Error is reported in both Process and Global logs.

withOversizedQueryReportMode

public ParsingConfig withOversizedQueryReportMode(java.lang.String oversizedQueryReportMode)

setImplicitSequenceOperator

public void setImplicitSequenceOperator(java.lang.String implicitSequenceOperator)

The default query operator. If a user enters this query: exalead cloudview (without quotes), by default, it will be parsed as "exalead AND cloudview".

getImplicitSequenceOperator

public java.lang.String getImplicitSequenceOperator()

The default query operator. If a user enters this query: exalead cloudview (without quotes), by default, it will be parsed as "exalead AND cloudview".

withImplicitSequenceOperator

public ParsingConfig withImplicitSequenceOperator(java.lang.String implicitSequenceOperator)

makeCopy

public ParsingConfig makeCopy()

Creates and returns a deep copy of this ParsingConfig.

readFrom

public static ParsingConfig readFrom(java.io.InputStream is)
                              throws javax.xml.bind.JAXBException

Read this ParsingConfig from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this ParsingConfig as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static ParsingConfig fromString(java.lang.String s)
                                throws javax.xml.bind.JAXBException,
                                       java.io.UnsupportedEncodingException

String representation of this ParsingConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ParsingConfig.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this ParsingConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException