org.xbib.elasticsearch.river.jdbc

Interface RiverMouth<RC extends RiverContext>

All Known Implementing Classes:

ColumnRiverMouth, SimpleRiverMouth

public interface RiverMouth<RC extends RiverContext>

The river mouth is the abstraction of the destination where all the data is flowing from the river source.

Method Summary

Methods

Modifier and Type	Method and Description
void	afterFetch() Executed after river source fetch
void	beforeFetch() Executed before river source fetch
void	delete(IndexableObject object) Delete operation.
void	flush() Flush data to the river mouth
String	getId() Get document identifier
String	getIndex() Get default index name of this river mouth
Metric	getMetric() Get the metrics of this river mouth
String	getType() Get default index type name of this river mouth
void	index(IndexableObject object, boolean create) Index operation.
RiverMouth<RC>	newInstance() Create a new river mouth instance
void	resume() Resume river mouth after suspend.
RiverMouth	setId(String id) Set document identifier for next document to be indexed
RiverMouth	setIndex(String index) Set default index name for this river mouth
RiverMouth	setIndexSettings(org.elasticsearch.common.settings.Settings indexSettings) Set index settings
RiverMouth	setIngestFactory(IngestFactory ingestFactory) Set ingest factory
RiverMouth<RC>	setRiverContext(RC context) Set the river context
RiverMouth	setType(String type) Set default index type name for this river mouth
RiverMouth	setTypeMapping(Map<String,String> typeMapping) Set index type mappings
void	shutdown() Shutdown river mouth and release all resources, e.g.
String	strategy() The river strategy
void	suspend() Suspend river mouth.

Method Detail

strategy

String strategy()

The river strategy

Returns:

the strategy

newInstance

RiverMouth<RC> newInstance()

Create a new river mouth instance

Returns:

new river mouth instance

setRiverContext

RiverMouth<RC> setRiverContext(RC context)

Set the river context

Parameters:

context - the river context

Returns:

this river mouth

setIngestFactory

RiverMouth setIngestFactory(IngestFactory ingestFactory)

Set ingest factory

Parameters:

ingestFactory - the ingest factory

Returns:

this river mouth

getMetric

Metric getMetric()

Get the metrics of this river mouth

Returns:

this river mouth

setIndexSettings

RiverMouth setIndexSettings(org.elasticsearch.common.settings.Settings indexSettings)

Set index settings

Parameters:

indexSettings - the index settings

Returns:

this river mouth

setTypeMapping

RiverMouth setTypeMapping(Map<String,String> typeMapping)

Set index type mappings

Parameters:

typeMapping - the index type mappings

Returns:

this river mouth

beforeFetch

void beforeFetch()
                 throws Exception

Executed before river source fetch

Throws:

Exception

afterFetch

void afterFetch()
                throws Exception

Executed after river source fetch

Throws:

Exception

setIndex

RiverMouth setIndex(String index)

Set default index name for this river mouth

Parameters:

index - the default index name

Returns:

this river mouth

getIndex

String getIndex()

Get default index name of this river mouth

Returns:

the index name

setType

RiverMouth setType(String type)

Set default index type name for this river mouth

Parameters:

type - the default index type name for this river mouth

Returns:

this river mouth

getType

String getType()

Get default index type name of this river mouth

Returns:

the default index type name of this river mouth

setId

RiverMouth setId(String id)

Set document identifier for next document to be indexed

Parameters:

id - the id

Returns:

this river mouth

getId

String getId()

Get document identifier

Returns:

the document identifier

index

void index(IndexableObject object,
         boolean create)
           throws IOException

Index operation. Indicating that an object has been built and is ready to be indexed. The source of the document is held by the XContentBuilder.

Parameters:

object - the indexable object

create - true if the document should be created

Throws:

IOException - when indexing fails

delete

void delete(IndexableObject object)
            throws IOException

Delete operation. Indicating that an object should be deleted from the index.

Parameters:

object - the structured object

Throws:

IOException - when delete fails

flush

void flush()
           throws IOException

Flush data to the river mouth

Throws:

IOException - when flush fails

shutdown

void shutdown()
              throws IOException

Shutdown river mouth and release all resources, e.g. bulk processor and client

Throws:

IOException

suspend

void suspend()
             throws Exception

Suspend river mouth. Do not proceed with indexing and wait for resume.

Throws:

Exception

resume

void resume()
            throws Exception

Resume river mouth after suspend.

Throws:

Exception