io.siddhi.extension.map.csv.sinkmapper

Class CSVSinkMapper

java.lang.Object

io.siddhi.core.stream.output.sink.SinkMapper

io.siddhi.extension.map.csv.sinkmapper.CSVSinkMapper

public class CSVSinkMapper
extends io.siddhi.core.stream.output.sink.SinkMapper

The CSV output mapper class will convert a Siddhi Event to CSV format.

Constructor Summary

Constructors

Constructor and Description
CSVSinkMapper()

Method Summary

Modifier and Type	Method and Description
Class[]	getOutputEventClasses() Returns the list of classes which this sink can consume.
String[]	getSupportedDynamicOptions() Returns a list of supported dynamic options by the transport
void	init(io.siddhi.query.api.definition.StreamDefinition streamDefinition, io.siddhi.core.util.transport.OptionHolder optionHolder, Map<String,io.siddhi.core.util.transport.TemplateBuilder> payloadTemplateBuilderMap, io.siddhi.core.util.config.ConfigReader configReader, io.siddhi.core.config.SiddhiAppContext siddhiAppContext) The initialization method for SinkMapper
void	mapAndSend(io.siddhi.core.event.Event[] events, io.siddhi.core.util.transport.OptionHolder optionHolder, Map<String,io.siddhi.core.util.transport.TemplateBuilder> payloadTemplateBuilderMap, io.siddhi.core.stream.output.sink.SinkListener sinkListener) Method to map the events and send them to SinkListener for publishing
void	mapAndSend(io.siddhi.core.event.Event event, io.siddhi.core.util.transport.OptionHolder optionHolder, Map<String,io.siddhi.core.util.transport.TemplateBuilder> payloadTemplateBuilderMap, io.siddhi.core.stream.output.sink.SinkListener sinkListener) Method to map the event and send it to SinkListener for publishing

Methods inherited from class io.siddhi.core.stream.output.sink.SinkMapper

getType, init, setGroupDeterminer

Methods inherited from class java.lang.Object

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

Constructor Detail

CSVSinkMapper

public CSVSinkMapper()

Method Detail

getSupportedDynamicOptions

public String[] getSupportedDynamicOptions()

Returns a list of supported dynamic options by the transport

Specified by:

getSupportedDynamicOptions in class io.siddhi.core.stream.output.sink.SinkMapper

Returns:

the list of supported dynamic option keys

init

public void init(io.siddhi.query.api.definition.StreamDefinition streamDefinition,
                 io.siddhi.core.util.transport.OptionHolder optionHolder,
                 Map<String,io.siddhi.core.util.transport.TemplateBuilder> payloadTemplateBuilderMap,
                 io.siddhi.core.util.config.ConfigReader configReader,
                 io.siddhi.core.config.SiddhiAppContext siddhiAppContext)

The initialization method for SinkMapper

Specified by:

init in class io.siddhi.core.stream.output.sink.SinkMapper

Parameters:

streamDefinition - containing stream definition bind to the SinkMapper

optionHolder - Option holder containing static and dynamic configuration related to the SinkMapper

payloadTemplateBuilderMap - Unmapped payload for reference

configReader - to read the sink related system configuration.

siddhiAppContext - the context of the SiddhiApp used to get siddhi related utilty functions.

getOutputEventClasses

public Class[] getOutputEventClasses()

Returns the list of classes which this sink can consume.

Specified by:

getOutputEventClasses in class io.siddhi.core.stream.output.sink.SinkMapper

Returns:

String array of supported classes. array .

mapAndSend

public void mapAndSend(io.siddhi.core.event.Event[] events,
                       io.siddhi.core.util.transport.OptionHolder optionHolder,
                       Map<String,io.siddhi.core.util.transport.TemplateBuilder> payloadTemplateBuilderMap,
                       io.siddhi.core.stream.output.sink.SinkListener sinkListener)

Method to map the events and send them to SinkListener for publishing

Specified by:

mapAndSend in class io.siddhi.core.stream.output.sink.SinkMapper

Parameters:

events - Events that need to be mapped

optionHolder - Option holder containing static and dynamic options related to the mapper

payloadTemplateBuilderMap - To build the message payload based on the given template

sinkListener - SinkListener that will be called with the mapped events

mapAndSend

public void mapAndSend(io.siddhi.core.event.Event event,
                       io.siddhi.core.util.transport.OptionHolder optionHolder,
                       Map<String,io.siddhi.core.util.transport.TemplateBuilder> payloadTemplateBuilderMap,
                       io.siddhi.core.stream.output.sink.SinkListener sinkListener)

Method to map the event and send it to SinkListener for publishing

Specified by:

mapAndSend in class io.siddhi.core.stream.output.sink.SinkMapper

Parameters:

event - Event that need to be mapped

optionHolder - Option holder containing static and dynamic options related to the mapper

payloadTemplateBuilderMap - To build the message payload based on the given template

sinkListener - SinkListener that will be called with the mapped event