org.maestro.common.io.data.writers

Class BinaryRateUpdater

java.lang.Object

org.maestro.common.io.data.writers.BinaryRateUpdater

All Implemented Interfaces:

AutoCloseable

public class BinaryRateUpdater
extends Object
implements AutoCloseable

A utility class that can be used to update the contents of a Binary rate file It should not be used for performance-intensive operations.

Constructor Summary

Constructors

Constructor and Description
BinaryRateUpdater(File reportFile) Constructor
BinaryRateUpdater(File reportFile, boolean overlay) Constructor

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush() Flushes the data to disk
FileHeader	getFileHeader() Gets the file header
static void	joinFile(BinaryRateUpdater binaryRateUpdater, File reportFile1) Join a file another file on an previously opened updater
void	update(RateEntry newer, long index)
void	updateHeader(FileHeader header) Updates the file header

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryRateUpdater

public BinaryRateUpdater(File reportFile)
                  throws IOException

Constructor

Parameters:

reportFile - the rate report file name

Throws:

IOException - in case of I/O errors

BinaryRateUpdater

public BinaryRateUpdater(File reportFile,
                         boolean overlay)
                  throws IOException

Constructor

Parameters:

reportFile - the rate report file name

overlay - whether the update should overlay previous files. If false, the updater will create data files from the joined ones if the report file is not existent

Throws:

IOException - in case of I/O errors

Method Detail

getFileHeader

public FileHeader getFileHeader()

Gets the file header

Returns:

the file header object

updateHeader

public void updateHeader(FileHeader header)
                  throws IOException

Updates the file header

Parameters:

header - the file header

Throws:

IOException - for multiple I/O related errors

update

public void update(RateEntry newer,
                   long index)
            throws IOException

Throws:

IOException

flush

public void flush()
           throws IOException

Flushes the data to disk

Throws:

IOException - in case of I/O errors

close

public void close()

Specified by:

close in interface AutoCloseable

joinFile

public static void joinFile(BinaryRateUpdater binaryRateUpdater,
                            File reportFile1)
                     throws IOException

Join a file another file on an previously opened updater

Parameters:

binaryRateUpdater - the updater instance to join the file to

reportFile1 - the file to be joined

Throws:

IOException - for multiple I/O related errors