com.exalead.mercury.mami.search.v20

Class QueryTermCountRestrictionConfig

java.lang.Object

com.exalead.mercury.mami.search.v20.QueryTermCountRestrictionConfig

All Implemented Interfaces:

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

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

Configure term count restriction policy for search queries

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryTermCountRestrictionConfig.Action

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	action
static java.lang.String	DEFAULT_ACTION
static int	DEFAULT_MAXIMUM_TERM_COUNT
int	maximumTermCount

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this QueryTermCountRestrictionConfig.
static QueryTermCountRestrictionConfig	fromString(java.lang.String s) String representation of this QueryTermCountRestrictionConfig.
java.lang.String	getAction() Action if maximumTermCount is reached: drop query or cleanup extra values.
QueryTermCountRestrictionConfig.Action	getActionAsEnum() Action if maximumTermCount is reached: drop query or cleanup extra values.
int	getMaximumTermCount() Maximum number of alphanumeric tokens allowed in a query.
static boolean	isA(java.lang.String str, QueryTermCountRestrictionConfig.Action item)
static boolean	isOneOf(java.lang.String str, QueryTermCountRestrictionConfig.Action... items)
QueryTermCountRestrictionConfig	makeCopy() Creates and returns a deep copy of this QueryTermCountRestrictionConfig.
static QueryTermCountRestrictionConfig	readFrom(java.io.InputStream is) Read this QueryTermCountRestrictionConfig from an XML fragment.
void	setAction(QueryTermCountRestrictionConfig.Action item) Action if maximumTermCount is reached: drop query or cleanup extra values.
void	setAction(java.lang.String action) Action if maximumTermCount is reached: drop query or cleanup extra values.
void	setMaximumTermCount(int maximumTermCount) Maximum number of alphanumeric tokens allowed in a query.
java.lang.String	toString() String representation of this QueryTermCountRestrictionConfig.
QueryTermCountRestrictionConfig	withAction(java.lang.String action)
QueryTermCountRestrictionConfig	withMaximumTermCount(int maximumTermCount)
QueryTermCountRestrictionConfig	withMaximumTermCount(java.lang.Integer maximumTermCount)
void	writeTo(java.io.OutputStream os) Write this QueryTermCountRestrictionConfig as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

maximumTermCount

public int maximumTermCount

DEFAULT_MAXIMUM_TERM_COUNT

public static final int DEFAULT_MAXIMUM_TERM_COUNT

See Also:

Constant Field Values

action

public java.lang.String action

DEFAULT_ACTION

public static final java.lang.String DEFAULT_ACTION

See Also:

Constant Field Values

Constructor Detail

QueryTermCountRestrictionConfig

public QueryTermCountRestrictionConfig()

QueryTermCountRestrictionConfig

public QueryTermCountRestrictionConfig(QueryTermCountRestrictionConfig o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          QueryTermCountRestrictionConfig.Action item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              QueryTermCountRestrictionConfig.Action... items)

setAction

public void setAction(QueryTermCountRestrictionConfig.Action item)

Action if maximumTermCount is reached: drop query or cleanup extra values.

getActionAsEnum

public QueryTermCountRestrictionConfig.Action getActionAsEnum()

Action if maximumTermCount is reached: drop query or cleanup extra values.

setMaximumTermCount

public void setMaximumTermCount(int maximumTermCount)

Maximum number of alphanumeric tokens allowed in a query.

getMaximumTermCount

public int getMaximumTermCount()

Maximum number of alphanumeric tokens allowed in a query.

withMaximumTermCount

public QueryTermCountRestrictionConfig withMaximumTermCount(int maximumTermCount)

withMaximumTermCount

public QueryTermCountRestrictionConfig withMaximumTermCount(java.lang.Integer maximumTermCount)

setAction

public void setAction(java.lang.String action)

Action if maximumTermCount is reached: drop query or cleanup extra values.

getAction

public java.lang.String getAction()

Action if maximumTermCount is reached: drop query or cleanup extra values.

withAction

public QueryTermCountRestrictionConfig withAction(java.lang.String action)

makeCopy

public QueryTermCountRestrictionConfig makeCopy()

Creates and returns a deep copy of this QueryTermCountRestrictionConfig.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this QueryTermCountRestrictionConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this QueryTermCountRestrictionConfig.

Overrides:

toString in class java.lang.Object

check

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

Checks this QueryTermCountRestrictionConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException