Record Class DatasetSummary

java.lang.Object
java.lang.Record
com.axelor.meta.query.dataset.DatasetSummary
Record Components:
field - the field the aggregate was taken over
fn - the aggregation method
value - the computed value

public record DatasetSummary(String field, AggregateFn fn, Object value) extends Record
A query-scope aggregate, computed unwindowed over the filtered set.

This is what lets a table caption a true query total. Without it, a total computed from the returned page is a page total and must be labelled as one.

  • Constructor Details

    • DatasetSummary

      public DatasetSummary(String field, AggregateFn fn, Object value)
      Creates an instance of a DatasetSummary record class.
      Parameters:
      field - the value for the field record component
      fn - the value for the fn record component
      value - the value for the value 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
    • fn

      public AggregateFn fn()
      Returns the value of the fn record component.
      Returns:
      the value of the fn record component
    • value

      public Object value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component