Package smile.plot.vega

Record Class SortField

java.lang.Object
java.lang.Record
smile.plot.vega.SortField
Record Components:
field - The name of the field to sort.
order - Whether to sort the field in ascending or descending order. "ascending" (default), "descending", or null (no not sort).
public record SortField(String field, String order) extends Record
A sort field definition for sorting data objects within a window.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SortField(String field, String order)
    Creates an instance of a SortField record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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
    order()
    Returns the value of the order record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • SortField

      public SortField(String field, String order)
      Creates an instance of a SortField record class.
      Parameters:
      field - the value for the field record component
      order - the value for the order 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • field

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

    • order

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