Package com.inductiveautomation.reporting.designer.api

Interface DataSourceConfigFactory

All Known Implementing Classes:
AbstractDataSourceConfigFactory
public interface DataSourceConfigFactory
This is the designer-scoped interface that 3rd party module authors need to implement to add new data sources. If you create a new instance of this class, make sure and register it with the DesignerDataSourceRegistry
Since:
7.8.0

  • Method Details

    • getId

      String getId()
      Return a unique ID for this type of datasource. Must match the ID of a ReportDataSource registered in the Gateway

    • getDisplayName

      String getDisplayName()
      A human friendly name for this type of data source

    • getSmallIcon

      Icon getSmallIcon()
      An optional small (16x16) icon representing your data source type

    • newConfigObject

      DataSourceConfigObject newConfigObject()
      Create a new, unconfigured copy of the object used to store the configuration of an instance of this data source. Must not return null.

    • createConfigPanel

      DataSourceConfigPanel createConfigPanel(DesignerContext context, ReportResource report, DataSourceConfigObject configObject)
      Create a new DataSourceConfigPanel which will be used to display and alter the configuration of a config object.

    • getDataKeyForConfigObject

      com.google.common.base.Optional<String> getDataKeyForConfigObject(DataSourceConfig config)
      Returns the top level data key for this data source