com.chemaxon.overlap.cli.util.pipeline

Interface ProgressiveSerialization

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ProgressiveSerializationImpl

public interface ProgressiveSerialization
extends AutoCloseable

Persist a record oriented storage efficiently.

Method Summary

Modifier and Type	Method and Description
<T extends Serializable> Consumer<T>	addDeferredAttribute(String name, Class<T> type, T initialValue) Specify a named attribute.
void	close() Close the underlying resource and write retained index data.
ObjectOutputStream	getObjectOutputStream() Get output to write remainder data.
<T> void	setDeserializer(Class<T> deserializedType, ProgressiveDeserializer<T> progressiveDeserializer) Specify deserializer to reconstruct the storage.

Method Detail

close

void close()
    throws Exception

Close the underlying resource and write retained index data. Updates to the deferred attributes are re-written before closing the underlying file.

Specified by:

close in interface AutoCloseable

Throws:

Exception

setDeserializer

<T> void setDeserializer(Class<T> deserializedType,
                         ProgressiveDeserializer<T> progressiveDeserializer)

Specify deserializer to reconstruct the storage. A typical implementation will write an ObjectOutputStream with a Deserializer instance which delegates to the passed progressiveDeserializer. Must be invoked before accessing #getDataOutput().

Type Parameters:

T - Reconstructed storage type

Parameters:

deserializedType - Reconstructed storage type

progressiveDeserializer - Deserializer to reconstruct the object

addDeferredAttribute

<T extends Serializable> Consumer<T> addDeferredAttribute(String name,
                                                          Class<T> type,
                                                          T initialValue)

Specify a named attribute. The value of these attributes might be determined at the end of the serialization process but needed at the beginning of the deserialization process. A suitable example is total item count. A typical implementation backed by a RandomAccessFile will write a placeholder which will be updated later.

Type Parameters:

T - Type

Parameters:

name - Unique name of the attribute

type - Type

initialValue - Initial value to be stored. Any subsequent updates of the value must have exactly the same serialized size.

Returns:

Consumer to update value during the serialization.

Throws:

IllegalStateException - when invoked after #getDataOutput() or after close() or when the serialized size of the stored values changed.

getObjectOutputStream

ObjectOutputStream getObjectOutputStream()

Get output to write remainder data.

Returns:

consumer for further data writes.