Package com.inductiveautomation.reporting.designer.api

Class DesignerDataSourceRegistry

java.lang.Object

com.inductiveautomation.reporting.designer.api.DesignerDataSourceRegistry

public final class DesignerDataSourceRegistry
extends 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 a DataSourceConfigFactory or QueryConfigFactory with this registry, as well as a ReportDataSource on the gateway.

Since:

7.8.0

Constructor Summary

Constructors

Constructor	Description
DesignerDataSourceRegistry()

Method Summary

Modifier and Type	Method	Description
com.google.common.base.Optional<DataSourceConfigFactory>	findDataSource(String id)	Look up a datasource factory by ID
com.google.common.base.Optional<QueryConfigFactory>	findQueryType(String id)	Look up a query factory by ID
static DesignerDataSourceRegistry	get(DesignerContext context)	This is how you get an instance of the registry.
Iterable<DataSourceConfigFactory>	getDataSources()	Find all of the datasources that have been registered
Iterable<QueryConfigFactory>	getQueryTypes()	Find all of the query types that have been registered
void	register(DataSourceConfigFactory factory)	Register your data source config factory here.
void	register(QueryConfigFactory factory)	Register your query type factory here
com.google.common.base.Optional<DataSourceConfigFactory>	unregisterDataSource(String id)
com.google.common.base.Optional<QueryConfigFactory>	unregisterQueryType(String id)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DesignerDataSourceRegistry

public DesignerDataSourceRegistry()

Method Details

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(String id)

unregisterQueryType

public com.google.common.base.Optional<QueryConfigFactory> unregisterQueryType(String id)

findDataSource

public com.google.common.base.Optional<DataSourceConfigFactory> findDataSource(String id)

Look up a datasource factory by ID

findQueryType

public com.google.common.base.Optional<QueryConfigFactory> findQueryType(String id)

Look up a query factory by ID

getDataSources

public Iterable<DataSourceConfigFactory> getDataSources()

Find all of the datasources that have been registered

getQueryTypes

public Iterable<QueryConfigFactory> getQueryTypes()

Find all of the query types that have been registered