org.openstreetmap.osmosis.core.store
Class RandomAccessObjectStore<T extends Storeable>

java.lang.Object
  extended by org.openstreetmap.osmosis.core.store.RandomAccessObjectStore<T>
Type Parameters:
T - The object type to be stored.
All Implemented Interfaces:
Completable, Releasable

public class RandomAccessObjectStore<T extends Storeable>
extends java.lang.Object
implements Completable

Provides a store for writing objects to a file for later retrieval. The number of objects is limited only by disk space.

Author:
Brett Henderson

Constructor Summary
RandomAccessObjectStore(ObjectSerializationFactory serializationFactory, java.io.File storageFile)
          Creates a new instance.
RandomAccessObjectStore(ObjectSerializationFactory serializationFactory, java.lang.String tempFilePrefix)
          Creates a new instance.
 
Method Summary
 long add(T data)
          Adds the specified object to the store.
 void complete()
          Ensures that all information is fully persisted.
 RandomAccessObjectStoreReader<T> createReader()
          Creates a new reader capable of accessing the contents of this store.
 void release()
          Performs resource cleanup tasks such as closing files, or database connections.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RandomAccessObjectStore

public RandomAccessObjectStore(ObjectSerializationFactory serializationFactory,
                               java.lang.String tempFilePrefix)
Creates a new instance.

Parameters:
serializationFactory - The factory defining the object serialisation implementation.
tempFilePrefix - The prefix of the temporary file.

RandomAccessObjectStore

public RandomAccessObjectStore(ObjectSerializationFactory serializationFactory,
                               java.io.File storageFile)
Creates a new instance.

Parameters:
serializationFactory - The factory defining the object serialisation implementation.
storageFile - The storage file to use.
Method Detail

add

public long add(T data)
Adds the specified object to the store.

Parameters:
data - The object to be added.
Returns:
The offset within the output file of the object written.

createReader

public RandomAccessObjectStoreReader<T> createReader()
Creates a new reader capable of accessing the contents of this store. The reader must be explicitly released when no longer required. Readers must be released prior to this store.

Returns:
A store reader.

complete

public void complete()
Ensures that all information is fully persisted. This includes database commits, file buffer flushes, etc. Implementations must call complete on any nested Completable objects. Where the releasable method of a Releasable class should be called within a finally block, this method should typically be the final statement within the try block.

Specified by:
complete in interface Completable

release

public void release()
Performs resource cleanup tasks such as closing files, or database connections. This must be called after all processing is complete and may be called multiple times. Implementations must call release on any nested Releasable objects. It should be called within a finally block to ensure it is called in exception scenarios.

Specified by:
release in interface Releasable