org.locationtech.geowave.core.store.api

Interface Writer<T>

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

IndependentAdapterIndexWriter, IndexCompositeWriter

public interface Writer<T>
extends Closeable

Method Summary

Modifier and Type	Method and Description
void	close() Flush all entries enqueued and close all resources for this writer.
void	flush() Flush the underlying row writer to ensure entries queued for write are fully written.
Index[]	getIndices() Get the indices that are being written to.
WriteResults	write(T entry) Writes an entry using default visibilities set elsewhere.
WriteResults	write(T entry, VisibilityHandler visibilityHandler) Writes an entry using the provided visibility handler.

Method Detail

write

WriteResults write(T entry)

Writes an entry using default visibilities set elsewhere.

Parameters:

entry - the entry to write

Returns:

the Insertion IDs representing where this entry was written

write

WriteResults write(T entry,
                   VisibilityHandler visibilityHandler)

Writes an entry using the provided visibility handler.

Parameters:

entry - the entry to write

visibilityHandler - the handler for determining field visibility

Returns:

the Insertion IDs representing where this entry was written

getIndices

Index[] getIndices()

Get the indices that are being written to.

Returns:

the indices that are being written to

flush

void flush()

Flush the underlying row writer to ensure entries queued for write are fully written. This is particularly useful for streaming data as an intermittent mechanism to ensure periodic updates are being stored.

close

void close()

Flush all entries enqueued and close all resources for this writer.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable