Class PersistenceTemplateDataViewDefaults

java.lang.Object
com.inet.report.adhoc.server.api.dataview.PersistenceTemplateDataViewDefaults
All Implemented Interfaces:
com.inet.plugin.NamedExtension, TemplateDataViewDefaults

@JsonData public class PersistenceTemplateDataViewDefaults extends Object implements TemplateDataViewDefaults
A TemplateDataViewDefaults that can be saved in the persistence.
  • Constructor Details

    • PersistenceTemplateDataViewDefaults

      public PersistenceTemplateDataViewDefaults(@Nonnull @Nonnull com.inet.id.GUID id, @Nonnull @Nonnull String name, String description, @Nonnull @Nonnull DataViewAccessList accessList, @Nonnull @Nonnull Map<com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<?>,String> properties)
      Create the saved defaults of a data view. In the properties you can use the follow keys:

      for all components

      • TEMPLATESOURCE_KEY
      • FILTER_DEFINITION
      for tables:
      • TABLE_COLUMNS
      • TABLE_GROUPS
      • TABLE_SORTING
      for crosstab:
      • CROSSTAB_COLUMNS
      • CROSSTAB_ROWS
      • CROSSTAB_DATA
      • CROSSTAB_GROUPS
      for charts:
      • CHART_CATEGORY
      • CHART_DATA_FIELDS
      Parameters:
      id - ID of the template, which is used as save key.
      name - the unique display name
      description - optional description
      accessList - the the user/groups with access
      properties - the properties
      Since:
      25.4
  • Method Details

    • getID

      @Nonnull public @Nonnull com.inet.id.GUID getID()
      Returns unique ID of the template.
      Specified by:
      getID in interface TemplateDataViewDefaults
      Returns:
      uniqueID of the template.
    • getProperties

      @Nonnull public @Nonnull Map<com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<?>,String> getProperties()
      Get the saved properties from the template
      Returns:
      the properties
      Since:
      25.4
    • getExtensionName

      @Nonnull public @Nonnull String getExtensionName()
      Specified by:
      getExtensionName in interface com.inet.plugin.NamedExtension
    • getDescription

      @Nullable public @Nullable String getDescription()
      Get a optional description, can be localized
      Specified by:
      getDescription in interface TemplateDataViewDefaults
      Returns:
      the description
    • getString

      @Nullable public <T> @Nullable String getString(@Nonnull @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<T> key)
      Get a default value
      Specified by:
      getString in interface TemplateDataViewDefaults
    • getAccessList

      @Nonnull public @Nonnull DataViewAccessList getAccessList()
      The groups and/or users that have access to this template.
      Specified by:
      getAccessList in interface TemplateDataViewDefaults
      Returns:
      user with permissions
    • getAvailableColumns

      @Nonnull public @Nonnull List<@Nonnull TemplateDataViewDefaults.Column> getAvailableColumns()
      The list of available columns. It must contains minimum one field.
      Specified by:
      getAvailableColumns in interface TemplateDataViewDefaults
      Returns:
      the columns
    • createDataView

      @Nonnull public @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
      Specified by:
      createDataView in interface TemplateDataViewDefaults
      Parameters:
      engine - sub/main engine for a specific renderer format
      filter - the saved filter definition
      Returns:
      the DataView
    • hashCode

      public int hashCode()
      AUTO-GENERATED
      Overrides:
      hashCode in class Object
    • equals

      public boolean equals(@Nullable @Nullable Object obj)
      AUTO-GENERATED
      Overrides:
      equals in class Object