org.apache.storm.elasticsearch.common

Interface EsTupleMapper

All Superinterfaces:

Serializable

All Known Implementing Classes:

DefaultEsTupleMapper

public interface EsTupleMapper
extends Serializable

TupleMapper defines how to extract source, index, type, and id from tuple for ElasticSearch.

Method Summary

Modifier and Type	Method and Description
String	getId(ITuple tuple) Extracts id from tuple.
String	getIndex(ITuple tuple) Extracts index from tuple.
Map<String,String>	getParams(ITuple tuple, Map<String,String> defaultValue) Extracts params from tuple if available.
String	getSource(ITuple tuple) Extracts source from tuple.
String	getType(ITuple tuple) Extracts type from tuple.

Method Detail

getSource

String getSource(ITuple tuple)

Extracts source from tuple.

Parameters:

tuple - source tuple

Returns:

source

getIndex

String getIndex(ITuple tuple)

Extracts index from tuple.

Parameters:

tuple - source tuple

Returns:

index

getType

String getType(ITuple tuple)

Extracts type from tuple.

Parameters:

tuple - source tuple

Returns:

type

getId

String getId(ITuple tuple)

Extracts id from tuple.

Parameters:

tuple - source tuple

Returns:

id

getParams

Map<String,String> getParams(ITuple tuple,
                             Map<String,String> defaultValue)

Extracts params from tuple if available.

Parameters:

tuple - source tuple

defaultValue - value to return if params are missing

Returns:

params