Package io.jmix.reports.entity

Class DataSet

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

  • Field Details

    • ENTITY_PARAM_NAME

      public static final String ENTITY_PARAM_NAME
      See Also:

    • LIST_ENTITIES_PARAM_NAME

      public static final String LIST_ENTITIES_PARAM_NAME
      See Also:

    • DATA_STORE_PARAM_NAME

      public static final String DATA_STORE_PARAM_NAME
      See Also:

    • JSON_SOURCE_TYPE

      public static final String JSON_SOURCE_TYPE
      See Also:

    • JSON_SOURCE_TEXT

      public static final String JSON_SOURCE_TEXT
      See Also:

    • JSON_INPUT_PROVIDER

      public static final String JSON_INPUT_PROVIDER
      See Also:

    • JSON_PATH_QUERY

      public static final String JSON_PATH_QUERY
      See Also:

    • JSON_INPUT_PARAMETER

      public static final String JSON_INPUT_PARAMETER
      See Also:

    • LLM_GENERATED_QUERY

      public static final String LLM_GENERATED_QUERY
      See Also:

    • BAND_NAME

      public static final String BAND_NAME
      Name of the band this data set belongs to, published so that a loader can tell what belongs to its own band. A loader is given a ReportQuery and the params of the run, and the params of a run are one mutable map shared by every band of it (ExtractionContextImpl#extendParams), so an entry named after another band is indistinguishable from one's own by name alone.
      See Also:

    • BAND_ORIENTATION

      public static final String BAND_ORIENTATION
      Orientation of the band this data set belongs to, published for the same reason as BAND_NAME: only a cross-tab band is handed the values of its axes, so a loader that reads them has to know whether its own band is one.
      See Also:

    • fetchPlan

      protected FetchPlan fetchPlan

    • fetchPlanProvider

      protected FetchPlanProvider fetchPlanProvider

    • jsonInputProvider

      protected JsonInputProvider jsonInputProvider

    • loaderDelegate

      protected ReportDataLoader loaderDelegate

    • id

      protected UUID id

    • name

      protected String name

    • useExistingFetchPLan

      protected Boolean useExistingFetchPLan

    • fetchPlanName

      protected String fetchPlanName

    • text

      protected String text

    • type

      protected Integer type

    • jsonSourceType

      protected Integer jsonSourceType

    • jsonSourceText

      protected String jsonSourceText

    • jsonPathQuery

      protected String jsonPathQuery

    • jsonSourceInputParameter

      protected ReportInputParameter jsonSourceInputParameter

    • llmGeneratedQuery

      protected String llmGeneratedQuery

    • entityParamName

      protected String entityParamName

    • listEntitiesParamName

      protected String listEntitiesParamName

    • bandDefinition

      protected BandDefinition bandDefinition

    • linkParameterName

      protected String linkParameterName

    • dataStore

      protected String dataStore

    • processTemplate

      protected Boolean processTemplate

  • Constructor Details

    • DataSet

      public DataSet()

  • Method Details

    • getId

      public UUID getId()

    • setId

      public void setId(UUID id)

    • getFetchPlan

      public FetchPlan getFetchPlan()

    • setFetchPlan

      public void setFetchPlan(FetchPlan fetchPlan)

    • getFetchPlanProvider

      public FetchPlanProvider getFetchPlanProvider()

    • setFetchPlanProvider

      public void setFetchPlanProvider(FetchPlanProvider fetchPlanProvider)

    • getUseExistingFetchPLan

      public Boolean getUseExistingFetchPLan()

    • setUseExistingFetchPLan

      public void setUseExistingFetchPLan(Boolean useExistingFetchPLan)

    • getName

      public String getName()
      Specified by:
      getName in interface ReportQuery

    • setName

      public void setName(String name)

    • getFetchPlanName

      public String getFetchPlanName()

    • setFetchPlanName

      public void setFetchPlanName(String fetchPlanName)

    • getText

      public String getText()

    • setText

      public void setText(String text)

    • getType

      public DataSetType getType()

    • setType

      public void setType(DataSetType type)

    • getEntityParamName

      public String getEntityParamName()

    • setEntityParamName

      public void setEntityParamName(String entityParamName)

    • getListEntitiesParamName

      public String getListEntitiesParamName()

    • setListEntitiesParamName

      public void setListEntitiesParamName(String listEntitiesParamName)

    • getBandDefinition

      public BandDefinition getBandDefinition()

    • setBandDefinition

      public void setBandDefinition(BandDefinition bandDefinition)

    • getDataStore

      public String getDataStore()

    • setDataStore

      public void setDataStore(String dataStore)

    • getLinkParameterName

      public String getLinkParameterName()
      Specified by:
      getLinkParameterName in interface ReportQuery

    • setLinkParameterName

      public void setLinkParameterName(String linkParameterName)

    • getProcessTemplate

      public Boolean getProcessTemplate()
      Specified by:
      getProcessTemplate in interface ReportQuery

    • setProcessTemplate

      public void setProcessTemplate(Boolean processTemplate)

    • getScript

      public String getScript()
      Description copied from interface: ReportQuery
      Sql, groovy or other script which describes logic of data loading
      Specified by:
      getScript in interface ReportQuery

    • getLoaderType

      public @Nullable String getLoaderType()
      Specified by:
      getLoaderType in interface ReportQuery
      Returns:
      loader code, or null when the dataset has no type yet. See ReportLoaderFactory implementations and DefaultLoaderFactory for default values.

    • getJsonSourceType

      public JsonSourceType getJsonSourceType()

    • setJsonSourceType

      public void setJsonSourceType(JsonSourceType jsonSourceType)

    • getJsonSourceText

      public String getJsonSourceText()

    • setJsonSourceText

      public void setJsonSourceText(String jsonSourceText)

    • getJsonSourceInputParameter

      public ReportInputParameter getJsonSourceInputParameter()

    • setJsonSourceInputParameter

      public void setJsonSourceInputParameter(ReportInputParameter jsonSourceInputParameter)

    • getJsonPathQuery

      public String getJsonPathQuery()

    • setJsonPathQuery

      public void setJsonPathQuery(String jsonPathQuery)

    • getLlmGeneratedQuery

      public @Nullable String getLlmGeneratedQuery()
      Returns:
      the query generated for the DataSetType.LLM prompt, or null if it has not been generated yet

    • setLlmGeneratedQuery

      public void setLlmGeneratedQuery(@Nullable String llmGeneratedQuery)

    • getJsonInputProvider

      public JsonInputProvider getJsonInputProvider()

    • setJsonInputProvider

      public void setJsonInputProvider(JsonInputProvider jsonInputProvider)

    • getLoaderDelegate

      public ReportDataLoader getLoaderDelegate()
      Specified by:
      getLoaderDelegate in interface ReportQuery
      Returns:
      delegate implementing custom data loading logic

    • setLoaderDelegate

      public void setLoaderDelegate(ReportDataLoader loaderDelegate)

    • getAdditionalParams

      public Map<String,Object> getAdditionalParams()
      Specified by:
      getAdditionalParams in interface ReportQuery

    • copyFrom

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