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 Detail

      • getId

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

        java.lang.String getDisplayName()
        A human friendly name for this type of data source
      • getSmallIcon

        javax.swing.Icon getSmallIcon()
        An optional small (16x16) icon representing your data source type
      • newConfigObject

        java.io.Serializable 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. This object must be both java.io.Serializable and XML serializable (public constructor, getter/setter pairs)
      • getDataKeyForConfigObject

        com.google.common.base.Optional getDataKeyForConfigObject​(java.io.Serializable configObject)
        Returns the top level data key for this data source