binaryFileStorage

Class BinaryOutputStream

java.lang.Object

binaryFileStorage.BinaryOutputStream

public class BinaryOutputStream
extends java.lang.Object

Handles writing of an actual binary data file.

Is used during data analysis and also to rewrite files if they are changed during offline analysis using the PAMGUARD viewer.

Author:

Doug Gillespie

See Also:

BinaryStore

Constructor Summary

Constructors

Constructor and Description
BinaryOutputStream(BinaryStore binaryStore, PamDataBlock parentDataBlock)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	closeFile()
boolean	createIndexFile()
boolean	createIndexFile(java.io.File indexFile)
long	getFileSize()
java.lang.String	getMainFileName()
boolean	openFile(java.io.File outputFile) Open an output file.
boolean	openFile(long dataTime) Open an output file.
boolean	storeData(BinaryObjectData binaryObjectData) Write data to a file.
boolean	storeData(int objectId, long timeMillis, byte[] data) Write data to a file
boolean	storeData(int objectId, long timeMillis, byte[] data, int objectLength) Writes data to a file.
boolean	writeDatagram(Datagram datagram) Write a Datagram to an output stream
boolean	writeFileFooter(BinaryFooter footer) Write a file footer to the binary output stream.
boolean	writeFooter(long dataTime, long analTime, int endReason)
boolean	writeHeader(long dataTime, long analTime)
boolean	writeModuleFooter()
boolean	writeModuleFooter(byte[] footerData) Write module footer data to the output stream.
boolean	writeModuleFooter(java.io.DataOutputStream outputStream, byte[] footerData) Write module footer data to a specific output stream.
boolean	writeModuleFooter(ModuleFooter moduleFooter) Write a module footer to the output stream.
boolean	writeModuleHeader()
boolean	writeModuleHeader(byte[] headerData)
boolean	writeModuleHeader(java.io.DataOutputStream outputStream, byte[] headerData)

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryOutputStream

public BinaryOutputStream(BinaryStore binaryStore,
                  PamDataBlock parentDataBlock)

Method Detail

openFile

public boolean openFile(long dataTime)

Open an output file.

this call is used in real time ops to create a new file name based on the time and information from the datablock name.

Parameters:

dataTime - time in Java milliseconds

Returns:

true if successful, false otherwise.

openFile

public boolean openFile(java.io.File outputFile)

Open an output file.

This version is used when rewriting files when data have been changed offline. Generally the file will be a .tmp file

Parameters:

outputFile - output file

Returns:

true if successful

closeFile

public boolean closeFile()

writeHeader

public boolean writeHeader(long dataTime,
                  long analTime)

writeModuleHeader

public boolean writeModuleHeader()

writeModuleHeader

public boolean writeModuleHeader(byte[] headerData)

writeModuleHeader

public boolean writeModuleHeader(java.io.DataOutputStream outputStream,
                        byte[] headerData)

writeModuleFooter

public boolean writeModuleFooter()

writeModuleFooter

public boolean writeModuleFooter(ModuleFooter moduleFooter)

Write a module footer to the output stream.

Parameters:

moduleFooter - module footer

Returns:

true if successful

writeModuleFooter

public boolean writeModuleFooter(byte[] footerData)

Write module footer data to the output stream. Note that this is the data alone, without the first 12 bytes of identifier and length information.

Parameters:

footerData - footer data as a binary array

Returns:

true if successful

writeModuleFooter

public boolean writeModuleFooter(java.io.DataOutputStream outputStream,
                        byte[] footerData)

Write module footer data to a specific output stream.

Parameters:

outputStream - output stream

footerData - footer data in a binary array

Returns:

true if sucessful.

writeFooter

public boolean writeFooter(long dataTime,
                  long analTime,
                  int endReason)

getFileSize

public long getFileSize()

storeData

public boolean storeData(int objectId,
                long timeMillis,
                byte[] data)

Write data to a file

Parameters:

objectId - unique object identifier.

timeMillis - time of object in java milliseconds

data - byte array of binary data to store.

Returns:

true if written successfully.

storeData

public boolean storeData(BinaryObjectData binaryObjectData)

Write data to a file.

Parameters:

binaryObjectData - data to store.

Returns:

true if written successfully

storeData

public boolean storeData(int objectId,
                long timeMillis,
                byte[] data,
                int objectLength)

Writes data to a file. Note that the length of data may be greater than the actual length of useful data which is held in onjectLength

Parameters:

objectId - unique object identifier.

timeMillis - time of object in java milliseconds

data - byte array of binary data to store.

objectLength - length of useful data in data (often = data.length)

Returns:

true if written successfully.

createIndexFile

public boolean createIndexFile()

createIndexFile

public boolean createIndexFile(java.io.File indexFile)

writeDatagram

public boolean writeDatagram(Datagram datagram)

Write a Datagram to an output stream

Parameters:

datagram -

Returns:

true if successful.

See Also:

Datagram

writeFileFooter

public boolean writeFileFooter(BinaryFooter footer)

Write a file footer to the binary output stream.

Parameters:

footer - file footer.

Returns:

true if successful.

getMainFileName

public java.lang.String getMainFileName()

Returns:

the mainFileName