com.exalead.search.v30

Class SWConfig

java.lang.Object

com.exalead.search.v30.SWConfig

All Implemented Interfaces:

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

public class SWConfig
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	SWConfig.StopWordsOnlyQueryAction
static class	SWConfig.StopWordsOnlyQueryReportMode

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_STOP_WORDS_ONLY_QUERY_ACTION
static java.lang.String	DEFAULT_STOP_WORDS_ONLY_QUERY_REPORT_MODE
java.lang.String	stopWordsOnlyQueryAction
java.lang.String	stopWordsOnlyQueryReportMode
java.util.List<SWList>	sWList

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this SWConfig.
static SWConfig	fromString(java.lang.String s) String representation of this SWConfig.
java.lang.String	getStopWordsOnlyQueryAction() What to do when a query contains only stop words.
SWConfig.StopWordsOnlyQueryAction	getStopWordsOnlyQueryActionAsEnum() What to do when a query contains only stop words.
java.lang.String	getStopWordsOnlyQueryReportMode() Specifies how to report a stop-word only 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.
SWConfig.StopWordsOnlyQueryReportMode	getStopWordsOnlyQueryReportModeAsEnum() Specifies how to report a stop-word only 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.util.List<SWList>	getSWList()
static boolean	isA(java.lang.String str, SWConfig.StopWordsOnlyQueryAction item)
static boolean	isA(java.lang.String str, SWConfig.StopWordsOnlyQueryReportMode item)
static boolean	isOneOf(java.lang.String str, SWConfig.StopWordsOnlyQueryAction... items)
static boolean	isOneOf(java.lang.String str, SWConfig.StopWordsOnlyQueryReportMode... items)
SWConfig	makeCopy() Creates and returns a deep copy of this SWConfig.
static SWConfig	readFrom(java.io.InputStream is) Read this SWConfig from an XML fragment.
void	setStopWordsOnlyQueryAction(java.lang.String stopWordsOnlyQueryAction) What to do when a query contains only stop words.
void	setStopWordsOnlyQueryAction(SWConfig.StopWordsOnlyQueryAction item) What to do when a query contains only stop words.
void	setStopWordsOnlyQueryReportMode(java.lang.String stopWordsOnlyQueryReportMode) Specifies how to report a stop-word only 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	setStopWordsOnlyQueryReportMode(SWConfig.StopWordsOnlyQueryReportMode item) Specifies how to report a stop-word only 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 SWConfig.
SWConfig	withStopWordsOnlyQueryAction(java.lang.String stopWordsOnlyQueryAction)
SWConfig	withStopWordsOnlyQueryReportMode(java.lang.String stopWordsOnlyQueryReportMode)
SWConfig	withSWList(java.util.Collection<SWList> __values)
SWConfig	withSWList(SWList... __values)
void	writeTo(java.io.OutputStream os) Write this SWConfig as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

sWList

public java.util.List<SWList> sWList

stopWordsOnlyQueryAction

public java.lang.String stopWordsOnlyQueryAction

DEFAULT_STOP_WORDS_ONLY_QUERY_ACTION

public static final java.lang.String DEFAULT_STOP_WORDS_ONLY_QUERY_ACTION

See Also:

Constant Field Values

stopWordsOnlyQueryReportMode

public java.lang.String stopWordsOnlyQueryReportMode

DEFAULT_STOP_WORDS_ONLY_QUERY_REPORT_MODE

public static final java.lang.String DEFAULT_STOP_WORDS_ONLY_QUERY_REPORT_MODE

See Also:

Constant Field Values

Constructor Detail

SWConfig

public SWConfig()

SWConfig

public SWConfig(SWConfig o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          SWConfig.StopWordsOnlyQueryAction item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              SWConfig.StopWordsOnlyQueryAction... items)

setStopWordsOnlyQueryAction

public void setStopWordsOnlyQueryAction(SWConfig.StopWordsOnlyQueryAction item)

What to do when a query contains only stop words. One of:

• "perform": Performs the full query.
• "error": Sends an error.
• "empty": Sends an empty answer.

getStopWordsOnlyQueryActionAsEnum

public SWConfig.StopWordsOnlyQueryAction getStopWordsOnlyQueryActionAsEnum()

What to do when a query contains only stop words. One of:

• "perform": Performs the full query.
• "error": Sends an error.
• "empty": Sends an empty answer.

isA

public static boolean isA(java.lang.String str,
                          SWConfig.StopWordsOnlyQueryReportMode item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              SWConfig.StopWordsOnlyQueryReportMode... items)

setStopWordsOnlyQueryReportMode

public void setStopWordsOnlyQueryReportMode(SWConfig.StopWordsOnlyQueryReportMode item)

Specifies how to report a stop-word only 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.

getStopWordsOnlyQueryReportModeAsEnum

public SWConfig.StopWordsOnlyQueryReportMode getStopWordsOnlyQueryReportModeAsEnum()

Specifies how to report a stop-word only 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.

getSWList

public java.util.List<SWList> getSWList()

withSWList

public SWConfig withSWList(SWList... __values)

withSWList

public SWConfig withSWList(java.util.Collection<SWList> __values)

setStopWordsOnlyQueryAction

public void setStopWordsOnlyQueryAction(java.lang.String stopWordsOnlyQueryAction)

What to do when a query contains only stop words. One of:

• "perform": Performs the full query.
• "error": Sends an error.
• "empty": Sends an empty answer.

getStopWordsOnlyQueryAction

public java.lang.String getStopWordsOnlyQueryAction()

What to do when a query contains only stop words. One of:

• "perform": Performs the full query.
• "error": Sends an error.
• "empty": Sends an empty answer.

withStopWordsOnlyQueryAction

public SWConfig withStopWordsOnlyQueryAction(java.lang.String stopWordsOnlyQueryAction)

setStopWordsOnlyQueryReportMode

public void setStopWordsOnlyQueryReportMode(java.lang.String stopWordsOnlyQueryReportMode)

Specifies how to report a stop-word only 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.

getStopWordsOnlyQueryReportMode

public java.lang.String getStopWordsOnlyQueryReportMode()

Specifies how to report a stop-word only 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.

withStopWordsOnlyQueryReportMode

public SWConfig withStopWordsOnlyQueryReportMode(java.lang.String stopWordsOnlyQueryReportMode)

makeCopy

public SWConfig makeCopy()

Creates and returns a deep copy of this SWConfig.

readFrom

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

Read this SWConfig 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 SWConfig as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this SWConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SWConfig.

Overrides:

toString in class java.lang.Object

check

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

Checks this SWConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException