Record Class WindowTransformField

java.lang.Object
java.lang.Record
smile.plot.vega.WindowTransformField
Record Components:
op - The window or aggregation operation to apply within a window (e.g., "rank", "lead", "sum", "average" or "count").
field - The data field for which to compute the aggregate or window function. This can be omitted for window functions that do not operate over a field such as "count", "rank", "dense_rank".
param - Parameter values for the window functions. Parameter values can be omitted for operations that do not accept a parameter.
as - The output name for the window operation.
public record WindowTransformField(String op, String field, double param, String as) extends Record
A sort field definition for sorting data objects within a window.

  • Constructor Summary

    Constructors
    Constructor
    Description
    WindowTransformField(String op, String field, double param, String as)
    Creates an instance of a WindowTransformField record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    as()
    Returns the value of the as record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    field()
    Returns the value of the field record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    op()
    Returns the value of the op record component.
    double
    param()
    Returns the value of the param record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • WindowTransformField

      public WindowTransformField(String op, String field, double param, String as)
      Creates an instance of a WindowTransformField record class.
      Parameters:
      op - the value for the op record component
      field - the value for the field record component
      param - the value for the param record component
      as - the value for the as record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • op

      public String op()
      Returns the value of the op record component.
      Returns:
      the value of the op record component

    • field

      public String field()
      Returns the value of the field record component.
      Returns:
      the value of the field record component

    • param

      public double param()
      Returns the value of the param record component.
      Returns:
      the value of the param record component

    • as

      public String as()
      Returns the value of the as record component.
      Returns:
      the value of the as record component