Class DictionaryInfo

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable

    public class DictionaryInfo
    extends DictionaryObject
    Dictionary Info.
    See Also:
    Serialized Form
    • 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()
    • 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)
      • 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.
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object