Class DictionaryInfo
- java.lang.Object
-
- com.attivio.sdk.dictionary.DictionaryObject
-
- com.attivio.sdk.dictionary.DictionaryInfo
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Cloneable
public class DictionaryInfo extends DictionaryObject
Dictionary Info.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static DictionaryModeDEFAULT_DICTIONARY_MODEstatic intDEFAULT_MAX_TERM_LENGTHstatic intDEFAULT_MIN_TERM_FREQUENCYstatic intDEFAULT_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 Description DictionaryInfo()DictionaryInfo(RevisionStatus version)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaddDataSource(Query value)voidaddDerivedField(java.lang.String value)voidaddLocale(java.util.Locale value)DictionaryInfoclone()booleanequals(java.lang.Object other)java.util.List<Query>getDataSources()java.util.List<java.lang.String>getDerivedFields()DictionaryModegetDictionaryMode()java.util.List<java.util.Locale>getLocales()intgetMaxTermLength()Get the max term length.intgetMinTermFrequency()Get the minimum frequency.intgetMinTermLength()Get the min term length.inthashCode()booleanisAllowNumericTerms()Get if numeric terms should be extracted.booleanisBidirectional()Deprecated.booleanisCaseSensitive()booleanisPartialMatches()Set if partial matches are supported for dictionary.booleanisPunctuationSensitive()voidsetAllowNumericTerms(boolean value)voidsetBidirectional(boolean value)Deprecated.voidsetCaseSensitive(boolean value)voidsetDataSources(java.util.List<Query> value)voidsetDerivedFields(java.util.List<java.lang.String> value)voidsetDictionaryMode(DictionaryMode value)voidsetLocales(java.util.List<java.util.Locale> value)voidsetMaxTermLength(int value)voidsetMinTermFrequency(int value)voidsetMinTermLength(int value)voidsetPartialMatches(boolean value)voidsetPunctuationSensitive(boolean value)java.lang.StringtoString()DictionaryInfovalidate()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
-
-
-
-
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 java.util.List<java.lang.String> getDerivedFields()
-
setDerivedFields
public void setDerivedFields(java.util.List<java.lang.String> value)
-
addDerivedField
public void addDerivedField(java.lang.String value)
-
getDataSources
public java.util.List<Query> getDataSources()
-
setDataSources
public void setDataSources(java.util.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 java.util.List<java.util.Locale> getLocales()
-
setLocales
public void setLocales(java.util.List<java.util.Locale> value)
-
addLocale
public void addLocale(java.util.Locale value)
-
isBidirectional
@Deprecated public boolean isBidirectional()
Deprecated.
-
setBidirectional
@Deprecated public void setBidirectional(boolean value)
Deprecated.
-
validate
public DictionaryInfo validate()
Description copied from class:DictionaryObjectValidate properties.Throws
IllegalArgumentExceptionif invalid.- Overrides:
validatein classDictionaryObject
-
hashCode
public int hashCode()
- Overrides:
hashCodein classDictionaryObject
-
equals
public boolean equals(java.lang.Object other)
- Overrides:
equalsin classDictionaryObject
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
clone
public DictionaryInfo clone()
- Overrides:
clonein classDictionaryObject
-
-