Package io.jmix.reports.annotation

Annotation Interface DataSetDef

@Target(TYPE) @Retention(RUNTIME) public @interface DataSetDef
Defines a data set as part of the BandDef. Additional associated logic can be declared by creating a method annotated with DataSetDelegate.
Model object is DataSet.

  • Element Details

    • type

      DataSetType type
      Type that determines how band data will be obtained. Note: GROOVY is not supported here, use DELEGATE instead.

    • name

      String name
      Data set name (optional).
      For Crosstab Orientation.CROSS) bands, its data sets must be named strictly according to convention:
      • Column headers - ${band_name}_dynamic_header
      • Row headers - ${band_name}_master_data
      • Main content - ${band_name}
      Default:
      ""

    • json

      JsonDataSetParameters json
      Additional parameters for DataSetType.JPQL type.
      Default:
      @io.jmix.reports.annotation.JsonDataSetParameters

    • entity

      EntityDataSetDef entity
      Additional parameters for DataSetType.SINGLE and DataSetType.MULTI types.
      Default:
      @io.jmix.reports.annotation.EntityDataSetDef

    • linkParameterName

      String linkParameterName
      Name of the band field used to merge data from multiple datasets inside one band.
      Default:
      ""

    • dataStore

      String dataStore
      Name of data store, if the SQL or JPQL query needs to be executed in the additional data store.
      Default:
      ""

    • processTemplate

      boolean processTemplate
      Flag activating Groovy template processing of the query text.
      Default:
      false

    • query

      String query
      Query text for DataSetType.SQL and DataSetType.JPQL types.
      Default:
      ""