DictionaryInfo (platform/sdk 5.5.1.0-SNAPSHOT API)

java.lang.Object
- com.attivio.sdk.dictionary.DictionaryObject
- - com.attivio.sdk.dictionary.DictionaryInfo

All Implemented Interfaces:

Serializable, Cloneable
```
public class DictionaryInfo
extends DictionaryObject
```
Dictionary Info.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static DictionaryMode`	`DEFAULT_DICTIONARY_MODE`
`static int`	`DEFAULT_MAX_TERM_LENGTH`
`static int`	`DEFAULT_MIN_TERM_FREQUENCY`
`static int`	`DEFAULT_MIN_TERM_LENGTH`

Fields inherited from class com.attivio.sdk.dictionary.DictionaryObject
dictionaryGroup, dictionaryName, dictionaryType, expansionMode, lastApproved, lastModified, lastPublished, status, version

Constructor Summary

Constructors
Constructor and Description

DictionaryInfo()

DictionaryInfo(RevisionStatus version)

Constructors
Constructor and Description
`DictionaryInfo()`
`DictionaryInfo(RevisionStatus version)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addDataSource(Query value)`
`void`	`addDerivedField(String value)`
`void`	`addLocale(Locale value)`
`DictionaryInfo`	`clone()`
`boolean`	`equals(Object other)`
`List<Query>`	`getDataSources()`
`List<String>`	`getDerivedFields()`
`DictionaryMode`	`getDictionaryMode()`
`List<Locale>`	`getLocales()`
`int`	`getMaxTermLength()` Get the max term length.
`int`	`getMinTermFrequency()` Get the minimum frequency.
`int`	`getMinTermLength()` Get the min term length.
`int`	`hashCode()`
`boolean`	`isAllowNumericTerms()` Get if numeric terms should be extracted.
`boolean`	`isBidirectional()` Deprecated.
`boolean`	`isCaseSensitive()`
`boolean`	`isPartialMatches()` Set if partial matches are supported for dictionary.
`boolean`	`isPunctuationSensitive()`
`void`	`setAllowNumericTerms(boolean value)`
`void`	`setBidirectional(boolean value)` Deprecated.
`void`	`setCaseSensitive(boolean value)`
`void`	`setDataSources(List<Query> value)`
`void`	`setDerivedFields(List<String> value)`
`void`	`setDictionaryMode(DictionaryMode value)`
`void`	`setLocales(List<Locale> value)`
`void`	`setMaxTermLength(int value)`
`void`	`setMinTermFrequency(int value)`
`void`	`setMinTermLength(int value)`
`void`	`setPartialMatches(boolean value)`
`void`	`setPunctuationSensitive(boolean value)`
`String`	`toString()`
`DictionaryInfo`	`validate()` Validate properties.

Methods inherited from class com.attivio.sdk.dictionary.DictionaryObject
append, append, append, getDictionaryGroup, getDictionaryName, getDictionaryType, getExpansionMode, getLastApproved, getLastModified, getLastPublished, getStatus, getVersion, isEmpty, setDictionaryGroup, setDictionaryName, setDictionaryType, setExpansionMode, setLastApproved, setLastModified, setLastPublished, setStatus, setVersion

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

- Field Detail
  - DEFAULT_DICTIONARY_MODE
```
public static final DictionaryMode DEFAULT_DICTIONARY_MODE
```
  - DEFAULT_MAX_TERM_LENGTH
```
public static final int DEFAULT_MAX_TERM_LENGTH
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MIN_TERM_LENGTH
```
public static final int DEFAULT_MIN_TERM_LENGTH
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MIN_TERM_FREQUENCY
```
public static final int DEFAULT_MIN_TERM_FREQUENCY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DictionaryInfo
```
public DictionaryInfo()
```
  - DictionaryInfo
```
public DictionaryInfo(RevisionStatus version)
```
- Method Detail
  - isPartialMatches
```
public boolean isPartialMatches()
```
    Set if partial matches are supported for dictionary.
    This only applies to entity dictionaries.
    
    NOTE: partial matches will only match at word boundaries for multi-word entities. For instance, for term "International Business Machines", the following lookups will match: "International Business Machines", "Business Machines", "Machines". This is primaryly useful when using using entity dictionary for autocomplete.
  - setPartialMatches
```
public void setPartialMatches(boolean value)
```
  - isCaseSensitive
```
public boolean isCaseSensitive()
```
  - setCaseSensitive
```
public void setCaseSensitive(boolean value)
```
  - isPunctuationSensitive
```
public boolean isPunctuationSensitive()
```
  - setPunctuationSensitive
```
public void setPunctuationSensitive(boolean value)
```
  - getDictionaryMode
```
public DictionaryMode getDictionaryMode()
```
  - setDictionaryMode
```
public void setDictionaryMode(DictionaryMode value)
```
  - getDerivedFields
```
public List<String> getDerivedFields()
```
  - setDerivedFields
```
public void setDerivedFields(List<String> value)
```
  - addDerivedField
```
public void addDerivedField(String value)
```
  - getDataSources
```
public List<Query> getDataSources()
```
  - setDataSources
```
public void setDataSources(List<Query> value)
```
  - addDataSource
```
public void addDataSource(Query value)
```
  - getMaxTermLength
```
public int getMaxTermLength()
```
    Get the max term length.
    Max term length applies to blacklist based spellcheck dictionaries only.
    
    This value will be the maximum length of terms automatically extracted from the index.
  - setMaxTermLength
```
public void setMaxTermLength(int value)
```
  - getMinTermFrequency
```
public int getMinTermFrequency()
```
    Get the minimum frequency.
    Terms with a frequency less than this setting will not be extracted automatically from the index.
    
    This setting only applies to blacklist based spellcheck dictionaries.
  - setMinTermFrequency
```
public void setMinTermFrequency(int value)
```
  - getMinTermLength
```
public int getMinTermLength()
```
    Get the min term length.
    Minimum term length applies to blacklist based spellcheck dictionaries only.
    
    This value will be the minimum length that a term must have to be automatically extracted from the index.
  - setMinTermLength
```
public void setMinTermLength(int value)
```
  - isAllowNumericTerms
```
public boolean isAllowNumericTerms()
```
    Get if numeric terms should be extracted.
    If true, terms with numbers in them will also be automatically extracted from the index.
    
    This setting only applies to blacklist based spellcheck dictionaries.
  - setAllowNumericTerms
```
public void setAllowNumericTerms(boolean value)
```
  - getLocales
```
public List<Locale> getLocales()
```
  - setLocales
```
public void setLocales(List<Locale> value)
```
  - addLocale
```
public void addLocale(Locale value)
```
  - isBidirectional
```
@Deprecated
public boolean isBidirectional()
```
    Deprecated.
  - setBidirectional
```
@Deprecated
public void setBidirectional(boolean value)
```
    Deprecated.
  - validate
```
public DictionaryInfo validate()
```
    Description copied from class: DictionaryObject
    
    Validate properties.
    Throws IllegalArgumentException if invalid.
    
    Overrides:
    
    validate in class DictionaryObject
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class DictionaryObject
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class DictionaryObject
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - clone
```
public DictionaryInfo clone()
```
    Overrides:
    
    clone in class DictionaryObject

Class DictionaryInfo

Field Summary

Fields inherited from class com.attivio.sdk.dictionary.DictionaryObject

Constructor Summary

Method Summary

Methods inherited from class com.attivio.sdk.dictionary.DictionaryObject

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_DICTIONARY_MODE

DEFAULT_MAX_TERM_LENGTH

DEFAULT_MIN_TERM_LENGTH

DEFAULT_MIN_TERM_FREQUENCY

Constructor Detail

DictionaryInfo

DictionaryInfo

Method Detail

isPartialMatches

setPartialMatches

isCaseSensitive

setCaseSensitive

isPunctuationSensitive

setPunctuationSensitive

getDictionaryMode

setDictionaryMode

getDerivedFields

setDerivedFields

addDerivedField

getDataSources

setDataSources

addDataSource

getMaxTermLength

setMaxTermLength

getMinTermFrequency

setMinTermFrequency

getMinTermLength

setMinTermLength

isAllowNumericTerms

setAllowNumericTerms

getLocales

setLocales

addLocale

isBidirectional

setBidirectional

validate

hashCode

equals

toString

clone