Package com.axelor.meta.query.dataset

Record Class DatasetEnvelope

java.lang.Object
java.lang.Record
com.axelor.meta.query.dataset.DatasetEnvelope
Record Components:
records - the returned records; field names are exact keys, not executable paths
columns - column identity, types and presentation metadata
retrievedAt - when the result was retrieved, distinct from any business-effective date
parameters - the parameter values actually applied
completeness - how much of the matching data these records represent
total - counted rows, or null when no count ran
offset - the applied window offset
limit - the applied window size, after any engine cap
aggregationLevel - whether records are rows or grouped measures
summary - query-scope aggregates, when the query declares any
source - the query definition these records came from
public record DatasetEnvelope(List<Map<String,Object>> records, List<DatasetColumn> columns, Instant retrievedAt, List<DatasetParameter> parameters, Completeness completeness, Long total, Integer offset, Integer limit, AggregationLevel aggregationLevel, List<DatasetSummary> summary, DatasetSource source) extends Record
A resolved dataset: the records plus everything needed to say honestly what they are.

The envelope is produced by the server and never reconstructed by a client. Missing metadata is reported as missing — a reader that receives no completeness treats the dataset as Completeness.UNKNOWN and disables what depends on knowing, rather than inferring completeness from the first plausible-looking number.

total counts rows, not business measures, and is null when no count ran. A null total is the honest answer; the row count of the returned page is not a substitute for it.

  • Constructor Details

  • 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.

    • records

      public List<Map<String,Object>> records()
      Returns the value of the records record component.
      Returns:
      the value of the records record component

    • columns

      public List<DatasetColumn> columns()
      Returns the value of the columns record component.
      Returns:
      the value of the columns record component

    • retrievedAt

      public Instant retrievedAt()
      Returns the value of the retrievedAt record component.
      Returns:
      the value of the retrievedAt record component

    • parameters

      public List<DatasetParameter> parameters()
      Returns the value of the parameters record component.
      Returns:
      the value of the parameters record component

    • completeness

      public Completeness completeness()
      Returns the value of the completeness record component.
      Returns:
      the value of the completeness record component

    • total

      public Long total()
      Returns the value of the total record component.
      Returns:
      the value of the total record component

    • offset

      public Integer offset()
      Returns the value of the offset record component.
      Returns:
      the value of the offset record component

    • limit

      public Integer limit()
      Returns the value of the limit record component.
      Returns:
      the value of the limit record component

    • aggregationLevel

      public AggregationLevel aggregationLevel()
      Returns the value of the aggregationLevel record component.
      Returns:
      the value of the aggregationLevel record component

    • summary

      public List<DatasetSummary> summary()
      Returns the value of the summary record component.
      Returns:
      the value of the summary record component

    • source

      public DatasetSource source()
      Returns the value of the source record component.
      Returns:
      the value of the source record component