SuggestQueryConfig (NETVIBES Exalead CloudView Clients SDK)

java.lang.Object
- com.exalead.mercury.mami.search.v20.SuggestQueryConfig

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable
```
public class SuggestQueryConfig
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable
```
Defines default suggest-time options

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`autocomplete`
`static boolean`	`DEFAULT_AUTOCOMPLETE`
`static int`	`DEFAULT_DISTANCE`
`static int`	`DEFAULT_MIN_LENGTH_FOR_DISTANCE1`
`static int`	`DEFAULT_MIN_LENGTH_FOR_DISTANCE2`
`static boolean`	`DEFAULT_RECURSIVE`
`static int`	`DEFAULT_SECURE_SUGGEST_TIMEOUT_M_S`
`int`	`distance`
`int`	`minLengthForDistance1`
`int`	`minLengthForDistance2`
`boolean`	`recursive`
`int`	`secureSuggestTimeoutMS`

Constructor Summary

Constructors
Constructor and Description

SuggestQueryConfig()

SuggestQueryConfig(SuggestQueryConfig o)
Copy constructor

Constructors
Constructor and Description
`SuggestQueryConfig()`
`SuggestQueryConfig(SuggestQueryConfig o)` Copy constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`check(boolean deep, java.lang.String errorContext)` Checks this SuggestQueryConfig.
`static SuggestQueryConfig`	`fromString(java.lang.String s)` String representation of this SuggestQueryConfig.
`int`	`getDistance()` Allows approximate matching.
`int`	`getMinLengthForDistance1()` Only searches for distance 1 fuzzy matches if the original word in the query is at least N characters long. This avoids too much approximation on very short words. The default value is 3.
`int`	`getMinLengthForDistance2()` Only searches for distance 2 fuzzy matches if the original word in the query is at least N characters long. This avoids too much approximation on very short words. The default value is 6.
`int`	`getSecureSuggestTimeoutMS()` Aborts matching in a secure suggest when this time limit is reached.
`boolean`	`isAutocomplete()` Only works with a suggest built with subString or subExpr options. If set, the query is not replaced by the suggest results, instead, the results are appended to the query being typed in order to auto complete it.
`boolean`	`isRecursive()` Discards the leftmost word of the query progressively.
`SuggestQueryConfig`	`makeCopy()` Creates and returns a deep copy of this SuggestQueryConfig.
`static SuggestQueryConfig`	`readFrom(java.io.InputStream is)` Read this SuggestQueryConfig from an XML fragment.
`void`	`setAutocomplete(boolean autocomplete)` Only works with a suggest built with subString or subExpr options. If set, the query is not replaced by the suggest results, instead, the results are appended to the query being typed in order to auto complete it.
`void`	`setDistance(int distance)` Allows approximate matching.
`void`	`setMinLengthForDistance1(int minLengthForDistance1)` Only searches for distance 1 fuzzy matches if the original word in the query is at least N characters long. This avoids too much approximation on very short words. The default value is 3.
`void`	`setMinLengthForDistance2(int minLengthForDistance2)` Only searches for distance 2 fuzzy matches if the original word in the query is at least N characters long. This avoids too much approximation on very short words. The default value is 6.
`void`	`setRecursive(boolean recursive)` Discards the leftmost word of the query progressively.
`void`	`setSecureSuggestTimeoutMS(int secureSuggestTimeoutMS)` Aborts matching in a secure suggest when this time limit is reached.
`java.lang.String`	`toString()` String representation of this SuggestQueryConfig.
`SuggestQueryConfig`	`withAutocomplete(boolean autocomplete)`
`SuggestQueryConfig`	`withAutocomplete(java.lang.Boolean autocomplete)`
`SuggestQueryConfig`	`withDistance(int distance)`
`SuggestQueryConfig`	`withDistance(java.lang.Integer distance)`
`SuggestQueryConfig`	`withMinLengthForDistance1(int minLengthForDistance1)`
`SuggestQueryConfig`	`withMinLengthForDistance1(java.lang.Integer minLengthForDistance1)`
`SuggestQueryConfig`	`withMinLengthForDistance2(int minLengthForDistance2)`
`SuggestQueryConfig`	`withMinLengthForDistance2(java.lang.Integer minLengthForDistance2)`
`SuggestQueryConfig`	`withRecursive(boolean recursive)`
`SuggestQueryConfig`	`withRecursive(java.lang.Boolean recursive)`
`SuggestQueryConfig`	`withSecureSuggestTimeoutMS(int secureSuggestTimeoutMS)`
`SuggestQueryConfig`	`withSecureSuggestTimeoutMS(java.lang.Integer secureSuggestTimeoutMS)`
`void`	`writeTo(java.io.OutputStream os)` Write this SuggestQueryConfig as an XML fragment

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - distance
```
public int distance
```
  - DEFAULT_DISTANCE
```
public static final int DEFAULT_DISTANCE
```
    See Also:
    
    Constant Field Values
  - minLengthForDistance1
```
public int minLengthForDistance1
```
  - DEFAULT_MIN_LENGTH_FOR_DISTANCE1
```
public static final int DEFAULT_MIN_LENGTH_FOR_DISTANCE1
```
    See Also:
    
    Constant Field Values
  - minLengthForDistance2
```
public int minLengthForDistance2
```
  - DEFAULT_MIN_LENGTH_FOR_DISTANCE2
```
public static final int DEFAULT_MIN_LENGTH_FOR_DISTANCE2
```
    See Also:
    
    Constant Field Values
  - autocomplete
```
public boolean autocomplete
```
  - DEFAULT_AUTOCOMPLETE
```
public static final boolean DEFAULT_AUTOCOMPLETE
```
    See Also:
    
    Constant Field Values
  - recursive
```
public boolean recursive
```
  - DEFAULT_RECURSIVE
```
public static final boolean DEFAULT_RECURSIVE
```
    See Also:
    
    Constant Field Values
  - secureSuggestTimeoutMS
```
public int secureSuggestTimeoutMS
```
  - DEFAULT_SECURE_SUGGEST_TIMEOUT_M_S
```
public static final int DEFAULT_SECURE_SUGGEST_TIMEOUT_M_S
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SuggestQueryConfig
```
public SuggestQueryConfig()
```
  - SuggestQueryConfig
```
public SuggestQueryConfig(SuggestQueryConfig o)
```
    Copy constructor
- Method Detail
  - setDistance
```
public void setDistance(int distance)
```
    Allows approximate matching. The higher the distance the more approximate the match.
    0 for exact match.
  - getDistance
```
public int getDistance()
```
    Allows approximate matching. The higher the distance the more approximate the match.
    0 for exact match.
  - withDistance
```
public SuggestQueryConfig withDistance(int distance)
```
  - withDistance
```
public SuggestQueryConfig withDistance(java.lang.Integer distance)
```
  - setMinLengthForDistance1
```
public void setMinLengthForDistance1(int minLengthForDistance1)
```
    Only searches for distance 1 fuzzy matches if the original word in the query is at least N characters long.
    This avoids too much approximation on very short words.
    The default value is 3.
  - getMinLengthForDistance1
```
public int getMinLengthForDistance1()
```
    Only searches for distance 1 fuzzy matches if the original word in the query is at least N characters long.
    This avoids too much approximation on very short words.
    The default value is 3.
  - withMinLengthForDistance1
```
public SuggestQueryConfig withMinLengthForDistance1(int minLengthForDistance1)
```
  - withMinLengthForDistance1
```
public SuggestQueryConfig withMinLengthForDistance1(java.lang.Integer minLengthForDistance1)
```
  - setMinLengthForDistance2
```
public void setMinLengthForDistance2(int minLengthForDistance2)
```
    Only searches for distance 2 fuzzy matches if the original word in the query is at least N characters long.
    This avoids too much approximation on very short words.
    The default value is 6.
  - getMinLengthForDistance2
```
public int getMinLengthForDistance2()
```
    Only searches for distance 2 fuzzy matches if the original word in the query is at least N characters long.
    This avoids too much approximation on very short words.
    The default value is 6.
  - withMinLengthForDistance2
```
public SuggestQueryConfig withMinLengthForDistance2(int minLengthForDistance2)
```
  - withMinLengthForDistance2
```
public SuggestQueryConfig withMinLengthForDistance2(java.lang.Integer minLengthForDistance2)
```
  - setAutocomplete
```
public void setAutocomplete(boolean autocomplete)
```
    Only works with a suggest built with subString or subExpr options.
    If set, the query is not replaced by the suggest results, instead, the results are appended to the query being typed in order to auto complete it.
  - isAutocomplete
```
public boolean isAutocomplete()
```
    Only works with a suggest built with subString or subExpr options.
    If set, the query is not replaced by the suggest results, instead, the results are appended to the query being typed in order to auto complete it.
  - withAutocomplete
```
public SuggestQueryConfig withAutocomplete(boolean autocomplete)
```
  - withAutocomplete
```
public SuggestQueryConfig withAutocomplete(java.lang.Boolean autocomplete)
```
  - setRecursive
```
public void setRecursive(boolean recursive)
```
    Discards the leftmost word of the query progressively. Each new subquery, is sent to the suggest(s), until maxSuggestions is reached, or until there is no more word to use.
    For example, for a query "A B C", the suggests will be called 3 times, with "A B C", "B C", and "C".
  - isRecursive
```
public boolean isRecursive()
```
    Discards the leftmost word of the query progressively. Each new subquery, is sent to the suggest(s), until maxSuggestions is reached, or until there is no more word to use.
    For example, for a query "A B C", the suggests will be called 3 times, with "A B C", "B C", and "C".
  - withRecursive
```
public SuggestQueryConfig withRecursive(boolean recursive)
```
  - withRecursive
```
public SuggestQueryConfig withRecursive(java.lang.Boolean recursive)
```
  - setSecureSuggestTimeoutMS
```
public void setSecureSuggestTimeoutMS(int secureSuggestTimeoutMS)
```
    Aborts matching in a secure suggest when this time limit is reached.
  - getSecureSuggestTimeoutMS
```
public int getSecureSuggestTimeoutMS()
```
    Aborts matching in a secure suggest when this time limit is reached.
  - withSecureSuggestTimeoutMS
```
public SuggestQueryConfig withSecureSuggestTimeoutMS(int secureSuggestTimeoutMS)
```
  - withSecureSuggestTimeoutMS
```
public SuggestQueryConfig withSecureSuggestTimeoutMS(java.lang.Integer secureSuggestTimeoutMS)
```
  - makeCopy
```
public SuggestQueryConfig makeCopy()
```
    Creates and returns a deep copy of this SuggestQueryConfig.
  - readFrom
```
public static SuggestQueryConfig readFrom(java.io.InputStream is)
                                   throws javax.xml.bind.JAXBException
```
    Read this SuggestQueryConfig 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 SuggestQueryConfig as an XML fragment
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.IOException
  - fromString
```
public static SuggestQueryConfig fromString(java.lang.String s)
                                     throws javax.xml.bind.JAXBException,
                                            java.io.UnsupportedEncodingException
```
    String representation of this SuggestQueryConfig.
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.UnsupportedEncodingException
  - toString
```
public java.lang.String toString()
```
    String representation of this SuggestQueryConfig.
    
    Overrides:
    
    toString in class java.lang.Object
  - check
```
public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException
```
    Checks this SuggestQueryConfig.
    
    Specified by:
    
    check in interface com.exalead.util.Checkable
    
    Throws:
    
    com.exalead.util.TypedException

Class SuggestQueryConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

distance

DEFAULT_DISTANCE

minLengthForDistance1

DEFAULT_MIN_LENGTH_FOR_DISTANCE1

minLengthForDistance2

DEFAULT_MIN_LENGTH_FOR_DISTANCE2

autocomplete

DEFAULT_AUTOCOMPLETE

recursive

DEFAULT_RECURSIVE

secureSuggestTimeoutMS

DEFAULT_SECURE_SUGGEST_TIMEOUT_M_S

Constructor Detail

SuggestQueryConfig

SuggestQueryConfig

Method Detail

setDistance

getDistance

withDistance

withDistance

setMinLengthForDistance1

getMinLengthForDistance1

withMinLengthForDistance1

withMinLengthForDistance1

setMinLengthForDistance2

getMinLengthForDistance2

withMinLengthForDistance2

withMinLengthForDistance2

setAutocomplete

isAutocomplete

withAutocomplete

withAutocomplete

setRecursive

isRecursive

withRecursive

withRecursive

setSecureSuggestTimeoutMS

getSecureSuggestTimeoutMS

withSecureSuggestTimeoutMS

withSecureSuggestTimeoutMS

makeCopy

readFrom

writeTo

fromString

toString

check