org.xbib.elasticsearch.river.jdbc

Interface RiverFlow<RC extends RiverContext>

Type Parameters:

RC -

All Known Implementing Classes:

ColumnRiverFlow, SimpleRiverFlow

public interface RiverFlow<RC extends RiverContext>

A RiverFlow is the controlling component for creatin RiverContexts which can be processed independently from each other. By doing this, RiverContexts can be processed

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(RC riverContext) Execute this river flow
org.elasticsearch.client.Client	getClient() Get the client
org.elasticsearch.common.metrics.MeterMetric	getMetric() Get metric
Queue<RiverContext>	getQueue() Get queue for RiverContext processing
org.elasticsearch.river.RiverName	getRiverName() Gets the river name
org.elasticsearch.common.settings.Settings	getSettings() Get the settings
void	logMetrics(RiverContext riverContext, String cause) Log metrics
RiverFlow<RC>	newInstance()
RC	newRiverContext() Create a new river context for a river run
RiverFlow	setClient(org.elasticsearch.client.Client client)
RiverFlow	setIngestFactory(IngestFactory ingestFactory) Set ingest factory
RiverFlow	setMetric(org.elasticsearch.common.metrics.MeterMetric meterMetric) Set metric
RiverFlow	setQueue(Queue<RiverContext> queue) Set queue for processing RiverContext requests
RiverFlow	setRiverName(org.elasticsearch.river.RiverName riverName) Sets the river name
RiverFlow	setSettings(org.elasticsearch.common.settings.Settings settings) Set the settings
String	strategy() The name of the strategy the river flow belongs to

Method Detail

strategy

String strategy()

The name of the strategy the river flow belongs to

Returns:

the strategy name

newInstance

RiverFlow<RC> newInstance()

newRiverContext

RC newRiverContext()

Create a new river context for a river run

Returns:

a new river context

setRiverName

RiverFlow setRiverName(org.elasticsearch.river.RiverName riverName)

Sets the river name

Parameters:

riverName - the river name

Returns:

this river name

getRiverName

org.elasticsearch.river.RiverName getRiverName()

Gets the river name

Returns:

the river name

setSettings

RiverFlow setSettings(org.elasticsearch.common.settings.Settings settings)

Set the settings

Parameters:

settings - the settings

Returns:

this river flow

getSettings

org.elasticsearch.common.settings.Settings getSettings()

Get the settings

Returns:

the settings

setIngestFactory

RiverFlow setIngestFactory(IngestFactory ingestFactory)

Set ingest factory

Parameters:

ingestFactory - ingest factory

Returns:

this river flow

setClient

RiverFlow setClient(org.elasticsearch.client.Client client)

getClient

org.elasticsearch.client.Client getClient()

Get the client

Returns:

the client

logMetrics

void logMetrics(RiverContext riverContext,
              String cause)

Log metrics

Parameters:

cause - the cause why metrics are logged

execute

void execute(RC riverContext)
             throws Exception

Execute this river flow

Throws:

Exception

setMetric

RiverFlow setMetric(org.elasticsearch.common.metrics.MeterMetric meterMetric)

Set metric

Parameters:

meterMetric - the meter metric

Returns:

this river flow

getMetric

org.elasticsearch.common.metrics.MeterMetric getMetric()

Get metric

Returns:

river metric

setQueue

RiverFlow setQueue(Queue<RiverContext> queue)

Set queue for processing RiverContext requests

Parameters:

queue - the queue

Returns:

this river flow

getQueue

Queue<RiverContext> getQueue()

Get queue for RiverContext processing

Returns:

the queue for processing RiverContext requests