Package org.praxisplatform.uischema.stats.dto

Record Class DistributionStatsRequest<FD extends GenericFilterDTO>

java.lang.Object
java.lang.Record
org.praxisplatform.uischema.stats.dto.DistributionStatsRequest<FD>
Type Parameters:
FD - tipo do filtro do recurso
public record DistributionStatsRequest<FD extends GenericFilterDTO>(FD extends GenericFilterDTO filter, String field, DistributionMode mode, StatsMetricRequest metric, Number bucketSize, Integer bucketCount, Integer limit, StatsBucketOrder orderBy) extends Record
Contrato canonico de request para distribuicoes agregadas.

Esse request cobre cenarios como histogramas e distribuicoes por faixas sobre campos numericos, sempre aplicados ao conjunto filtrado do recurso. Os parametros de bucket podem ser informados por tamanho, quantidade ou ambos, conforme o mode suportado pela implementacao.

  • Constructor Details

    • DistributionStatsRequest

      public DistributionStatsRequest(FD filter, String field, DistributionMode mode, StatsMetricRequest metric, Number bucketSize, Integer bucketCount, Integer limit, StatsBucketOrder orderBy)
      Creates an instance of a DistributionStatsRequest record class.
      Parameters:
      filter - the value for the filter record component
      field - the value for the field record component
      mode - the value for the mode record component
      metric - the value for the metric record component
      bucketSize - the value for the bucketSize record component
      bucketCount - the value for the bucketCount record component
      limit - the value for the limit record component
      orderBy - the value for the orderBy 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.

    • 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

    • mode

      public DistributionMode mode()
      Returns the value of the mode record component.
      Returns:
      the value of the mode record component

    • metric

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

    • bucketSize

      public Number bucketSize()
      Returns the value of the bucketSize record component.
      Returns:
      the value of the bucketSize record component

    • bucketCount

      public Integer bucketCount()
      Returns the value of the bucketCount record component.
      Returns:
      the value of the bucketCount 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