Package com.attivio.sdk.dictionary

Enum ExpansionMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ExpansionMode>
    public enum ExpansionMode
extends java.lang.Enum<ExpansionMode>
implements java.io.Serializable
    Expansion mode for dictionary entries.

    NOTE: currently, this only applies to synonym dictionaries.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BIDIRECTIONAL
      Bi-directional expansion.
      DEFAULT
      Use default expansion mode specified on dictionary.
      EXPAND
      One-way expansion.
      REWRITE
      Term is rewritten to synonym(s)
      SUGGEST
      Suggested terms are provided.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static ExpansionMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ExpansionMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • DEFAULT

        public static final ExpansionMode DEFAULT
        Use default expansion mode specified on dictionary.

        NOTE: if a dictionary entry uses DEFAULT, and the dictionary info also specified DEFAULT, then EXPAND will be used.

      • EXPAND

        public static final ExpansionMode EXPAND
        One-way expansion.

      • BIDIRECTIONAL

        public static final ExpansionMode BIDIRECTIONAL
        Bi-directional expansion.

      • REWRITE

        public static final ExpansionMode REWRITE
        Term is rewritten to synonym(s)

      • SUGGEST

        public static final ExpansionMode SUGGEST
        Suggested terms are provided.

    • Method Detail

      • values

        public static ExpansionMode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (ExpansionMode c : ExpansionMode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static ExpansionMode valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null