SiddhiOperatorContext (flink-siddhi 1.2-SNAPSHOT API)

java.lang.Object
- org.apache.flink.contrib.siddhi.operator.SiddhiOperatorContext

All Implemented Interfaces:

Serializable
```
public class SiddhiOperatorContext
extends Object
implements Serializable
```
SiddhiCEP Operator Context Metadata including input/output stream (streamId, TypeInformation) as well execution plan query, and execution environment context like TimeCharacteristic and ExecutionConfig.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

SiddhiOperatorContext()

Constructors
Constructor and Description
`SiddhiOperatorContext()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.wso2.siddhi.core.SiddhiManager`	`createSiddhiManager()`
`org.apache.flink.api.common.ExecutionConfig`	`getExecutionConfig()`
`String`	`getExecutionPlan()`
`Map<String,Class<?>>`	`getExtensions()`
`String`	`getFinalExecutionPlan()` Stream definition + execution expression
`List<String>`	`getInputStreams()`
`<IN> StreamSchema<IN>`	`getInputStreamSchema(String inputStreamId)`
`Map<String,SiddhiStreamSchema<?>>`	`getInputStreamSchemas()`
`String`	`getName()`
`String`	`getOutputStreamId()`
`org.apache.flink.api.common.typeinfo.TypeInformation`	`getOutputStreamType()`
`org.apache.flink.streaming.api.TimeCharacteristic`	`getTimeCharacteristic()`
`void`	`setExecutionConfig(org.apache.flink.api.common.ExecutionConfig executionConfig)`
`void`	`setExecutionPlan(String executionPlan)`
`void`	`setExtensions(Map<String,Class<?>> extensions)`
`void`	`setInputStreamSchemas(Map<String,SiddhiStreamSchema<?>> inputStreamSchemas)`
`void`	`setName(String name)`
`void`	`setOutputStreamId(String outputStreamId)`
`void`	`setOutputStreamType(org.apache.flink.api.common.typeinfo.TypeInformation outputStreamType)`
`void`	`setTimeCharacteristic(org.apache.flink.streaming.api.TimeCharacteristic timeCharacteristic)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SiddhiOperatorContext
```
public SiddhiOperatorContext()
```
- Method Detail
  - setExtensions
```
public void setExtensions(Map<String,Class<?>> extensions)
```
    Parameters:
    
    extensions - siddhi extensions to register
  - getExtensions
```
public Map<String,Class<?>> getExtensions()
```
    Returns:
    
    registered siddhi extensions
  - getName
```
public String getName()
```
    Returns:
    
    Siddhi Stream Operator Name in format of "Siddhi: execution query ... (query length)"
  - getInputStreams
```
public List<String> getInputStreams()
```
    Returns:
    
    Source siddhi stream IDs
  - getExecutionPlan
```
public String getExecutionPlan()
```
    Returns:
    
    Siddhi CEP sql-like execution plan
  - getFinalExecutionPlan
```
public String getFinalExecutionPlan()
```
    Stream definition + execution expression
  - getOutputStreamType
```
public org.apache.flink.api.common.typeinfo.TypeInformation getOutputStreamType()
```
    Returns:
    
    Siddhi Stream Operator output type information
  - getOutputStreamId
```
public String getOutputStreamId()
```
    Returns:
    
    Siddhi output streamId for callback
  - getInputStreamSchema
```
public <IN> StreamSchema<IN> getInputStreamSchema(String inputStreamId)
```
    Parameters:
    
    inputStreamId - Siddhi streamId
    
    Returns:
    
    StreamSchema for given siddhi streamId
    
    Throws:
    
    UndefinedStreamException - throws if stream is not defined
  - setOutputStreamId
```
public void setOutputStreamId(String outputStreamId)
```
    Parameters:
    
    outputStreamId - Siddhi output streamId, which must exist in siddhi execution plan
  - setOutputStreamType
```
public void setOutputStreamType(org.apache.flink.api.common.typeinfo.TypeInformation outputStreamType)
```
    Parameters:
    
    outputStreamType - Output stream TypeInformation
  - getTimeCharacteristic
```
public org.apache.flink.streaming.api.TimeCharacteristic getTimeCharacteristic()
```
    Returns:
    
    Returns execution environment TimeCharacteristic
  - setTimeCharacteristic
```
public void setTimeCharacteristic(org.apache.flink.streaming.api.TimeCharacteristic timeCharacteristic)
```
  - setExecutionPlan
```
public void setExecutionPlan(String executionPlan)
```
    Parameters:
    
    executionPlan - Siddhi SQL-Like exeuction plan query
  - getInputStreamSchemas
```
public Map<String,SiddhiStreamSchema<?>> getInputStreamSchemas()
```
    Returns:
    
    Returns input stream ID and schema mapping
  - setInputStreamSchemas
```
public void setInputStreamSchemas(Map<String,SiddhiStreamSchema<?>> inputStreamSchemas)
```
    Parameters:
    
    inputStreamSchemas - input stream ID and schema mapping
  - setName
```
public void setName(String name)
```
  - createSiddhiManager
```
public org.wso2.siddhi.core.SiddhiManager createSiddhiManager()
```
    Returns:
    
    Created new SiddhiManager instance with registered siddhi extensions
  - getExecutionConfig
```
public org.apache.flink.api.common.ExecutionConfig getExecutionConfig()
```
    Returns:
    
    StreamExecutionEnvironment ExecutionConfig
  - setExecutionConfig
```
public void setExecutionConfig(org.apache.flink.api.common.ExecutionConfig executionConfig)
```
    Parameters:
    
    executionConfig - StreamExecutionEnvironment ExecutionConfig

Class SiddhiOperatorContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SiddhiOperatorContext

Method Detail

setExtensions

getExtensions

getName

getInputStreams

getExecutionPlan

getFinalExecutionPlan

getOutputStreamType

getOutputStreamId

getInputStreamSchema

setOutputStreamId

setOutputStreamType

getTimeCharacteristic

setTimeCharacteristic

setExecutionPlan

getInputStreamSchemas

setInputStreamSchemas

setName

createSiddhiManager

getExecutionConfig

setExecutionConfig