SuggestCommand (NETVIBES Exalead CloudView Clients SDK)

java.lang.Object
- com.exalead.mercury.mami.search.v20.Command
- - com.exalead.mercury.mami.search.v20.SuggestCommand

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable
```
public class SuggestCommand
extends Command
implements com.exalead.util.Checkable, java.io.Serializable
```
Search API command

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class com.exalead.mercury.mami.search.v20.Command
  Command.Transformer<T>, Command.Visitor

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`autocomplete`
`static boolean`	`DEFAULT_AUTOCOMPLETE`
`static boolean`	`DEFAULT_RECURSIVE`
`boolean`	`recursive`
`java.lang.String`	`targetReporting`
`java.lang.String`	`tokenizationConfig`

Fields inherited from class com.exalead.mercury.mami.search.v20.Command
base, DEFAULT_BASE

Constructor Summary

Constructors
Constructor and Description

SuggestCommand()

SuggestCommand(SuggestCommand o)
Copy constructor

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T> T`	`accept(Command.Transformer<T> transformer, T[] t)`
`void`	`accept(Command.Visitor visitor)`
`void`	`check(boolean deep, java.lang.String errorContext)` Checks this SuggestCommand.
`static SuggestCommand`	`fromString(java.lang.String s)` String representation of this SuggestCommand.
`java.lang.String`	`getTargetReporting()`
`java.lang.String`	`getTokenizationConfig()` Tokenization config name used to parse the query.
`boolean`	`isAutocomplete()` Appends suggest results to the last query word being typed in the search field to autocomplete it. It only works with a suggest built with the Subexpr matching or Substring matching build options.
`boolean`	`isRecursive()` Discards the leftmost word of the query progressively. It sends each new subquery to the suggest(s) until the max number of suggestions is reached, or until there is no more word to use. For example, for a query "A B C", the suggest will be called 3 times, with "A B C", "B C", and "C".
`SuggestCommand`	`makeCopy()` Creates and returns a deep copy of this SuggestCommand.
`static SuggestCommand`	`readFrom(java.io.InputStream is)` Read this SuggestCommand from an XML fragment.
`void`	`setAutocomplete(boolean autocomplete)` Appends suggest results to the last query word being typed in the search field to autocomplete it. It only works with a suggest built with the Subexpr matching or Substring matching build options.
`void`	`setRecursive(boolean recursive)` Discards the leftmost word of the query progressively. It sends each new subquery to the suggest(s) until the max number of suggestions is reached, or until there is no more word to use. For example, for a query "A B C", the suggest will be called 3 times, with "A B C", "B C", and "C".
`void`	`setTargetReporting(java.lang.String targetReporting)`
`void`	`setTokenizationConfig(java.lang.String tokenizationConfig)` Tokenization config name used to parse the query.
`java.lang.String`	`toString()` String representation of this SuggestCommand.
`SuggestCommand`	`withAutocomplete(boolean autocomplete)`
`SuggestCommand`	`withAutocomplete(java.lang.Boolean autocomplete)`
`SuggestCommand`	`withBase(java.lang.String base)`
`SuggestCommand`	`withRecursive(boolean recursive)`
`SuggestCommand`	`withRecursive(java.lang.Boolean recursive)`
`SuggestCommand`	`withTargetReporting(java.lang.String targetReporting)`
`SuggestCommand`	`withTokenizationConfig(java.lang.String tokenizationConfig)`
`void`	`writeTo(java.io.OutputStream os)` Write this SuggestCommand as an XML fragment

Methods inherited from class com.exalead.mercury.mami.search.v20.Command
getBase, setBase

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

- Field Detail
  - targetReporting
```
public java.lang.String targetReporting
```
  - tokenizationConfig
```
public java.lang.String tokenizationConfig
```
  - 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
- Constructor Detail
  - SuggestCommand
```
public SuggestCommand()
```
  - SuggestCommand
```
public SuggestCommand(SuggestCommand o)
```
    Copy constructor
- Method Detail
  - withBase
```
public SuggestCommand withBase(java.lang.String base)
```
    Overrides:
    
    withBase in class Command
  - setTargetReporting
```
public void setTargetReporting(java.lang.String targetReporting)
```
  - getTargetReporting
```
public java.lang.String getTargetReporting()
```
  - withTargetReporting
```
public SuggestCommand withTargetReporting(java.lang.String targetReporting)
```
  - setTokenizationConfig
```
public void setTokenizationConfig(java.lang.String tokenizationConfig)
```
    Tokenization config name
    used to parse the query.
  - getTokenizationConfig
```
public java.lang.String getTokenizationConfig()
```
    Tokenization config name
    used to parse the query.
  - withTokenizationConfig
```
public SuggestCommand withTokenizationConfig(java.lang.String tokenizationConfig)
```
  - setAutocomplete
```
public void setAutocomplete(boolean autocomplete)
```
    Appends suggest results to the last query word being typed in the search field to autocomplete it.
    It only works with a suggest built with the Subexpr matching or Substring matching build options.
  - isAutocomplete
```
public boolean isAutocomplete()
```
    Appends suggest results to the last query word being typed in the search field to autocomplete it.
    It only works with a suggest built with the Subexpr matching or Substring matching build options.
  - withAutocomplete
```
public SuggestCommand withAutocomplete(boolean autocomplete)
```
  - withAutocomplete
```
public SuggestCommand withAutocomplete(java.lang.Boolean autocomplete)
```
  - setRecursive
```
public void setRecursive(boolean recursive)
```
    Discards the leftmost word of the query progressively.
    It sends each new subquery to the suggest(s) until the max number of suggestions is reached, or until there is no more word to use.
    For example, for a query "A B C", the suggest 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.
    It sends each new subquery to the suggest(s) until the max number of suggestions is reached, or until there is no more word to use.
    For example, for a query "A B C", the suggest will be called 3 times, with "A B C", "B C", and "C".
  - withRecursive
```
public SuggestCommand withRecursive(boolean recursive)
```
  - withRecursive
```
public SuggestCommand withRecursive(java.lang.Boolean recursive)
```
  - makeCopy
```
public SuggestCommand makeCopy()
```
    Creates and returns a deep copy of this SuggestCommand.
    
    Overrides:
    
    makeCopy in class Command
  - readFrom
```
public static SuggestCommand readFrom(java.io.InputStream is)
                               throws javax.xml.bind.JAXBException
```
    Read this SuggestCommand 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 SuggestCommand as an XML fragment
    
    Overrides:
    
    writeTo in class Command
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.IOException
  - fromString
```
public static SuggestCommand fromString(java.lang.String s)
                                 throws javax.xml.bind.JAXBException,
                                        java.io.UnsupportedEncodingException
```
    String representation of this SuggestCommand.
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.UnsupportedEncodingException
  - toString
```
public java.lang.String toString()
```
    String representation of this SuggestCommand.
    
    Overrides:
    
    toString in class Command
  - check
```
public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException
```
    Checks this SuggestCommand.
    
    Specified by:
    
    check in interface com.exalead.util.Checkable
    
    Overrides:
    
    check in class Command
    
    Throws:
    
    com.exalead.util.TypedException
  - accept
```
public void accept(Command.Visitor visitor)
            throws com.exalead.util.TypedException
```
    Specified by:
    
    accept in class Command
    
    Throws:
    
    com.exalead.util.TypedException
  - accept
```
public <T> T accept(Command.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException
```
    Specified by:
    
    accept in class Command
    
    Throws:
    
    com.exalead.util.TypedException

Class SuggestCommand

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.mercury.mami.search.v20.Command

Field Summary

Fields inherited from class com.exalead.mercury.mami.search.v20.Command

Constructor Summary

Method Summary

Methods inherited from class com.exalead.mercury.mami.search.v20.Command

Methods inherited from class java.lang.Object

Field Detail

targetReporting

tokenizationConfig

autocomplete

DEFAULT_AUTOCOMPLETE

recursive

DEFAULT_RECURSIVE

Constructor Detail

SuggestCommand

SuggestCommand

Method Detail

withBase

setTargetReporting

getTargetReporting

withTargetReporting

setTokenizationConfig

getTokenizationConfig

withTokenizationConfig

setAutocomplete

isAutocomplete

withAutocomplete

withAutocomplete

setRecursive

isRecursive

withRecursive

withRecursive

makeCopy

readFrom

writeTo

fromString

toString

check

accept

accept