Package org.praxisplatform.uischema.stats.dto

Record Class GroupByStatsRequest<FD extends GenericFilterDTO>

java.lang.Object
java.lang.Record
org.praxisplatform.uischema.stats.dto.GroupByStatsRequest<FD>
Type Parameters:
FD - tipo do filtro do recurso
public record GroupByStatsRequest<FD extends GenericFilterDTO>(FD extends GenericFilterDTO filter, String field, StatsMetricRequest metric, Integer limit, StatsBucketOrder orderBy, List<StatsMetricRequest> metrics) extends Record
Contrato canonico de request para agregacoes group-by.

O request combina o filtro principal do recurso com a definicao do campo de agrupamento e da metrica agregada. A plataforma tambem suporta o modo multi-metrica via metrics, mantendo compatibilidade com o campo legado metric como primary metric.

  • Constructor Details

    • GroupByStatsRequest

      public GroupByStatsRequest(FD filter, String field, StatsMetricRequest metric, Integer limit, StatsBucketOrder orderBy)
      Construtor de compatibilidade para o modo de metrica unica.

    • GroupByStatsRequest

      public GroupByStatsRequest(FD filter, String field, StatsMetricRequest metric, Integer limit, StatsBucketOrder orderBy, List<StatsMetricRequest> metrics)
      Creates an instance of a GroupByStatsRequest record class.
      Parameters:
      filter - the value for the filter record component
      field - the value for the field record component
      metric - the value for the metric record component
      limit - the value for the limit record component
      orderBy - the value for the orderBy record component
      metrics - the value for the metrics record component

  • Method Details

    • effectiveMetrics

      public List<StatsMetricRequest> effectiveMetrics()
      Retorna a lista efetiva de metricas solicitadas.

      Quando metrics estiver preenchido, ele prevalece. Caso contrario, o metodo faz fallback para a metrica unica em metric.

      Returns:
      lista efetiva de metricas

    • primaryMetric

      public StatsMetricRequest primaryMetric()
      Retorna a metrica primaria para consumidores que ainda operam em modo de metrica unica.
      Returns:
      primeira metrica efetiva ou null quando nenhuma foi informada

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

    • filter

      public FD filter()
      Returns the value of the filter record component.
      Returns:
      the value of the filter record component

    • field

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

    • metric

      public StatsMetricRequest metric()
      Returns the value of the metric record component.
      Returns:
      the value of the metric record component

    • limit

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

    • orderBy

      public StatsBucketOrder orderBy()
      Returns the value of the orderBy record component.
      Returns:
      the value of the orderBy record component

    • metrics

      public List<StatsMetricRequest> metrics()
      Returns the value of the metrics record component.
      Returns:
      the value of the metrics record component