org.xbib.elasticsearch.river.jdbc.strategy.simple

Class SimpleRiverFlow<RC extends RiverContext>

java.lang.Object

org.xbib.elasticsearch.river.jdbc.strategy.simple.SimpleRiverFlow<RC>

All Implemented Interfaces:

RiverFlow<RC>

Direct Known Subclasses:

ColumnRiverFlow

public class SimpleRiverFlow<RC extends RiverContext>
extends Object
implements RiverFlow<RC>

Simple river flow implementation

Constructor Summary

Constructors

Constructor and Description
SimpleRiverFlow()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	afterFetch(RiverContext riverContext) After the river task has completed a single run, this method is called.
protected void	beforeFetch(RC riverContext) Before a river task (or river run) starts, this method is called.
protected RiverMouth	createRiverMouth(Map<String,Object> params)
protected RiverSource	createRiverSource(Map<String,Object> params)
void	execute(RC riverContext) Execute this river flow
protected void	fetch(RiverContext riverContext) After river context and state setup, when data should be fetched from river source, this method is called.
protected RC	fillRiverContext(RC riverContext, RiverState state, RiverSource riverSource, RiverMouth riverMouth)
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
SimpleRiverFlow<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

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleRiverFlow

public SimpleRiverFlow()

Method Detail

strategy

public String strategy()

Description copied from interface: RiverFlow

The name of the strategy the river flow belongs to

Specified by:

strategy in interface RiverFlow<RC extends RiverContext>

Returns:

the strategy name

newInstance

public SimpleRiverFlow<RC> newInstance()

Specified by:

newInstance in interface RiverFlow<RC extends RiverContext>

newRiverContext

public RC newRiverContext()

Description copied from interface: RiverFlow

Create a new river context for a river run

Specified by:

newRiverContext in interface RiverFlow<RC extends RiverContext>

Returns:

a new river context

setRiverName

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

Description copied from interface: RiverFlow

Sets the river name

Specified by:

setRiverName in interface RiverFlow<RC extends RiverContext>

Parameters:

riverName - the river name

Returns:

this river name

getRiverName

public org.elasticsearch.river.RiverName getRiverName()

Description copied from interface: RiverFlow

Gets the river name

Specified by:

getRiverName in interface RiverFlow<RC extends RiverContext>

Returns:

the river name

setSettings

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

Description copied from interface: RiverFlow

Set the settings

Specified by:

setSettings in interface RiverFlow<RC extends RiverContext>

Parameters:

settings - the settings

Returns:

this river flow

getSettings

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

Description copied from interface: RiverFlow

Get the settings

Specified by:

getSettings in interface RiverFlow<RC extends RiverContext>

Returns:

the settings

setIngestFactory

public RiverFlow setIngestFactory(IngestFactory ingestFactory)

Description copied from interface: RiverFlow

Set ingest factory

Specified by:

setIngestFactory in interface RiverFlow<RC extends RiverContext>

Parameters:

ingestFactory - ingest factory

Returns:

this river flow

setClient

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

Specified by:

setClient in interface RiverFlow<RC extends RiverContext>

getClient

public org.elasticsearch.client.Client getClient()

Description copied from interface: RiverFlow

Get the client

Specified by:

getClient in interface RiverFlow<RC extends RiverContext>

Returns:

the client

execute

public void execute(RC riverContext)
             throws Exception

Description copied from interface: RiverFlow

Execute this river flow

Specified by:

execute in interface RiverFlow<RC extends RiverContext>

Throws:

Exception

beforeFetch

protected void beforeFetch(RC riverContext)
                    throws Exception

Before a river task (or river run) starts, this method is called.

Throws:

Exception

fetch

protected void fetch(RiverContext riverContext)
              throws Exception

After river context and state setup, when data should be fetched from river source, this method is called. The default is to invoke the fetch() method of the river source.

Throws:

Exception

setMetric

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

Description copied from interface: RiverFlow

Set metric

Specified by:

setMetric in interface RiverFlow<RC extends RiverContext>

Parameters:

meterMetric - the meter metric

Returns:

this river flow

getMetric

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

Description copied from interface: RiverFlow

Get metric

Specified by:

getMetric in interface RiverFlow<RC extends RiverContext>

Returns:

river metric

setQueue

public RiverFlow setQueue(Queue<RiverContext> queue)

Description copied from interface: RiverFlow

Set queue for processing RiverContext requests

Specified by:

setQueue in interface RiverFlow<RC extends RiverContext>

Parameters:

queue - the queue

Returns:

this river flow

getQueue

public Queue<RiverContext> getQueue()

Description copied from interface: RiverFlow

Get queue for RiverContext processing

Specified by:

getQueue in interface RiverFlow<RC extends RiverContext>

Returns:

the queue for processing RiverContext requests

afterFetch

protected void afterFetch(RiverContext riverContext)
                   throws Exception

After the river task has completed a single run, this method is called.

Throws:

Exception

createRiverSource

protected RiverSource createRiverSource(Map<String,Object> params)

createRiverMouth

protected RiverMouth createRiverMouth(Map<String,Object> params)
                               throws IOException

Throws:

IOException

fillRiverContext

protected RC fillRiverContext(RC riverContext,
                  RiverState state,
                  RiverSource riverSource,
                  RiverMouth riverMouth)
                                            throws IOException

Throws:

IOException

logMetrics

public void logMetrics(RiverContext riverContext,
              String cause)

Description copied from interface: RiverFlow

Log metrics

Specified by:

logMetrics in interface RiverFlow<RC extends RiverContext>

cause - the cause why metrics are logged