Package de.cxp.ocs.config

Enum Class FieldUsage

java.lang.Object
java.lang.Enum<FieldUsage>
de.cxp.ocs.config.FieldUsage
All Implemented Interfaces:
Serializable, Comparable<FieldUsage>, Constable
public enum FieldUsage extends Enum<FieldUsage>
Enum describing the usage of an field that will be indexed.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    FACET
    Fields with this usage are prepared for automatic facet creation and filtering.
    FILTER
    Fields with this usage are prepared to be used for filtering without automatic facet generation.
    RESULT
    Fields with this usage are made ready to returned in the response at the matched hits.
    SCORE
    Fields with this usage are prepared to be used for scoring
    SEARCH
    Fields with this usage are analyzed in all set up ways made ready for full-text search.
    SORT
    Fields with this usage are prepared for sorting.

  • Method Summary

    Modifier and Type
    Method
    Description
    static FieldUsage
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static FieldUsage[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • RESULT

      public static final FieldUsage RESULT
      Fields with this usage are made ready to returned in the response at the matched hits.

    • SORT

      public static final FieldUsage SORT
      Fields with this usage are prepared for sorting.

    • FACET

      public static final FieldUsage FACET
      Fields with this usage are prepared for automatic facet creation and filtering.

    • FILTER

      public static final FieldUsage FILTER
      Fields with this usage are prepared to be used for filtering without automatic facet generation.

    • SCORE

      public static final FieldUsage SCORE
      Fields with this usage are prepared to be used for scoring

  • Method Details

    • values

      public static FieldUsage[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static FieldUsage valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null