Package io.jmix.reports.entity

Class ReportValueFormat

java.lang.Object
io.jmix.reports.entity.ReportValueFormat
All Implemented Interfaces:
CopyingSystemState<ReportValueFormat>, ReportFieldFormat, Serializable
public class ReportValueFormat extends Object implements ReportFieldFormat, CopyingSystemState<ReportValueFormat>
See Also:

  • Field Details

    • id

      protected UUID id

    • valueName

      protected String valueName

    • formatString

      protected String formatString

    • report

      protected Report report

    • groovyScript

      protected Boolean groovyScript

    • customFormatter

      protected CustomValueFormatter<?> customFormatter

  • Constructor Details

    • ReportValueFormat

      public ReportValueFormat()

  • Method Details

    • getId

      public UUID getId()

    • setId

      public void setId(UUID id)

    • getReport

      public Report getReport()

    • setReport

      public void setReport(Report report)

    • getValueName

      public String getValueName()

    • setValueName

      public void setValueName(String valueName)

    • getFormatString

      public String getFormatString()

    • setFormatString

      public void setFormatString(String formatString)

    • getGroovyScript

      public Boolean getGroovyScript()

    • setGroovyScript

      public void setGroovyScript(Boolean groovyScript)

    • getName

      public String getName()
      Specified by:
      getName in interface ReportFieldFormat
      Returns:
      formatted field name. Should also contain all parent band names. Example: Band1.Band2.field1

    • getFormat

      public String getFormat()
      Specified by:
      getFormat in interface ReportFieldFormat
      Returns:
      format string Example: ##,# for decimals, dd-MM-yyyy for dates, etc.

    • isGroovyScript

      public Boolean isGroovyScript()
      Specified by:
      isGroovyScript in interface ReportFieldFormat
      Returns:
      boolean true if the groovy script, otherwise false

    • getCustomFormatter

      public CustomValueFormatter<?> getCustomFormatter()
      Specified by:
      getCustomFormatter in interface ReportFieldFormat
      Returns:
      custom formatter object. If it exists, it takes precedence over other format options.

    • setCustomFormatter

      public void setCustomFormatter(CustomValueFormatter<?> customFormatter)

    • copyFrom

      public void copyFrom(ReportValueFormat source)
      Description copied from interface: CopyingSystemState
      Invoked by the framework when copying the entity instance.
      Specified by:
      copyFrom in interface CopyingSystemState<ReportValueFormat>
      Parameters:
      source - source entity