Package org.apache.solr.handler.component

Enum Class StatsField.Stat

java.lang.Object
java.lang.Enum<StatsField.Stat>
org.apache.solr.handler.component.StatsField.Stat
All Implemented Interfaces:
Serializable, Comparable<StatsField.Stat>, Constable
Enclosing class:
StatsField
public static enum StatsField.Stat extends Enum<StatsField.Stat>
An enumeration representing the sumer set of all possible stat values that can be computed. Each of these enum values can be specified as a local param in a stats.field (eg: stats.field={!min=true mean=true}my_field_name) but not all enum values are valid for all field types (eg: mean is meaningless for String fields)
WARNING: This API is experimental and might change in incompatible ways in the next release.
NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

  • Enum Constant Details

  • Method Details

    • values

      public static StatsField.Stat[] 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 StatsField.Stat 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

    • forName

      public static StatsField.Stat forName(String paramKey)
      Given a String, returns the corresponding Stat enum value if any, otherwise returns null.

    • getDistribDeps

      public EnumSet<StatsField.Stat> getDistribDeps()
      The stats that must be computed and returned by each shard involved in a distributed request in order to compute the overall value for this stat across the entire distributed result set. A Stat instance may include itself in the getDistribDeps() result, but that is not always the case.