Package com.inet.report.adhoc.server.api.dataview

Interface TemplateDataViewDefaults

All Superinterfaces:
com.inet.plugin.NamedExtension
All Known Implementing Classes:
PersistenceTemplateDataViewDefaults
public interface TemplateDataViewDefaults extends com.inet.plugin.NamedExtension
Interface for registering dynamic data views in the DynamicExtensionManager or ServerPluginManager
Since:
25.4

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    TemplateDataViewDefaults.Column
    Define a available column

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<List<com.inet.remote.gui.angular.usersorgroupsselection.UsersOrGroupsSelection.SelectedMember>>
    ACCESS_LIST_KEY
    The key for the access permissions of the template
    static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.GroupData>
    CHART_CATEGORY
    The key for initial catagory of a char report on selection the template
    static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<DataField[]>
    CHART_DATA_FIELDS
    The key for initial data fields of a char report on selection the template
    static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.GroupData[]>
    CROSSTAB_COLUMNS
    The key for initial columns of a crosstab report on selection the template
    static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<DataField[]>
    CROSSTAB_DATA
    The key for initial cells of a crosstab report on selection the template
    static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.GroupData[]>
    CROSSTAB_GROUPS
    The key for initial groups of a crosstab report on selection the template
    static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.GroupData[]>
    CROSSTAB_ROWS
    The key for initial rows of a crosstab report on selection the template
    static final com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<DataFilter>
    FILTER_DEFINITION
    Key for initial filter
    static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.table.TableColumnData[]>
    TABLE_COLUMNS
    The key for initial columns of a table report on selection the template
    static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.GroupData[]>
    TABLE_GROUPS
    The key for initial groups of a table report on selection the template
    static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.table.TableSortingData[]>
    TABLE_SORTING
    The key for initial sorting on selection the template
    static final @Nonnull com.inet.report.adhoc.server.api.dataview.DataViewPropertyKey<List<com.inet.config.structure.model.LocalizedKey>>
    TEMPLATESOURCE_COLUMNS_KEY
    The key of columns inside a DataViewDefinition
    static final @Nonnull com.inet.report.adhoc.server.api.dataview.DataViewPropertyKey<String>
    TEMPLATESOURCE_DATASOURCE
    The key of datasource value inside a DataViewDefinition
    static final @Nonnull com.inet.report.adhoc.server.api.dataview.DataViewPropertyKey<List<PersistenceTemplateDataViewDefaults.Join>>
    TEMPLATESOURCE_JOINS_KEY
    The key of joins inside a DataViewDefinition
    static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.dataview.DataViewDefinition>
    TEMPLATESOURCE_KEY
    The key for the JSON of a DataViewDefinition
    static final @Nonnull com.inet.report.adhoc.server.api.dataview.DataViewPropertyKey<List<com.inet.config.structure.model.LocalizedKey>>
    TEMPLATESOURCE_TABLES_KEY
    The key of tables inside a DataViewDefinition

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    applySpecialFormat(@Nonnull com.inet.report.FieldElement el)
    Apply special formats like text interpretation from the template
    @Nonnull DataView
    createDataView(@Nonnull com.inet.report.Engine engine, @Nullable DataFilter filter)
    Create a DataView.
    default <T> T
    get(@Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<T> key)
    Get a default value
    @Nonnull DataViewAccessList
    getAccessList()
    The groups and/or users that have access to this template.
    @Nonnull List<@Nonnull TemplateDataViewDefaults.Column>
    getAvailableColumns()
    The list of available columns.
    default @Nullable String
    getDescription()
    Get a optional description, can be localized
    default @Nonnull String
    getDisplayName()
    Get the localized displayname
    default @Nullable List<com.inet.config.structure.model.LocalizedKey>
    getFilterSuggestions(@Nonnull com.inet.report.Engine engine, @Nonnull String filterColumn, @Nonnull String filterText)
    Get optional suggestions for possible values of filter for up to 50 value suggestions for the given filter
    @Nonnull com.inet.id.GUID
    getID()
    Returns unique ID of the template.
    default @Nullable String
    getSortField(@Nonnull String name)
    Get a special sort column for the case that the display value and the sorting is different
    default <T> @Nullable String
    getString(@Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<T> key)
    Get a default value
    default boolean
    hasAccess(@Nonnull com.inet.id.GUID accountID)
    Returns whether specified user has access to this template data view.
    default void
    setSelectionFormula(@Nonnull com.inet.report.Engine engine, @Nullable DataFilter filter)
    Create the record selection formula in the Engine from the filter.

    Methods inherited from interface com.inet.plugin.NamedExtension

    getExtensionName

  • Field Details

    • TEMPLATESOURCE_KEY

      @Nonnull static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.dataview.DataViewDefinition> TEMPLATESOURCE_KEY
      The key for the JSON of a DataViewDefinition

    • TEMPLATESOURCE_DATASOURCE

      @Nonnull static final @Nonnull com.inet.report.adhoc.server.api.dataview.DataViewPropertyKey<String> TEMPLATESOURCE_DATASOURCE
      The key of datasource value inside a DataViewDefinition

    • TEMPLATESOURCE_TABLES_KEY

      @Nonnull static final @Nonnull com.inet.report.adhoc.server.api.dataview.DataViewPropertyKey<List<com.inet.config.structure.model.LocalizedKey>> TEMPLATESOURCE_TABLES_KEY
      The key of tables inside a DataViewDefinition

    • TEMPLATESOURCE_JOINS_KEY

      @Nonnull static final @Nonnull com.inet.report.adhoc.server.api.dataview.DataViewPropertyKey<List<PersistenceTemplateDataViewDefaults.Join>> TEMPLATESOURCE_JOINS_KEY
      The key of joins inside a DataViewDefinition

    • TEMPLATESOURCE_COLUMNS_KEY

      @Nonnull static final @Nonnull com.inet.report.adhoc.server.api.dataview.DataViewPropertyKey<List<com.inet.config.structure.model.LocalizedKey>> TEMPLATESOURCE_COLUMNS_KEY
      The key of columns inside a DataViewDefinition

    • ACCESS_LIST_KEY

      @Nonnull static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<List<com.inet.remote.gui.angular.usersorgroupsselection.UsersOrGroupsSelection.SelectedMember>> ACCESS_LIST_KEY
      The key for the access permissions of the template

    • FILTER_DEFINITION

      static final com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<DataFilter> FILTER_DEFINITION
      Key for initial filter

    • TABLE_COLUMNS

      @Nonnull static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.table.TableColumnData[]> TABLE_COLUMNS
      The key for initial columns of a table report on selection the template

    • TABLE_GROUPS

      @Nonnull static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.GroupData[]> TABLE_GROUPS
      The key for initial groups of a table report on selection the template

    • TABLE_SORTING

      @Nonnull static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.table.TableSortingData[]> TABLE_SORTING
      The key for initial sorting on selection the template

    • CROSSTAB_COLUMNS

      @Nonnull static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.GroupData[]> CROSSTAB_COLUMNS
      The key for initial columns of a crosstab report on selection the template

    • CROSSTAB_ROWS

      @Nonnull static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.GroupData[]> CROSSTAB_ROWS
      The key for initial rows of a crosstab report on selection the template

    • CROSSTAB_DATA

      @Nonnull static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<DataField[]> CROSSTAB_DATA
      The key for initial cells of a crosstab report on selection the template

    • CROSSTAB_GROUPS

      @Nonnull static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.GroupData[]> CROSSTAB_GROUPS
      The key for initial groups of a crosstab report on selection the template

    • CHART_CATEGORY

      @Nonnull static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.GroupData> CHART_CATEGORY
      The key for initial catagory of a char report on selection the template

    • CHART_DATA_FIELDS

      @Nonnull static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<DataField[]> CHART_DATA_FIELDS
      The key for initial data fields of a char report on selection the template

  • Method Details

    • getID

      @Nonnull @Nonnull com.inet.id.GUID getID()
      Returns unique ID of the template.
      Returns:
      uniqueID of the template.
      Since:
      25.4

    • getDisplayName

      @Nonnull default @Nonnull String getDisplayName()
      Get the localized displayname
      Returns:
      the displayname
      Since:
      25.4

    • getDescription

      @Nullable default @Nullable String getDescription()
      Get a optional description, can be localized
      Returns:
      the description
      Since:
      25.4

    • get

      @Nullable default <T> T get(@Nonnull @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<T> key)
      Get a default value
      Since:
      25.4

    • getString

      @Nullable default <T> @Nullable String getString(@Nonnull @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<T> key)
      Get a default value
      Since:
      25.4

    • getAccessList

      @Nonnull @Nonnull DataViewAccessList getAccessList()
      The groups and/or users that have access to this template. It is used from the default implementation of hasAccess(GUID), which can be override for finer check.
      Returns:
      user with permissions
      Since:
      25.4

    • hasAccess

      default boolean hasAccess(@Nonnull @Nonnull com.inet.id.GUID accountID)
      Returns whether specified user has access to this template data view.
      Parameters:
      accountID - ID of user account.
      Returns:
      whether specified user has access to data view.
      Since:
      25.4

    • getAvailableColumns

      @Nonnull @Nonnull List<@Nonnull TemplateDataViewDefaults.Column> getAvailableColumns()
      The list of available columns. It must contains minimum one field.
      Returns:
      the columns
      Since:
      25.4

    • createDataView

      @Nonnull @Nonnull DataView createDataView(@Nonnull @Nonnull com.inet.report.Engine engine, @Nullable @Nullable DataFilter filter)
      Create a DataView. This means to add data definition to the given Engine
      Parameters:
      engine - sub/main engine for a specific renderer format
      filter - the saved filter definition
      Returns:
      the DataView
      Since:
      25.4

    • setSelectionFormula

      default void setSelectionFormula(@Nonnull @Nonnull com.inet.report.Engine engine, @Nullable @Nullable DataFilter filter) throws com.inet.report.ReportException
      Create the record selection formula in the Engine from the filter.
      Parameters:
      engine - the engine
      filter - the saved filter definition
      Throws:
      com.inet.report.ReportException - should not occur
      Since:
      25.4

    • getFilterSuggestions

      @Nullable default @Nullable List<com.inet.config.structure.model.LocalizedKey> getFilterSuggestions(@Nonnull @Nonnull com.inet.report.Engine engine, @Nonnull @Nonnull String filterColumn, @Nonnull @Nonnull String filterText)
      Get optional suggestions for possible values of filter for up to 50 value suggestions for the given filter
      Parameters:
      engine - engine with data source settings
      filterColumn - the column of the filter
      filterText - the entered filter text
      Returns:
      the suggestions or null if the default should be used
      Since:
      25.4

    • applySpecialFormat

      default void applySpecialFormat(@Nonnull @Nonnull com.inet.report.FieldElement el) throws com.inet.report.ReportException
      Apply special formats like text interpretation from the template
      Parameters:
      el - the field element with all formats
      Throws:
      com.inet.report.ReportException - if any error occur with the reporting API
      Since:
      25.4

    • getSortField

      @Nullable default @Nullable String getSortField(@Nonnull @Nonnull String name)
      Get a special sort column for the case that the display value and the sorting is different
      Parameters:
      name - the field for sorting and grouping
      Returns:
      the sorting field or null if default behavior
      Since:
      25.10