water.serial

Class ObjectTreeBinarySerializer

java.lang.Object

water.serial.ObjectTreeBinarySerializer

public class ObjectTreeBinarySerializer
extends java.lang.Object

Object tree serializer. It dumps a given list of keys (representing object graph in breadth-first order) into a folder referenced by an URI. It creates a metafile holding list of files which express load order of given files and their deserialization. If save destination exists, the save will fail. If load source does not or is not readable, the load will fail. If list of keys to save contains null-Key, then loaded list will contain null-key as well. The caller is responsible for cleanup of destination directory in case of failure.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXTENSION Extension string used for exported objects
static java.lang.String	METAFILE Name of metafile containing information about exported object tree.
static java.lang.String	NULL_PLACEHOLDER Null marker

Constructor Summary

Constructors

Constructor and Description
ObjectTreeBinarySerializer()
ObjectTreeBinarySerializer(boolean dkvPutAfterLoad, boolean overrideInDkv, boolean overrideFile)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	dumpMetaFile(Persist persist, java.util.List<java.lang.String> filenames, java.net.URI outputDir) Dump a metafile with a list of save files.
protected water.serial.BinarySerializer<Keyed,java.net.URI>	getKeyedSerializer()
java.util.List<Key>	load(java.util.List<Key> l, java.net.URI inputDir) Load object from given destination (i.e., file, stream)
java.util.List<Key>	load(java.net.URI inputDir) Load an object from specified input.
protected java.util.List<java.lang.String>	loadMetaFile(Persist persist, java.net.URI inputDir)
void	save(java.util.List<Key> objectTree, java.net.URI outputDir) Save given object into given target.

Methods inherited from class java.lang.Object

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

Field Detail

METAFILE

public static final java.lang.String METAFILE

Name of metafile containing information about exported object tree.

See Also:

Constant Field Values

EXTENSION

public static final java.lang.String EXTENSION

Extension string used for exported objects

See Also:

Constant Field Values

NULL_PLACEHOLDER

public static final java.lang.String NULL_PLACEHOLDER

Null marker

See Also:

Constant Field Values

Constructor Detail

ObjectTreeBinarySerializer

public ObjectTreeBinarySerializer()

ObjectTreeBinarySerializer

public ObjectTreeBinarySerializer(boolean dkvPutAfterLoad,
                          boolean overrideInDkv,
                          boolean overrideFile)

Method Detail

save

public void save(java.util.List<Key> objectTree,
        java.net.URI outputDir)
          throws java.io.IOException

Save given object into given target.

Parameters:

objectTree - object to serialize

outputDir - serialization destination (i.e., file, stream)

Throws:

java.io.IOException

load

public java.util.List<Key> load(java.util.List<Key> l,
                       java.net.URI inputDir)
                         throws java.io.IOException

Load object from given destination (i.e., file, stream)

Parameters:

l - object to be filled from

inputDir - object data provider

Returns:

Throws:

java.io.IOException

load

public java.util.List<Key> load(java.net.URI inputDir)
                         throws java.io.IOException

Load an object from specified input.

Throws:

java.io.IOException

dumpMetaFile

protected void dumpMetaFile(Persist persist,
                java.util.List<java.lang.String> filenames,
                java.net.URI outputDir)
                     throws java.io.IOException

Dump a metafile with a list of save files.

Throws:

java.io.IOException

loadMetaFile

protected java.util.List<java.lang.String> loadMetaFile(Persist persist,
                                            java.net.URI inputDir)
                                                 throws java.io.IOException

Throws:

java.io.IOException

getKeyedSerializer

protected water.serial.BinarySerializer<Keyed,java.net.URI> getKeyedSerializer()