com.chemaxon.overlap.cli.util.pipeline

Class ProgressiveSerializationImpl

java.lang.Object

com.chemaxon.overlap.cli.util.pipeline.ProgressiveSerializationImpl

All Implemented Interfaces:

ProgressiveSerialization, AutoCloseable

public class ProgressiveSerializationImpl
extends Object
implements ProgressiveSerialization

Implementation of ProgressiveSerialization over FileOutputStream. This class is responsible to create a Deserializer conform binary file over ProgressiveSerialization interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProgressiveSerializationImpl.DeserializerImpl<T> Deserializer.

Constructor Summary

Constructors

Constructor and Description
ProgressiveSerializationImpl(File file, int buffer, boolean collectStats)

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.
long	getWrittenBytes()
<T> void	setDeserializer(Class<T> deserializedType, ProgressiveDeserializer<T> progressiveDeserializer) Specify deserializer to reconstruct the storage.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressiveSerializationImpl

public ProgressiveSerializationImpl(File file,
                                    int buffer,
                                    boolean collectStats)
                             throws IOException

Throws:

IOException

Method Detail

getWrittenBytes

public long getWrittenBytes()

close

public void close()
           throws IOException

Description copied from interface: ProgressiveSerialization

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 ProgressiveSerialization

Specified by:

close in interface AutoCloseable

Throws:

IOException

setDeserializer

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

Description copied from interface: ProgressiveSerialization

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().

Specified by:

setDeserializer in interface ProgressiveSerialization

Type Parameters:

T - Reconstructed storage type

Parameters:

deserializedType - Reconstructed storage type

progressiveDeserializer - Deserializer to reconstruct the object

addDeferredAttribute

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

Description copied from interface: ProgressiveSerialization

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.

Specified by:

addDeferredAttribute in interface ProgressiveSerialization

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.

getObjectOutputStream

public ObjectOutputStream getObjectOutputStream()

Description copied from interface: ProgressiveSerialization

Get output to write remainder data.

Specified by:

getObjectOutputStream in interface ProgressiveSerialization

Returns:

consumer for further data writes.