Package io.siddhi.core.stream.output.sink

Class SinkMapper

java.lang.Object

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

Direct Known Subclasses:

PassThroughSinkMapper

public abstract class SinkMapper
extends Object

Abstract parent class to represent event mappers. Events mappers will receive Events and can convert them to any desired object type (Ex: XML, JSON). Custom mappers can be implemented as extensions extending this abstract implementation.

Field Summary

Fields

Modifier and Type	Field	Description
protected OptionHolder	sinkOptionHolder
protected String	sinkType

Constructor Summary

Constructors

Constructor	Description
SinkMapper()

Method Summary

Modifier and Type	Method	Description
protected void	buildMapperTemplate(io.siddhi.query.api.definition.StreamDefinition streamDefinition, List<io.siddhi.query.api.annotation.Element> unmappedPayloadList)	Method to create mapper template.
abstract Class[]	getOutputEventClasses()	Get produced event class types
abstract String[]	getSupportedDynamicOptions()	Supported dynamic options by the mapper
String	getType()
abstract void	init(io.siddhi.query.api.definition.StreamDefinition streamDefinition, OptionHolder optionHolder, Map<String,TemplateBuilder> payloadTemplateBuilderMap, ConfigReader mapperConfigReader, SiddhiAppContext siddhiAppContext)	Initialize the mapper and the mapping configurations.
void	init(io.siddhi.query.api.definition.StreamDefinition streamDefinition, String type, OptionHolder mapOptionHolder, List<io.siddhi.query.api.annotation.Element> unmappedPayloadList, Sink sink, ConfigReader mapperConfigReader, LatencyTracker mapperLatencyTracker, OptionHolder sinkOptionHolder, SiddhiAppContext siddhiAppContext)
abstract void	mapAndSend(Event[] events, OptionHolder optionHolder, Map<String,TemplateBuilder> payloadTemplateBuilderMap, SinkListener sinkListener)	Called to map the events and send them to SinkListener for publishing
abstract void	mapAndSend(Event event, OptionHolder optionHolder, Map<String,TemplateBuilder> payloadTemplateBuilderMap, SinkListener sinkListener)	Called to map the event and send it to SinkListener for publishing
void	setGroupDeterminer(OutputGroupDeterminer groupDeterminer)

Methods inherited from class java.lang.Object

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

Field Detail

sinkType

protected String sinkType

sinkOptionHolder

protected OptionHolder sinkOptionHolder

Constructor Detail

SinkMapper

public SinkMapper()

Method Detail

init

public final void init(io.siddhi.query.api.definition.StreamDefinition streamDefinition,
                       String type,
                       OptionHolder mapOptionHolder,
                       List<io.siddhi.query.api.annotation.Element> unmappedPayloadList,
                       Sink sink,
                       ConfigReader mapperConfigReader,
                       LatencyTracker mapperLatencyTracker,
                       OptionHolder sinkOptionHolder,
                       SiddhiAppContext siddhiAppContext)

buildMapperTemplate

protected void buildMapperTemplate(io.siddhi.query.api.definition.StreamDefinition streamDefinition,
                                   List<io.siddhi.query.api.annotation.Element> unmappedPayloadList)

Method to create mapper template.

Parameters:

streamDefinition - Stream definition corresponding to mapper

unmappedPayloadList - mapper payload template list

getSupportedDynamicOptions

public abstract String[] getSupportedDynamicOptions()

Supported dynamic options by the mapper

Returns:

the list of supported dynamic option keys

init

public abstract void init(io.siddhi.query.api.definition.StreamDefinition streamDefinition,
                          OptionHolder optionHolder,
                          Map<String,TemplateBuilder> payloadTemplateBuilderMap,
                          ConfigReader mapperConfigReader,
                          SiddhiAppContext siddhiAppContext)

Initialize the mapper and the mapping configurations.

Parameters:

streamDefinition - The stream definition

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

payloadTemplateBuilderMap - Un mapped payloads for reference

mapperConfigReader - System configuration reader for Sink-mapper.

siddhiAppContext - Siddhi Application Context

getOutputEventClasses

public abstract Class[] getOutputEventClasses()

Get produced event class types

Returns:

Array of classes that will be produced by the sink-mapper, null or empty array if it can produce any type of class.

mapAndSend

public abstract void mapAndSend(Event[] events,
                                OptionHolder optionHolder,
                                Map<String,TemplateBuilder> payloadTemplateBuilderMap,
                                SinkListener sinkListener)

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

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 payloads based on the given templates

sinkListener - SinkListener that will be called with the mapped events

mapAndSend

public abstract void mapAndSend(Event event,
                                OptionHolder optionHolder,
                                Map<String,TemplateBuilder> payloadTemplateBuilderMap,
                                SinkListener sinkListener)

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

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 payloads based on the given templates

sinkListener - SinkListener that will be called with the mapped event

getType

public final String getType()

setGroupDeterminer

public final void setGroupDeterminer(OutputGroupDeterminer groupDeterminer)