org.wso2.siddhi.core.stream.input.source

Class SourceMapper

java.lang.Object

org.wso2.siddhi.core.stream.input.source.SourceMapper

All Implemented Interfaces:

SourceEventListener

Direct Known Subclasses:

PassThroughSourceMapper

public abstract class SourceMapper
extends Object
implements SourceEventListener

Convert custom input from Source to ComplexEventChunk.

Constructor Summary

Constructors

Constructor and Description
SourceMapper()

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	allowNullInTransportProperties() Method used by SourceMapper to determine on how to handle transport properties with null values.
SourceHandler	getHandler()
org.wso2.siddhi.query.api.definition.StreamDefinition	getStreamDefinition()
abstract Class[]	getSupportedInputEventClasses() Support classes that the source-mapper can consume for mapping processing (used for validation purposes)
abstract void	init(org.wso2.siddhi.query.api.definition.StreamDefinition streamDefinition, OptionHolder optionHolder, List<AttributeMapping> attributeMappingList, ConfigReader configReader, SiddhiAppContext siddhiAppContext) Initialize Source-mapper
void	init(org.wso2.siddhi.query.api.definition.StreamDefinition streamDefinition, String mapType, OptionHolder mapOptionHolder, List<AttributeMapping> attributeMappings, String sourceType, List<AttributeMapping> transportMappings, SourceHandler sourceHandler, ConfigReader configReader, SiddhiAppContext siddhiAppContext)
protected abstract void	mapAndProcess(Object eventObject, InputEventHandler inputEventHandler) Method to map the incoming event and as pass that via inputEventHandler to process further.
void	onEvent(Object eventObject, String[] transportProperties)
void	setInputHandler(InputHandler inputHandler)

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceMapper

public SourceMapper()

Method Detail

init

public final void init(org.wso2.siddhi.query.api.definition.StreamDefinition streamDefinition,
                       String mapType,
                       OptionHolder mapOptionHolder,
                       List<AttributeMapping> attributeMappings,
                       String sourceType,
                       List<AttributeMapping> transportMappings,
                       SourceHandler sourceHandler,
                       ConfigReader configReader,
                       SiddhiAppContext siddhiAppContext)

init

public abstract void init(org.wso2.siddhi.query.api.definition.StreamDefinition streamDefinition,
                          OptionHolder optionHolder,
                          List<AttributeMapping> attributeMappingList,
                          ConfigReader configReader,
                          SiddhiAppContext siddhiAppContext)

Initialize Source-mapper

Parameters:

streamDefinition - Associated output stream definition

optionHolder - Mapper option holder

attributeMappingList - Custom attribute mapping for source-mapping

configReader - System configuration reader

siddhiAppContext - Siddhi application context

getSupportedInputEventClasses

public abstract Class[] getSupportedInputEventClasses()

Support classes that the source-mapper can consume for mapping processing (used for validation purposes)

Returns:

Supported event classes that mapper can process.

setInputHandler

public final void setInputHandler(InputHandler inputHandler)

onEvent

public final void onEvent(Object eventObject,
                          String[] transportProperties)

Specified by:

onEvent in interface SourceEventListener

getHandler

public SourceHandler getHandler()

getStreamDefinition

public final org.wso2.siddhi.query.api.definition.StreamDefinition getStreamDefinition()

Specified by:

getStreamDefinition in interface SourceEventListener

mapAndProcess

protected abstract void mapAndProcess(Object eventObject,
                                      InputEventHandler inputEventHandler)
                               throws InterruptedException

Method to map the incoming event and as pass that via inputEventHandler to process further.

Parameters:

eventObject - Incoming event Object

inputEventHandler - Handler to pass the converted Siddhi Event for processing

Throws:

InterruptedException - Throws InterruptedException

allowNullInTransportProperties

protected abstract boolean allowNullInTransportProperties()

Method used by SourceMapper to determine on how to handle transport properties with null values. If this returns 'false' then SourceMapper will drop any event/s with null transport property values. If this returns 'true' then SourceMapper will send events even though they contains null transport properties. This method will be called after init().

Returns:

whether SourceMapper should allow or drop events when transport properties are null.