public abstract class SinkMapper extends Object
Event
s and can convert them
to any desired object type (Ex: XML, JSON). Custom mappers can be implemented as extensions extending this
abstract implementation.Modifier and Type | Field and Description |
---|---|
protected OptionHolder |
sinkOptionHolder |
protected String |
sinkType |
Constructor and Description |
---|
SinkMapper() |
Modifier and Type | Method and 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) |
protected String sinkType
protected OptionHolder sinkOptionHolder
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)
protected void buildMapperTemplate(io.siddhi.query.api.definition.StreamDefinition streamDefinition, List<io.siddhi.query.api.annotation.Element> unmappedPayloadList)
streamDefinition
- Stream definition corresponding to mapperunmappedPayloadList
- mapper payload template listpublic abstract String[] getSupportedDynamicOptions()
public abstract void init(io.siddhi.query.api.definition.StreamDefinition streamDefinition, OptionHolder optionHolder, Map<String,TemplateBuilder> payloadTemplateBuilderMap, ConfigReader mapperConfigReader, SiddhiAppContext siddhiAppContext)
streamDefinition
- The stream definitionoptionHolder
- Option holder containing static and dynamic options related to the mapperpayloadTemplateBuilderMap
- Un mapped payloads for referencemapperConfigReader
- System configuration reader for Sink-mapper.siddhiAppContext
- Siddhi Application Contextpublic abstract Class[] getOutputEventClasses()
public abstract void mapAndSend(Event[] events, OptionHolder optionHolder, Map<String,TemplateBuilder> payloadTemplateBuilderMap, SinkListener sinkListener)
SinkListener
for publishingevents
- Event
s that need to be mappedoptionHolder
- Option holder containing static and dynamic options related to the mapperpayloadTemplateBuilderMap
- To build the message payloads based on the given templatessinkListener
- SinkListener
that will be called with the mapped eventspublic abstract void mapAndSend(Event event, OptionHolder optionHolder, Map<String,TemplateBuilder> payloadTemplateBuilderMap, SinkListener sinkListener)
SinkListener
for publishingevent
- Event
that need to be mappedoptionHolder
- Option holder containing static and dynamic options related to the mapperpayloadTemplateBuilderMap
- To build the message payloads based on the given templatessinkListener
- SinkListener
that will be called with the mapped eventpublic final String getType()
public final void setGroupDeterminer(OutputGroupDeterminer groupDeterminer)
Copyright © 2021. All rights reserved.