Record Class StatsMetricRequest

java.lang.Object
java.lang.Record
org.praxisplatform.uischema.stats.dto.StatsMetricRequest
Record Components:
operation - operacao agregada desejada
field - campo numerico alvo quando a operacao exigir um campo explicito
alias - nome opcional e estavel para exposicao na resposta

public record StatsMetricRequest(StatsMetric operation, String field, String alias) extends Record
Define uma metrica agregada solicitada pelos endpoints estatisticos.

O contrato separa a operacao agregada (COUNT, SUM, etc.) do campo alvo e de um alias opcional. Isso permite que a mesma superficie suporte metrica unica e multi-metrica sem introduzir formatos paralelos de payload.

  • Constructor Details

    • StatsMetricRequest

      public StatsMetricRequest(StatsMetric operation, String field)
      Construtor de compatibilidade para requests sem alias explicito.
    • StatsMetricRequest

      public StatsMetricRequest(StatsMetric operation, String field, String alias)
      Creates an instance of a StatsMetricRequest record class.
      Parameters:
      operation - the value for the operation record component
      field - the value for the field record component
      alias - the value for the alias record component
  • Method Details

    • effectiveAlias

      public String effectiveAlias()
      Resolve o alias efetivo da metrica.

      A precedencia e: alias explicito, depois field, e por fim o nome da operation. Isso permite rotulos consistentes em respostas e contratos derivados.

      Returns:
      alias efetivo ou null quando a metrica estiver incompleta
    • 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.
    • operation

      public StatsMetric operation()
      Returns the value of the operation record component.
      Returns:
      the value of the operation record component
    • field

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

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