Class DesignerDataSourceRegistry
- java.lang.Object
-
- com.inductiveautomation.reporting.designer.api.DesignerDataSourceRegistry
-
public final class DesignerDataSourceRegistry extends java.lang.Object
This registry holds the data source configuration datasources that have been registered on the designer. Authors who want to create new reporting data sources or queries must register aDataSourceConfigFactory
orQueryConfigFactory
with this registry, as well as a ReportDataSource on the gateway.- Since:
- 7.8.0
-
-
Constructor Summary
Constructors Constructor Description DesignerDataSourceRegistry()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.google.common.base.Optional<DataSourceConfigFactory>
findDataSource(java.lang.String id)
Look up a datasource factory by IDcom.google.common.base.Optional<QueryConfigFactory>
findQueryType(java.lang.String id)
Look up a query factory by IDstatic DesignerDataSourceRegistry
get(DesignerContext context)
This is how you get an instance of the registry.java.lang.Iterable<DataSourceConfigFactory>
getDataSources()
Find all of the datasources that have been registeredjava.lang.Iterable<QueryConfigFactory>
getQueryTypes()
Find all of the query types that have been registeredvoid
register(DataSourceConfigFactory factory)
Register your data source config factory here.void
register(QueryConfigFactory factory)
Register your query type factory herecom.google.common.base.Optional<DataSourceConfigFactory>
unregisterDataSource(java.lang.String id)
com.google.common.base.Optional<QueryConfigFactory>
unregisterQueryType(java.lang.String id)
-
-
-
Method Detail
-
get
public static DesignerDataSourceRegistry get(DesignerContext context)
This is how you get an instance of the registry.
-
register
public void register(DataSourceConfigFactory factory)
Register your data source config factory here.
-
register
public void register(QueryConfigFactory factory)
Register your query type factory here
-
unregisterDataSource
public com.google.common.base.Optional<DataSourceConfigFactory> unregisterDataSource(java.lang.String id)
-
unregisterQueryType
public com.google.common.base.Optional<QueryConfigFactory> unregisterQueryType(java.lang.String id)
-
findDataSource
public com.google.common.base.Optional<DataSourceConfigFactory> findDataSource(java.lang.String id)
Look up a datasource factory by ID
-
findQueryType
public com.google.common.base.Optional<QueryConfigFactory> findQueryType(java.lang.String id)
Look up a query factory by ID
-
getDataSources
public java.lang.Iterable<DataSourceConfigFactory> getDataSources()
Find all of the datasources that have been registered
-
getQueryTypes
public java.lang.Iterable<QueryConfigFactory> getQueryTypes()
Find all of the query types that have been registered
-
-