org.n52.youngs.load

Interface Sink

All Known Implementing Classes:

ElasticsearchClientSink, ElasticsearchRemoteHttpSink, ElasticsearchSink

public interface Sink

Method Summary

Modifier and Type	Method and Description
boolean	clear(MappingConfiguration mapping) remove all traces of any loading that took or might have taken place for the provided mapping
boolean	prepare(MappingConfiguration mapping) Do whatever is required for the sink to be used, such as testing connections, inserting schemas, ...
boolean	store(Collection<SinkRecord> records)
boolean	store(SinkRecord record)

Method Detail

prepare

boolean prepare(MappingConfiguration mapping)
         throws SinkError

Do whatever is required for the sink to be used, such as testing connections, inserting schemas, ...

Parameters:

mapping - the mapping that contains the configuration for the sink, such as data types and field names

Returns:

true if the sink is now ready to be used

Throws:

SinkError

store

boolean store(SinkRecord record)
       throws SinkError

Parameters:

record - the record to store

Returns:

true if record is stored

Throws:

SinkError - on no-recoverable errors

store

boolean store(Collection<SinkRecord> records)
       throws SinkError

Parameters:

records - the records to store

Returns:

true if _all_ records are stored

Throws:

SinkError - on no-recoverable errors

clear

boolean clear(MappingConfiguration mapping)

remove all traces of any loading that took or might have taken place for the provided mapping

Parameters:

mapping - the mapping providing the information that shall be cleared from the sink

Returns:

false if there were problems with clearing, true otherwise