Package com.inductiveautomation.eventstream.designer.api

Class EventStreamContext

java.lang.Object

com.inductiveautomation.eventstream.designer.api.EventStreamContext

public class EventStreamContext
extends Object

Constructor Summary

Constructors

Constructor	Description
EventStreamContext(DesignerContext designerContext, ResourcePath resourcePath, EventStreamRpc rpc)

Method Summary

Modifier and Type	Method	Description
DesignerContext	designerContext()
FunctionFactory	functionFactory()
List<String>	listDatasources()
List<String>	listEventStreams(String projectName)
protected List<String>	listProjects()
List<String>	listProjectsOrdered()
List<String>	listTableColumns(String datasource, String tableName)
List<String>	listTables(String datasourceName)
List<String>	listUserSources()
ResourcePath	resourcePath()
EventStreamRpc	rpc()

Methods inherited from class java.lang.Object

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

Constructor Details

EventStreamContext

public EventStreamContext(DesignerContext designerContext,
 ResourcePath resourcePath,
 EventStreamRpc rpc)

Method Details

functionFactory

public FunctionFactory functionFactory()

designerContext

public DesignerContext designerContext()

resourcePath

public ResourcePath resourcePath()

rpc

public EventStreamRpc rpc()

listProjects

protected List<String> listProjects()

Returns:

List of projects

listProjectsOrdered

public List<String> listProjectsOrdered()
                                 throws Exception

Returns:

List of projects ordered

Throws:

Exception

listEventStreams

public List<String> listEventStreams(String projectName)

Returns:

Ordered list of Event Streams

listDatasources

public List<String> listDatasources()
                             throws Exception

Returns:

List of data sources

Throws:

Exception - If unable to retrieve the list from the Gateway an exception will be thrown

listTables

public List<String> listTables(String datasourceName)
                        throws Exception

Parameters:

datasourceName - The name of the datasource for which the list of tables is retrieved

Returns:

List of tables for datasourceName

Throws:

Exception - If unable to retrieve the list from the Gateway

listTableColumns

public List<String> listTableColumns(String datasource,
 String tableName)
                              throws Exception

Parameters:

datasource - The name of the datasource in which the tableName can be found

tableName - The name of the table to retrieve a list of columns

Returns:

List of table columns for the table specified in tableName

Throws:

Exception - If unable to retrieve the list from the Gateway

listUserSources

@Nonnull
public List<String> listUserSources()
                             throws Exception

Returns:

List of user sources.

Throws:

Exception - If unable to retrieve the list from the Gateway