com.exalead.mercury.mami.search.v20

Class OperatorCountRestrictionConfig

java.lang.Object

com.exalead.mercury.mami.search.v20.OperatorCountRestrictionConfig

All Implemented Interfaces:

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

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

Configure operator count restriction policy for search queries

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OperatorCountRestrictionConfig.Action

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	action
static java.lang.String	DEFAULT_ACTION
static int	DEFAULT_MAXIMUM_OPERATOR_COUNT
static int	DEFAULT_MAXIMUM_PROXIMITY_OPERATOR_COUNT
int	maximumOperatorCount
int	maximumProximityOperatorCount

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this OperatorCountRestrictionConfig.
static OperatorCountRestrictionConfig	fromString(java.lang.String s) String representation of this OperatorCountRestrictionConfig.
java.lang.String	getAction() Action when maximumOperatorCount is reached: drop query or remove extra operators. The 'cleanup' mode does not guarantee the order in which extra operators are discarded.
OperatorCountRestrictionConfig.Action	getActionAsEnum() Action when maximumOperatorCount is reached: drop query or remove extra operators. The 'cleanup' mode does not guarantee the order in which extra operators are discarded.
int	getMaximumOperatorCount() Maximum number of operators allowed in a query.
int	getMaximumProximityOperatorCount() Maximum number of proximity operators allowed in a query. The proximity operators are: NEAR NEXT AFTER BEFORE
static boolean	isA(java.lang.String str, OperatorCountRestrictionConfig.Action item)
static boolean	isOneOf(java.lang.String str, OperatorCountRestrictionConfig.Action... items)
OperatorCountRestrictionConfig	makeCopy() Creates and returns a deep copy of this OperatorCountRestrictionConfig.
static OperatorCountRestrictionConfig	readFrom(java.io.InputStream is) Read this OperatorCountRestrictionConfig from an XML fragment.
void	setAction(OperatorCountRestrictionConfig.Action item) Action when maximumOperatorCount is reached: drop query or remove extra operators. The 'cleanup' mode does not guarantee the order in which extra operators are discarded.
void	setAction(java.lang.String action) Action when maximumOperatorCount is reached: drop query or remove extra operators. The 'cleanup' mode does not guarantee the order in which extra operators are discarded.
void	setMaximumOperatorCount(int maximumOperatorCount) Maximum number of operators allowed in a query.
void	setMaximumProximityOperatorCount(int maximumProximityOperatorCount) Maximum number of proximity operators allowed in a query. The proximity operators are: NEAR NEXT AFTER BEFORE
java.lang.String	toString() String representation of this OperatorCountRestrictionConfig.
OperatorCountRestrictionConfig	withAction(java.lang.String action)
OperatorCountRestrictionConfig	withMaximumOperatorCount(int maximumOperatorCount)
OperatorCountRestrictionConfig	withMaximumOperatorCount(java.lang.Integer maximumOperatorCount)
OperatorCountRestrictionConfig	withMaximumProximityOperatorCount(int maximumProximityOperatorCount)
OperatorCountRestrictionConfig	withMaximumProximityOperatorCount(java.lang.Integer maximumProximityOperatorCount)
void	writeTo(java.io.OutputStream os) Write this OperatorCountRestrictionConfig as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

maximumOperatorCount

public int maximumOperatorCount

DEFAULT_MAXIMUM_OPERATOR_COUNT

public static final int DEFAULT_MAXIMUM_OPERATOR_COUNT

See Also:

Constant Field Values

maximumProximityOperatorCount

public int maximumProximityOperatorCount

DEFAULT_MAXIMUM_PROXIMITY_OPERATOR_COUNT

public static final int DEFAULT_MAXIMUM_PROXIMITY_OPERATOR_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

OperatorCountRestrictionConfig

public OperatorCountRestrictionConfig()

OperatorCountRestrictionConfig

public OperatorCountRestrictionConfig(OperatorCountRestrictionConfig o)

Copy constructor

Method Detail

isA

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

isOneOf

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

setAction

public void setAction(OperatorCountRestrictionConfig.Action item)

Action when maximumOperatorCount is reached: drop query or remove extra operators.
The 'cleanup' mode does not guarantee the order in which extra operators are discarded.

getActionAsEnum

public OperatorCountRestrictionConfig.Action getActionAsEnum()

Action when maximumOperatorCount is reached: drop query or remove extra operators.
The 'cleanup' mode does not guarantee the order in which extra operators are discarded.

setMaximumOperatorCount

public void setMaximumOperatorCount(int maximumOperatorCount)

Maximum number of operators allowed in a query.

getMaximumOperatorCount

public int getMaximumOperatorCount()

Maximum number of operators allowed in a query.

withMaximumOperatorCount

public OperatorCountRestrictionConfig withMaximumOperatorCount(int maximumOperatorCount)

withMaximumOperatorCount

public OperatorCountRestrictionConfig withMaximumOperatorCount(java.lang.Integer maximumOperatorCount)

setMaximumProximityOperatorCount

public void setMaximumProximityOperatorCount(int maximumProximityOperatorCount)

Maximum number of proximity operators allowed in a query.
The proximity operators are: NEAR NEXT AFTER BEFORE

getMaximumProximityOperatorCount

public int getMaximumProximityOperatorCount()

Maximum number of proximity operators allowed in a query.
The proximity operators are: NEAR NEXT AFTER BEFORE

withMaximumProximityOperatorCount

public OperatorCountRestrictionConfig withMaximumProximityOperatorCount(int maximumProximityOperatorCount)

withMaximumProximityOperatorCount

public OperatorCountRestrictionConfig withMaximumProximityOperatorCount(java.lang.Integer maximumProximityOperatorCount)

setAction

public void setAction(java.lang.String action)

Action when maximumOperatorCount is reached: drop query or remove extra operators.
The 'cleanup' mode does not guarantee the order in which extra operators are discarded.

getAction

public java.lang.String getAction()

Action when maximumOperatorCount is reached: drop query or remove extra operators.
The 'cleanup' mode does not guarantee the order in which extra operators are discarded.

withAction

public OperatorCountRestrictionConfig withAction(java.lang.String action)

makeCopy

public OperatorCountRestrictionConfig makeCopy()

Creates and returns a deep copy of this OperatorCountRestrictionConfig.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this OperatorCountRestrictionConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this OperatorCountRestrictionConfig.

Overrides:

toString in class java.lang.Object

check

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

Checks this OperatorCountRestrictionConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException