Package org.praxisplatform.uischema.stats.dto

Record Class TimeSeriesStatsRequest<FD extends GenericFilterDTO>

java.lang.Object
java.lang.Record
org.praxisplatform.uischema.stats.dto.TimeSeriesStatsRequest<FD>
Type Parameters:
FD - tipo do filtro do recurso
public record TimeSeriesStatsRequest<FD extends GenericFilterDTO>(FD extends GenericFilterDTO filter, String field, TimeSeriesGranularity granularity, StatsMetricRequest metric, LocalDate from, LocalDate to, Boolean fillGaps, List<StatsMetricRequest> metrics) extends Record
Contrato canonico de request para series temporais agregadas.

O request define o campo temporal, a granularidade, o intervalo de datas e a metrica agregada, sempre combinado ao filtro principal do recurso. Assim, dashboards e componentes derivados podem operar sobre uma superficie estatistica consistente entre modulos da plataforma.

  • Constructor Details

    • TimeSeriesStatsRequest

      public TimeSeriesStatsRequest(FD filter, String field, TimeSeriesGranularity granularity, StatsMetricRequest metric, LocalDate from, LocalDate to, Boolean fillGaps)
      Construtor de compatibilidade para o modo de metrica unica.

    • TimeSeriesStatsRequest

      public TimeSeriesStatsRequest(FD filter, String field, TimeSeriesGranularity granularity, StatsMetricRequest metric, LocalDate from, LocalDate to, Boolean fillGaps, List<StatsMetricRequest> metrics)
      Creates an instance of a TimeSeriesStatsRequest record class.
      Parameters:
      filter - the value for the filter record component
      field - the value for the field record component
      granularity - the value for the granularity record component
      metric - the value for the metric record component
      from - the value for the from record component
      to - the value for the to record component
      fillGaps - the value for the fillGaps record component
      metrics - the value for the metrics record component

  • Method Details

    • effectiveMetrics

      public List<StatsMetricRequest> effectiveMetrics()
      Retorna a lista efetiva de metricas solicitadas.
      Returns:
      lista efetiva de metricas; usa metrics quando presente, com fallback para metric

    • primaryMetric

      public StatsMetricRequest primaryMetric()
      Retorna a metrica primaria para consumidores legados ou fluxos de metrica unica.
      Returns:
      primeira metrica efetiva ou null

    • 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

    • granularity

      public TimeSeriesGranularity granularity()
      Returns the value of the granularity record component.
      Returns:
      the value of the granularity record component

    • metric

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

    • from

      public LocalDate from()
      Returns the value of the from record component.
      Returns:
      the value of the from record component

    • to

      public LocalDate to()
      Returns the value of the to record component.
      Returns:
      the value of the to record component

    • fillGaps

      public Boolean fillGaps()
      Returns the value of the fillGaps record component.
      Returns:
      the value of the fillGaps record component

    • metrics

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