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

Class SimpleRiverMouth

java.lang.Object

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

All Implemented Interfaces:

RiverMouth<SimpleRiverContext>

Direct Known Subclasses:

ColumnRiverMouth

public class SimpleRiverMouth
extends Object
implements RiverMouth<SimpleRiverContext>

Simple river mouth implementation. This implementation uses bulk processing, index name housekeeping (with replica/refresh), and metrics. It understands _version, _routing, _timestamp, _parent, and _ttl metadata.

Field Summary

Fields

Modifier and Type	Field and Description
protected SimpleRiverContext	context
protected String	id
protected String	index
protected Map<String,String>	indexMappings
protected org.elasticsearch.common.settings.Settings	indexSettings
protected Ingest	ingest
protected IngestFactory	ingestFactory
protected Metric	metric
protected boolean	suspended
protected String	type

Constructor Summary

Constructors

Constructor and Description
SimpleRiverMouth()

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.
SimpleRiverMouth	newInstance() Create a new river mouth instance
void	resume() Resume river mouth after suspend.
SimpleRiverMouth	setId(String id) Set document identifier for next document to be indexed
SimpleRiverMouth	setIndex(String index) Set default index name for this river mouth
SimpleRiverMouth	setIndexSettings(org.elasticsearch.common.settings.Settings indexSettings) Set index settings
SimpleRiverMouth	setIngestFactory(IngestFactory ingestFactory) Set ingest factory
SimpleRiverMouth	setRiverContext(SimpleRiverContext context) Set the river context
SimpleRiverMouth	setType(String type) Set default index type name for this river mouth
SimpleRiverMouth	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.

Methods inherited from class java.lang.Object

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

Field Detail

context

protected SimpleRiverContext context

ingestFactory

protected IngestFactory ingestFactory

ingest

protected Ingest ingest

metric

protected Metric metric

indexSettings

protected org.elasticsearch.common.settings.Settings indexSettings

indexMappings

protected Map<String,String> indexMappings

index

protected String index

type

protected String type

id

protected String id

suspended

protected volatile boolean suspended

Constructor Detail

SimpleRiverMouth

public SimpleRiverMouth()

Method Detail

strategy

public String strategy()

Description copied from interface: RiverMouth

The river strategy

Specified by:

strategy in interface RiverMouth<SimpleRiverContext>

Returns:

the strategy

newInstance

public SimpleRiverMouth newInstance()

Description copied from interface: RiverMouth

Create a new river mouth instance

Specified by:

newInstance in interface RiverMouth<SimpleRiverContext>

Returns:

new river mouth instance

setRiverContext

public SimpleRiverMouth setRiverContext(SimpleRiverContext context)

Description copied from interface: RiverMouth

Set the river context

Specified by:

setRiverContext in interface RiverMouth<SimpleRiverContext>

Parameters:

context - the river context

Returns:

this river mouth

setIngestFactory

public SimpleRiverMouth setIngestFactory(IngestFactory ingestFactory)

Description copied from interface: RiverMouth

Set ingest factory

Specified by:

setIngestFactory in interface RiverMouth<SimpleRiverContext>

Parameters:

ingestFactory - the ingest factory

Returns:

this river mouth

getMetric

public Metric getMetric()

Description copied from interface: RiverMouth

Get the metrics of this river mouth

Specified by:

getMetric in interface RiverMouth<SimpleRiverContext>

Returns:

this river mouth

beforeFetch

public void beforeFetch()
                 throws IOException

Description copied from interface: RiverMouth

Executed before river source fetch

Specified by:

beforeFetch in interface RiverMouth<SimpleRiverContext>

Throws:

IOException

afterFetch

public void afterFetch()
                throws IOException

Description copied from interface: RiverMouth

Executed after river source fetch

Specified by:

afterFetch in interface RiverMouth<SimpleRiverContext>

Throws:

IOException

shutdown

public void shutdown()

Description copied from interface: RiverMouth

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

Specified by:

shutdown in interface RiverMouth<SimpleRiverContext>

setIndexSettings

public SimpleRiverMouth setIndexSettings(org.elasticsearch.common.settings.Settings indexSettings)

Description copied from interface: RiverMouth

Set index settings

Specified by:

setIndexSettings in interface RiverMouth<SimpleRiverContext>

Parameters:

indexSettings - the index settings

Returns:

this river mouth

setTypeMapping

public SimpleRiverMouth setTypeMapping(Map<String,String> typeMapping)

Description copied from interface: RiverMouth

Set index type mappings

Specified by:

setTypeMapping in interface RiverMouth<SimpleRiverContext>

Parameters:

typeMapping - the index type mappings

Returns:

this river mouth

setIndex

public SimpleRiverMouth setIndex(String index)

Description copied from interface: RiverMouth

Set default index name for this river mouth

Specified by:

setIndex in interface RiverMouth<SimpleRiverContext>

Parameters:

index - the default index name

Returns:

this river mouth

getIndex

public String getIndex()

Description copied from interface: RiverMouth

Get default index name of this river mouth

Specified by:

getIndex in interface RiverMouth<SimpleRiverContext>

Returns:

the index name

setType

public SimpleRiverMouth setType(String type)

Description copied from interface: RiverMouth

Set default index type name for this river mouth

Specified by:

setType in interface RiverMouth<SimpleRiverContext>

Parameters:

type - the default index type name for this river mouth

Returns:

this river mouth

getType

public String getType()

Description copied from interface: RiverMouth

Get default index type name of this river mouth

Specified by:

getType in interface RiverMouth<SimpleRiverContext>

Returns:

the default index type name of this river mouth

setId

public SimpleRiverMouth setId(String id)

Description copied from interface: RiverMouth

Set document identifier for next document to be indexed

Specified by:

setId in interface RiverMouth<SimpleRiverContext>

Parameters:

id - the id

Returns:

this river mouth

getId

public String getId()

Description copied from interface: RiverMouth

Get document identifier

Specified by:

getId in interface RiverMouth<SimpleRiverContext>

Returns:

the document identifier

index

public void index(IndexableObject object,
         boolean create)
           throws IOException

Description copied from interface: RiverMouth

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.

Specified by:

index in interface RiverMouth<SimpleRiverContext>

Parameters:

object - the indexable object

create - true if the document should be created

Throws:

IOException - when indexing fails

delete

public void delete(IndexableObject object)

Description copied from interface: RiverMouth

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

Specified by:

delete in interface RiverMouth<SimpleRiverContext>

Parameters:

object - the structured object

flush

public void flush()
           throws IOException

Description copied from interface: RiverMouth

Flush data to the river mouth

Specified by:

flush in interface RiverMouth<SimpleRiverContext>

Throws:

IOException - when flush fails

suspend

public void suspend()

Description copied from interface: RiverMouth

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

Specified by:

suspend in interface RiverMouth<SimpleRiverContext>

resume

public void resume()

Description copied from interface: RiverMouth

Resume river mouth after suspend.

Specified by:

resume in interface RiverMouth<SimpleRiverContext>