Package io.jmix.flowui.component

Class AggregationInfo

java.lang.Object
io.jmix.flowui.component.AggregationInfo
All Implemented Interfaces:
SupportsFormatter<Object>
public class AggregationInfo extends Object implements SupportsFormatter<Object>
POJO to store all information needed to create aggregation in DataGrid.

  • Field Details

  • Constructor Details

    • AggregationInfo

      public AggregationInfo()

  • Method Details

    • getPropertyPath

      @Nullable public MetaPropertyPath getPropertyPath()
      Returns the MetaPropertyPath used for aggregation.
      Returns:
      the MetaPropertyPath, or null if not set

    • setPropertyPath

      public void setPropertyPath(@Nullable MetaPropertyPath propertyPath)
      Sets the MetaPropertyPath used for aggregation.
      Parameters:
      propertyPath - the MetaPropertyPath representing the path to the property, or null if no property path is set

    • getType

      @Nullable public AggregationInfo.Type getType()
      Returns the type of aggregation.
      Returns:
      the type of aggregation, or null if it is not set.

    • setType

      public void setType(AggregationInfo.Type type)
      Sets the type of aggregation.
      Parameters:
      type - the type to set

    • getFormatter

      @Nullable public Formatter<Object> getFormatter()
      Specified by:
      getFormatter in interface SupportsFormatter<Object>
      Returns:
      a formatter or null if not set

    • setFormatter

      public void setFormatter(@Nullable Formatter<? super Object> formatter)
      Description copied from interface: SupportsFormatter
      Sets a formatter that is used to produce the strings representation of the value.
      Specified by:
      setFormatter in interface SupportsFormatter<Object>
      Parameters:
      formatter - a formatter to set or null to remove

    • getStrategy

      @Nullable public AggregationStrategy<?,?> getStrategy()
      Returns the current aggregation strategy in use.
      Returns:
      the aggregation strategy if present, or null if no strategy is set

    • setStrategy

      public void setStrategy(@Nullable AggregationStrategy<?,?> strategy)
      Sets the aggregation strategy to be used. If a non-null strategy is provided, the type is set to CUSTOM. This method allows customization of aggregation logic.
      Parameters:
      strategy - the aggregation strategy to set; can be null to indicate no strategy

    • getCellTitle

      @Nullable public String getCellTitle()
      Returns the title of the cell, if available.
      Returns:
      the cell title, or null if no title is set

    • setCellTitle

      public void setCellTitle(String cellTitle)
      Sets the title of the cell.
      Parameters:
      cellTitle - the title to set for the cell