Interface Feature

public interface Feature
A feature in the formula once bound to a schema. A feature returns a single value when applied to a data object (e.g. Tuple).

  • Method Summary

    Modifier and Type
    Method
    Description
    default ValueVector
    apply(DataFrame data)
    Applies the term on a data frame.
    Object
    apply(Tuple tuple)
    Applies the term on a tuple.
    default boolean
    applyAsBoolean(Tuple tuple)
    Applies the term on a data object and produces a boolean-valued result.
    default byte
    applyAsByte(Tuple tuple)
    Applies the term on a data object and produces a byte-valued result.
    default char
    applyAsChar(Tuple tuple)
    Applies the term on a data object and produces a char-valued result.
    default BigDecimal
    applyAsDecimal(Tuple tuple)
    Applies the term on a data object and produces a decimal-valued result.
    default double
    applyAsDouble(Tuple tuple)
    Applies the term on a data object and produces a double-valued result.
    default float
    applyAsFloat(Tuple tuple)
    Applies the term on a data object and produces a float-valued result.
    default int
    applyAsInt(Tuple tuple)
    Applies the term on a data object and produces an int-valued result.
    default long
    applyAsLong(Tuple tuple)
    Applies the term on a data object and produces a long-valued result.
    default short
    applyAsShort(Tuple tuple)
    Applies the term on a data object and produces a short-valued result.
    default String
    applyAsString(Tuple tuple)
    Applies the term on a data object and produces a string-valued result.
    StructField
    field()
    Returns the metadata of feature.
    default boolean
    isVariable()
    Returns true if the term represents a plain variable/column in the data frame.

  • Method Details

    • field

      StructField field()
      Returns the metadata of feature.
      Returns:
      the metadata of feature.

    • apply

      Object apply(Tuple tuple)
      Applies the term on a tuple.
      Parameters:
      tuple - the input tuple.
      Returns:
      the feature value.

    • applyAsDouble

      default double applyAsDouble(Tuple tuple)
      Applies the term on a data object and produces a double-valued result.
      Parameters:
      tuple - the input tuple.
      Returns:
      the feature value.

    • applyAsFloat

      default float applyAsFloat(Tuple tuple)
      Applies the term on a data object and produces a float-valued result.
      Parameters:
      tuple - the input tuple.
      Returns:
      the feature value.

    • applyAsInt

      default int applyAsInt(Tuple tuple)
      Applies the term on a data object and produces an int-valued result.
      Parameters:
      tuple - the input tuple.
      Returns:
      the feature value.

    • applyAsLong

      default long applyAsLong(Tuple tuple)
      Applies the term on a data object and produces a long-valued result.
      Parameters:
      tuple - the input tuple
      Returns:
      the feature value.

    • applyAsBoolean

      default boolean applyAsBoolean(Tuple tuple)
      Applies the term on a data object and produces a boolean-valued result.
      Parameters:
      tuple - the input tuple.
      Returns:
      the feature value.

    • applyAsByte

      default byte applyAsByte(Tuple tuple)
      Applies the term on a data object and produces a byte-valued result.
      Parameters:
      tuple - the input tuple.
      Returns:
      the feature value.

    • applyAsShort

      default short applyAsShort(Tuple tuple)
      Applies the term on a data object and produces a short-valued result.
      Parameters:
      tuple - the input tuple.
      Returns:
      the feature value.

    • applyAsChar

      default char applyAsChar(Tuple tuple)
      Applies the term on a data object and produces a char-valued result.
      Parameters:
      tuple - the input tuple.
      Returns:
      the feature value.

    • applyAsString

      default String applyAsString(Tuple tuple)
      Applies the term on a data object and produces a string-valued result.
      Parameters:
      tuple - the input tuple.
      Returns:
      the feature value.

    • applyAsDecimal

      default BigDecimal applyAsDecimal(Tuple tuple)
      Applies the term on a data object and produces a decimal-valued result.
      Parameters:
      tuple - the input tuple.
      Returns:
      the feature value.

    • isVariable

      default boolean isVariable()
      Returns true if the term represents a plain variable/column in the data frame.
      Returns:
      true if the term represents a plain variable/column in the data frame.

    • apply

      default ValueVector apply(DataFrame data)
      Applies the term on a data frame.
      Parameters:
      data - the data frame.
      Returns:
      the feature vector.