SuggestBuildConfig (NETVIBES Exalead CloudView Clients SDK)

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

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable
```
public class SuggestBuildConfig
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable
```
Suggest build options

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SuggestBuildConfig.SecurityModel

Nested Classes
Modifier and Type	Class and Description
`static class`	`SuggestBuildConfig.SecurityModel`

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`buildAfterIndexImport`
`boolean`	`computePermutation`
`static boolean`	`DEFAULT_BUILD_AFTER_INDEX_IMPORT`
`static boolean`	`DEFAULT_COMPUTE_PERMUTATION`
`static int`	`DEFAULT_MAX_ENTRY_LENGTH`
`static int`	`DEFAULT_MAX_SUGGESTIONS`
`static int`	`DEFAULT_NB_URLS_PER_ENTRY`
`static boolean`	`DEFAULT_SANITIZE_ENTRIES`
`static boolean`	`DEFAULT_SECURE`
`static java.lang.String`	`DEFAULT_SECURITY_MODEL`
`static int`	`DEFAULT_SPLIT_N_GRAMS`
`static boolean`	`DEFAULT_SPLIT_SENTENCE`
`static boolean`	`DEFAULT_SUB_EXPR`
`static boolean`	`DEFAULT_SUB_STRING`
`int`	`maxEntryLength`
`int`	`maxSuggestions`
`int`	`nbUrlsPerEntry`
`boolean`	`sanitizeEntries`
`boolean`	`secure`
`java.lang.String`	`securityModel`
`int`	`splitNGrams`
`boolean`	`splitSentence`
`boolean`	`subExpr`
`boolean`	`subString`
`java.lang.String`	`tokenizationConfig`

Constructor Summary

Constructors
Constructor and Description

SuggestBuildConfig()

SuggestBuildConfig(SuggestBuildConfig o)
Copy constructor

Constructors
Constructor and Description
`SuggestBuildConfig()`
`SuggestBuildConfig(SuggestBuildConfig 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 SuggestBuildConfig.
`static SuggestBuildConfig`	`fromString(java.lang.String s)` String representation of this SuggestBuildConfig.
`int`	`getMaxEntryLength()` Maximum number of characters in a suggest entry. This is a security measure to prevent overly-long entries. They are automatically truncated after the specified length. 0 means no limit.
`int`	`getMaxSuggestions()` The maximum number of suggestions that can be shown to the user for a given input string. You cannot change this dynamically.
`int`	`getNbUrlsPerEntry()` Defines the maximum number of URL to be stored for each entry.
`java.lang.String`	`getSecurityModel()` Enables the enovia-specific handling of security tokens.
`SuggestBuildConfig.SecurityModel`	`getSecurityModelAsEnum()` Enables the enovia-specific handling of security tokens.
`int`	`getSplitNGrams()` Breaks up a suggest entry into several entries, and performs matches independently on the chunks. A sliding window of ngrams of a given size will be created, and an entry will be created for each step of the window. For example, "a b c d e f" with a split on 4-grams will give entries "a b c d", "b c d e" and "c d e f". 0 means no splitting. This action is performed after the sentence split if the Sentence split option is selected.
`java.lang.String`	`getTokenizationConfig()` Tokenization Config to use.
`static boolean`	`isA(java.lang.String str, SuggestBuildConfig.SecurityModel item)`
`boolean`	`isBuildAfterIndexImport()` Triggers a build automatically after the index refreshes.
`boolean`	`isComputePermutation()` Computes all permutations for an entry and adds them as separate entries. This action is performed after the sentence split if the Sentence split option is selected.
`static boolean`	`isOneOf(java.lang.String str, SuggestBuildConfig.SecurityModel... items)`
`boolean`	`isSanitizeEntries()` Strips the entry of punctuation, and encloses any UQL operator between quotes.
`boolean`	`isSecure()` Makes use of documents and users' security tokens to restrict suggestions.
`boolean`	`isSplitSentence()` Breaks up a suggest entry into several entries, and performs matches independently on the chunks. If the entry is multi-sentence, an entry will be created for each sentence.
`boolean`	`isSubExpr()` Finds matches on every start of word. For example, "first test" will be returned both for "fir" and for "tes".
`boolean`	`isSubString()` Finds matches on every letter. For example, "first test" will be returned for "fir", for "rs", for "es", ...
`SuggestBuildConfig`	`makeCopy()` Creates and returns a deep copy of this SuggestBuildConfig.
`static SuggestBuildConfig`	`readFrom(java.io.InputStream is)` Read this SuggestBuildConfig from an XML fragment.
`void`	`setBuildAfterIndexImport(boolean buildAfterIndexImport)` Triggers a build automatically after the index refreshes.
`void`	`setComputePermutation(boolean computePermutation)` Computes all permutations for an entry and adds them as separate entries. This action is performed after the sentence split if the Sentence split option is selected.
`void`	`setMaxEntryLength(int maxEntryLength)` Maximum number of characters in a suggest entry. This is a security measure to prevent overly-long entries. They are automatically truncated after the specified length. 0 means no limit.
`void`	`setMaxSuggestions(int maxSuggestions)` The maximum number of suggestions that can be shown to the user for a given input string. You cannot change this dynamically.
`void`	`setNbUrlsPerEntry(int nbUrlsPerEntry)` Defines the maximum number of URL to be stored for each entry.
`void`	`setSanitizeEntries(boolean sanitizeEntries)` Strips the entry of punctuation, and encloses any UQL operator between quotes.
`void`	`setSecure(boolean secure)` Makes use of documents and users' security tokens to restrict suggestions.
`void`	`setSecurityModel(java.lang.String securityModel)` Enables the enovia-specific handling of security tokens.
`void`	`setSecurityModel(SuggestBuildConfig.SecurityModel item)` Enables the enovia-specific handling of security tokens.
`void`	`setSplitNGrams(int splitNGrams)` Breaks up a suggest entry into several entries, and performs matches independently on the chunks. A sliding window of ngrams of a given size will be created, and an entry will be created for each step of the window. For example, "a b c d e f" with a split on 4-grams will give entries "a b c d", "b c d e" and "c d e f". 0 means no splitting. This action is performed after the sentence split if the Sentence split option is selected.
`void`	`setSplitSentence(boolean splitSentence)` Breaks up a suggest entry into several entries, and performs matches independently on the chunks. If the entry is multi-sentence, an entry will be created for each sentence.
`void`	`setSubExpr(boolean subExpr)` Finds matches on every start of word. For example, "first test" will be returned both for "fir" and for "tes".
`void`	`setSubString(boolean subString)` Finds matches on every letter. For example, "first test" will be returned for "fir", for "rs", for "es", ...
`void`	`setTokenizationConfig(java.lang.String tokenizationConfig)` Tokenization Config to use.
`java.lang.String`	`toString()` String representation of this SuggestBuildConfig.
`SuggestBuildConfig`	`withBuildAfterIndexImport(boolean buildAfterIndexImport)`
`SuggestBuildConfig`	`withBuildAfterIndexImport(java.lang.Boolean buildAfterIndexImport)`
`SuggestBuildConfig`	`withComputePermutation(boolean computePermutation)`
`SuggestBuildConfig`	`withComputePermutation(java.lang.Boolean computePermutation)`
`SuggestBuildConfig`	`withMaxEntryLength(int maxEntryLength)`
`SuggestBuildConfig`	`withMaxEntryLength(java.lang.Integer maxEntryLength)`
`SuggestBuildConfig`	`withMaxSuggestions(int maxSuggestions)`
`SuggestBuildConfig`	`withMaxSuggestions(java.lang.Integer maxSuggestions)`
`SuggestBuildConfig`	`withNbUrlsPerEntry(int nbUrlsPerEntry)`
`SuggestBuildConfig`	`withNbUrlsPerEntry(java.lang.Integer nbUrlsPerEntry)`
`SuggestBuildConfig`	`withSanitizeEntries(boolean sanitizeEntries)`
`SuggestBuildConfig`	`withSanitizeEntries(java.lang.Boolean sanitizeEntries)`
`SuggestBuildConfig`	`withSecure(boolean secure)`
`SuggestBuildConfig`	`withSecure(java.lang.Boolean secure)`
`SuggestBuildConfig`	`withSecurityModel(java.lang.String securityModel)`
`SuggestBuildConfig`	`withSplitNGrams(int splitNGrams)`
`SuggestBuildConfig`	`withSplitNGrams(java.lang.Integer splitNGrams)`
`SuggestBuildConfig`	`withSplitSentence(boolean splitSentence)`
`SuggestBuildConfig`	`withSplitSentence(java.lang.Boolean splitSentence)`
`SuggestBuildConfig`	`withSubExpr(boolean subExpr)`
`SuggestBuildConfig`	`withSubExpr(java.lang.Boolean subExpr)`
`SuggestBuildConfig`	`withSubString(boolean subString)`
`SuggestBuildConfig`	`withSubString(java.lang.Boolean subString)`
`SuggestBuildConfig`	`withTokenizationConfig(java.lang.String tokenizationConfig)`
`void`	`writeTo(java.io.OutputStream os)` Write this SuggestBuildConfig as an XML fragment

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

- Field Detail
  - subExpr
```
public boolean subExpr
```
  - DEFAULT_SUB_EXPR
```
public static final boolean DEFAULT_SUB_EXPR
```
    See Also:
    
    Constant Field Values
  - subString
```
public boolean subString
```
  - DEFAULT_SUB_STRING
```
public static final boolean DEFAULT_SUB_STRING
```
    See Also:
    
    Constant Field Values
  - splitSentence
```
public boolean splitSentence
```
  - DEFAULT_SPLIT_SENTENCE
```
public static final boolean DEFAULT_SPLIT_SENTENCE
```
    See Also:
    
    Constant Field Values
  - splitNGrams
```
public int splitNGrams
```
  - DEFAULT_SPLIT_N_GRAMS
```
public static final int DEFAULT_SPLIT_N_GRAMS
```
    See Also:
    
    Constant Field Values
  - computePermutation
```
public boolean computePermutation
```
  - DEFAULT_COMPUTE_PERMUTATION
```
public static final boolean DEFAULT_COMPUTE_PERMUTATION
```
    See Also:
    
    Constant Field Values
  - maxEntryLength
```
public int maxEntryLength
```
  - DEFAULT_MAX_ENTRY_LENGTH
```
public static final int DEFAULT_MAX_ENTRY_LENGTH
```
    See Also:
    
    Constant Field Values
  - maxSuggestions
```
public int maxSuggestions
```
  - DEFAULT_MAX_SUGGESTIONS
```
public static final int DEFAULT_MAX_SUGGESTIONS
```
    See Also:
    
    Constant Field Values
  - nbUrlsPerEntry
```
public int nbUrlsPerEntry
```
  - DEFAULT_NB_URLS_PER_ENTRY
```
public static final int DEFAULT_NB_URLS_PER_ENTRY
```
    See Also:
    
    Constant Field Values
  - tokenizationConfig
```
public java.lang.String tokenizationConfig
```
  - sanitizeEntries
```
public boolean sanitizeEntries
```
  - DEFAULT_SANITIZE_ENTRIES
```
public static final boolean DEFAULT_SANITIZE_ENTRIES
```
    See Also:
    
    Constant Field Values
  - buildAfterIndexImport
```
public boolean buildAfterIndexImport
```
  - DEFAULT_BUILD_AFTER_INDEX_IMPORT
```
public static final boolean DEFAULT_BUILD_AFTER_INDEX_IMPORT
```
    See Also:
    
    Constant Field Values
  - secure
```
public boolean secure
```
  - DEFAULT_SECURE
```
public static final boolean DEFAULT_SECURE
```
    See Also:
    
    Constant Field Values
  - securityModel
```
public java.lang.String securityModel
```
  - DEFAULT_SECURITY_MODEL
```
public static final java.lang.String DEFAULT_SECURITY_MODEL
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SuggestBuildConfig
```
public SuggestBuildConfig()
```
  - SuggestBuildConfig
```
public SuggestBuildConfig(SuggestBuildConfig o)
```
    Copy constructor
- Method Detail
  - isA
```
public static boolean isA(java.lang.String str,
                          SuggestBuildConfig.SecurityModel item)
```
  - isOneOf
```
public static boolean isOneOf(java.lang.String str,
                              SuggestBuildConfig.SecurityModel... items)
```
  - setSecurityModel
```
public void setSecurityModel(SuggestBuildConfig.SecurityModel item)
```
    Enables the enovia-specific handling of security tokens.
  - getSecurityModelAsEnum
```
public SuggestBuildConfig.SecurityModel getSecurityModelAsEnum()
```
    Enables the enovia-specific handling of security tokens.
  - setSubExpr
```
public void setSubExpr(boolean subExpr)
```
    Finds matches on every start of word.
    For example, "first test" will be returned both for "fir" and for "tes".
  - isSubExpr
```
public boolean isSubExpr()
```
    Finds matches on every start of word.
    For example, "first test" will be returned both for "fir" and for "tes".
  - withSubExpr
```
public SuggestBuildConfig withSubExpr(boolean subExpr)
```
  - withSubExpr
```
public SuggestBuildConfig withSubExpr(java.lang.Boolean subExpr)
```
  - setSubString
```
public void setSubString(boolean subString)
```
    Finds matches on every letter.
    For example, "first test" will be returned for "fir", for "rs", for "es", ...
  - isSubString
```
public boolean isSubString()
```
    Finds matches on every letter.
    For example, "first test" will be returned for "fir", for "rs", for "es", ...
  - withSubString
```
public SuggestBuildConfig withSubString(boolean subString)
```
  - withSubString
```
public SuggestBuildConfig withSubString(java.lang.Boolean subString)
```
  - setSplitSentence
```
public void setSplitSentence(boolean splitSentence)
```
    Breaks up a suggest entry into several entries, and performs matches independently on the chunks.
    If the entry is multi-sentence, an entry will be created for each sentence.
  - isSplitSentence
```
public boolean isSplitSentence()
```
    Breaks up a suggest entry into several entries, and performs matches independently on the chunks.
    If the entry is multi-sentence, an entry will be created for each sentence.
  - withSplitSentence
```
public SuggestBuildConfig withSplitSentence(boolean splitSentence)
```
  - withSplitSentence
```
public SuggestBuildConfig withSplitSentence(java.lang.Boolean splitSentence)
```
  - setSplitNGrams
```
public void setSplitNGrams(int splitNGrams)
```
    Breaks up a suggest entry into several entries, and performs matches independently on the chunks.
    A sliding window of ngrams of a given size will be created, and an entry will be created for each step of the window.
    For example, "a b c d e f" with a split on 4-grams will give entries "a b c d", "b c d e" and "c d e f".
    0 means no splitting.
    This action is performed after the sentence split if the Sentence split option is selected.
  - getSplitNGrams
```
public int getSplitNGrams()
```
    Breaks up a suggest entry into several entries, and performs matches independently on the chunks.
    A sliding window of ngrams of a given size will be created, and an entry will be created for each step of the window.
    For example, "a b c d e f" with a split on 4-grams will give entries "a b c d", "b c d e" and "c d e f".
    0 means no splitting.
    This action is performed after the sentence split if the Sentence split option is selected.
  - withSplitNGrams
```
public SuggestBuildConfig withSplitNGrams(int splitNGrams)
```
  - withSplitNGrams
```
public SuggestBuildConfig withSplitNGrams(java.lang.Integer splitNGrams)
```
  - setComputePermutation
```
public void setComputePermutation(boolean computePermutation)
```
    Computes all permutations for an entry and adds them as separate entries.
    This action is performed after the sentence split if the Sentence split option is selected. Note that entries longer than 8 words will not be permuted for performance reasons (would generate n! entries)
  - isComputePermutation
```
public boolean isComputePermutation()
```
    Computes all permutations for an entry and adds them as separate entries.
    This action is performed after the sentence split if the Sentence split option is selected. Note that entries longer than 8 words will not be permuted for performance reasons (would generate n! entries)
  - withComputePermutation
```
public SuggestBuildConfig withComputePermutation(boolean computePermutation)
```
  - withComputePermutation
```
public SuggestBuildConfig withComputePermutation(java.lang.Boolean computePermutation)
```
  - setMaxEntryLength
```
public void setMaxEntryLength(int maxEntryLength)
```
    Maximum number of characters in a suggest entry.
    This is a security measure to prevent overly-long entries.
    They are automatically truncated after the specified length.
    0 means no limit.
  - getMaxEntryLength
```
public int getMaxEntryLength()
```
    Maximum number of characters in a suggest entry.
    This is a security measure to prevent overly-long entries.
    They are automatically truncated after the specified length.
    0 means no limit.
  - withMaxEntryLength
```
public SuggestBuildConfig withMaxEntryLength(int maxEntryLength)
```
  - withMaxEntryLength
```
public SuggestBuildConfig withMaxEntryLength(java.lang.Integer maxEntryLength)
```
  - setMaxSuggestions
```
public void setMaxSuggestions(int maxSuggestions)
```
    The maximum number of suggestions that can be shown to the user for a given input string.
    You cannot change this dynamically.
  - getMaxSuggestions
```
public int getMaxSuggestions()
```
    The maximum number of suggestions that can be shown to the user for a given input string.
    You cannot change this dynamically.
  - withMaxSuggestions
```
public SuggestBuildConfig withMaxSuggestions(int maxSuggestions)
```
  - withMaxSuggestions
```
public SuggestBuildConfig withMaxSuggestions(java.lang.Integer maxSuggestions)
```
  - setNbUrlsPerEntry
```
public void setNbUrlsPerEntry(int nbUrlsPerEntry)
```
    Defines the maximum number of URL to be stored for each entry.
  - getNbUrlsPerEntry
```
public int getNbUrlsPerEntry()
```
    Defines the maximum number of URL to be stored for each entry.
  - withNbUrlsPerEntry
```
public SuggestBuildConfig withNbUrlsPerEntry(int nbUrlsPerEntry)
```
  - withNbUrlsPerEntry
```
public SuggestBuildConfig withNbUrlsPerEntry(java.lang.Integer nbUrlsPerEntry)
```
  - setTokenizationConfig
```
public void setTokenizationConfig(java.lang.String tokenizationConfig)
```
    Tokenization Config to use.
  - getTokenizationConfig
```
public java.lang.String getTokenizationConfig()
```
    Tokenization Config to use.
  - withTokenizationConfig
```
public SuggestBuildConfig withTokenizationConfig(java.lang.String tokenizationConfig)
```
  - setSanitizeEntries
```
public void setSanitizeEntries(boolean sanitizeEntries)
```
    Strips the entry of punctuation, and encloses any UQL operator between quotes.
  - isSanitizeEntries
```
public boolean isSanitizeEntries()
```
    Strips the entry of punctuation, and encloses any UQL operator between quotes.
  - withSanitizeEntries
```
public SuggestBuildConfig withSanitizeEntries(boolean sanitizeEntries)
```
  - withSanitizeEntries
```
public SuggestBuildConfig withSanitizeEntries(java.lang.Boolean sanitizeEntries)
```
  - setBuildAfterIndexImport
```
public void setBuildAfterIndexImport(boolean buildAfterIndexImport)
```
    Triggers a build automatically after the index refreshes.
  - isBuildAfterIndexImport
```
public boolean isBuildAfterIndexImport()
```
    Triggers a build automatically after the index refreshes.
  - withBuildAfterIndexImport
```
public SuggestBuildConfig withBuildAfterIndexImport(boolean buildAfterIndexImport)
```
  - withBuildAfterIndexImport
```
public SuggestBuildConfig withBuildAfterIndexImport(java.lang.Boolean buildAfterIndexImport)
```
  - setSecure
```
public void setSecure(boolean secure)
```
    Makes use of documents and users' security tokens to restrict suggestions.
  - isSecure
```
public boolean isSecure()
```
    Makes use of documents and users' security tokens to restrict suggestions.
  - withSecure
```
public SuggestBuildConfig withSecure(boolean secure)
```
  - withSecure
```
public SuggestBuildConfig withSecure(java.lang.Boolean secure)
```
  - setSecurityModel
```
public void setSecurityModel(java.lang.String securityModel)
```
    Enables the enovia-specific handling of security tokens.
  - getSecurityModel
```
public java.lang.String getSecurityModel()
```
    Enables the enovia-specific handling of security tokens.
  - withSecurityModel
```
public SuggestBuildConfig withSecurityModel(java.lang.String securityModel)
```
  - makeCopy
```
public SuggestBuildConfig makeCopy()
```
    Creates and returns a deep copy of this SuggestBuildConfig.
  - readFrom
```
public static SuggestBuildConfig readFrom(java.io.InputStream is)
                                   throws javax.xml.bind.JAXBException
```
    Read this SuggestBuildConfig 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 SuggestBuildConfig as an XML fragment
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.IOException
  - fromString
```
public static SuggestBuildConfig fromString(java.lang.String s)
                                     throws javax.xml.bind.JAXBException,
                                            java.io.UnsupportedEncodingException
```
    String representation of this SuggestBuildConfig.
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.UnsupportedEncodingException
  - toString
```
public java.lang.String toString()
```
    String representation of this SuggestBuildConfig.
    
    Overrides:
    
    toString in class java.lang.Object
  - check
```
public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException
```
    Checks this SuggestBuildConfig.
    
    Specified by:
    
    check in interface com.exalead.util.Checkable
    
    Throws:
    
    com.exalead.util.TypedException

Class SuggestBuildConfig

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

subExpr

DEFAULT_SUB_EXPR

subString

DEFAULT_SUB_STRING

splitSentence

DEFAULT_SPLIT_SENTENCE

splitNGrams

DEFAULT_SPLIT_N_GRAMS

computePermutation

DEFAULT_COMPUTE_PERMUTATION

maxEntryLength

DEFAULT_MAX_ENTRY_LENGTH

maxSuggestions

DEFAULT_MAX_SUGGESTIONS

nbUrlsPerEntry

DEFAULT_NB_URLS_PER_ENTRY

tokenizationConfig

sanitizeEntries

DEFAULT_SANITIZE_ENTRIES

buildAfterIndexImport

DEFAULT_BUILD_AFTER_INDEX_IMPORT

secure

DEFAULT_SECURE

securityModel

DEFAULT_SECURITY_MODEL

Constructor Detail

SuggestBuildConfig

SuggestBuildConfig

Method Detail

isA

isOneOf

setSecurityModel

getSecurityModelAsEnum

setSubExpr

isSubExpr

withSubExpr

withSubExpr

setSubString

isSubString

withSubString

withSubString

setSplitSentence

isSplitSentence

withSplitSentence

withSplitSentence

setSplitNGrams

getSplitNGrams

withSplitNGrams

withSplitNGrams

setComputePermutation

isComputePermutation

withComputePermutation

withComputePermutation

setMaxEntryLength

getMaxEntryLength

withMaxEntryLength

withMaxEntryLength

setMaxSuggestions

getMaxSuggestions

withMaxSuggestions

withMaxSuggestions

setNbUrlsPerEntry

getNbUrlsPerEntry

withNbUrlsPerEntry

withNbUrlsPerEntry

setTokenizationConfig

getTokenizationConfig

withTokenizationConfig

setSanitizeEntries

isSanitizeEntries

withSanitizeEntries

withSanitizeEntries

setBuildAfterIndexImport