Package tritechgemini.fileio

Class GLFFileCatalog

java.lang.Object

tritechgemini.fileio.GeminiFileCatalog<GLFImageRecord>

tritechgemini.fileio.GLFFileCatalog

All Implemented Interfaces:

Serializable

public class GLFFileCatalog
extends GeminiFileCatalog<GLFImageRecord>

See Also:

• Serialized Form

Field Summary

Fields inherited from class tritechgemini.fileio.GeminiFileCatalog

ARISEND, DATEND, ECDEND, GLFEND

Constructor Summary

Constructors

Constructor	Description
GLFFileCatalog(String filePath)

Method Summary

Modifier and Type	Method	Description
boolean	buildCatalogue(ArrayList<GLFImageRecord> imageRecords)	Catalogue the file.
protected void	checkDeserialisedCatalog(String filePath)	Called just after a catalogue object has been deserialised, giving the opportunity to check anything.
protected void	finalize()
boolean	loadFullRecord(GLFImageRecord geminiRecord)	fully load a record (if it isn't already).
int	readGlfRecord(GLFImageRecord glfImage, DataInput dis, boolean readFully)	Read a GLF record which may or may not have already been partially read.
void	stopCatalogStream()	Stop streaming the catalog.
CatalogStreamSummary	streamCatalog(CatalogStreamObserver streamObserver)	Start a full forwards only read of the catalog from start to end, sending all records through to the streamObserver.
void	writeGLFHeader(GLFImageRecord glfRecord, LittleEndianDataOutputStream outputStream)	Write an image record header.
void	writeGLFReecord(GLFImageRecord glfImage, LittleEndianDataOutputStream dos)	Write a GLF record to the data output stream.
void	writeStatusHeader(GLFStatusData statusPacket, LittleEndianDataOutputStream outputStream)	Write a status data header.
void	writeStatusRecord(GLFStatusData statusPacket, LittleEndianDataOutputStream outputStream)

Methods inherited from class tritechgemini.fileio.GeminiFileCatalog

analyseCatalog, cDateToMillis, createCatalogue, findRecordForIDandTime, findRecordForIndexandTime, findRecordIndex, findRelativeRecord, freeAllImageData, freeImageData, getCatalogException, getCatalogName, getFileCatalog, getFilePath, getFirstRecordTime, getFullRecord, getImageRecords, getLastRecordTime, getMaxSonarFrames, getNumRecords, getNumSonars, getRecord, getRecordByIndex, getRecordIndex, getSonarIDs, getSonarInfo, getSonarRecord, getTimeZone, readSerializedCatalog, setImageRecords, setTimeZone, timedLoadFullRecord, writeSerializedCatalog

Methods inherited from class java.lang.Object

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

Constructor Details

GLFFileCatalog

public GLFFileCatalog(String filePath)

Method Details

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

buildCatalogue

public boolean buildCatalogue(ArrayList<GLFImageRecord> imageRecords)
                       throws Exception

Description copied from class: GeminiFileCatalog

Catalogue the file. i.e. go through the file and get the times and file positions of every record in the file.

Specified by:

buildCatalogue in class GeminiFileCatalog<GLFImageRecord>

Parameters:

imageRecords -

Returns:

true if catalog created successfully

Throws:

Exception

loadFullRecord

public boolean loadFullRecord(GLFImageRecord geminiRecord)
                       throws IOException

Description copied from class: GeminiFileCatalog

fully load a record (if it isn't already). This may involve going back to the file and getting and unpacking the raw data.

Specified by:

loadFullRecord in class GeminiFileCatalog<GLFImageRecord>

Parameters:

geminiRecord -

Returns:

true if load sucessful.

Throws:

IOException

writeGLFHeader

public void writeGLFHeader(GLFImageRecord glfRecord,
 LittleEndianDataOutputStream outputStream)

Write an image record header. Not 100% sure this is entirely accurate, but it has the main information and does create a valid GLF file.

Parameters:

glfRecord -

outputStream -

writeStatusHeader

public void writeStatusHeader(GLFStatusData statusPacket,
 LittleEndianDataOutputStream outputStream)

Write a status data header.

Parameters:

statusPacket -

outputStream -

readGlfRecord

public int readGlfRecord(GLFImageRecord glfImage,
 DataInput dis,
 boolean readFully)
                  throws CatalogException

Read a GLF record which may or may not have already been partially read.

Parameters:

glfImage -

dis -

readFully -

Returns:

0 for a normal GLF record, 1 for file end, 2 for something else we didn't understand

Throws:

CatalogException

writeGLFReecord

public void writeGLFReecord(GLFImageRecord glfImage,
 LittleEndianDataOutputStream dos)
                     throws IOException

Write a GLF record to the data output stream. This should be in the same format as the data were read in.

Parameters:

dos - Data output stream. Should be LittleEndien

imageRecord - GLF image record

Throws:

IOException

writeStatusRecord

public void writeStatusRecord(GLFStatusData statusPacket,
 LittleEndianDataOutputStream outputStream)
                       throws CatalogException

Throws:

CatalogException

streamCatalog

public CatalogStreamSummary streamCatalog(CatalogStreamObserver streamObserver)
                                   throws CatalogException

Description copied from class: GeminiFileCatalog

Start a full forwards only read of the catalog from start to end, sending all records through to the streamObserver.

Whatever calls this will almost definitely want to do so in a separate worker thread because the call will block until the read has finished.

Specified by:

streamCatalog in class GeminiFileCatalog<GLFImageRecord>

Parameters:

streamObserver - observer to get catalog data.

Returns:

number of records read.

Throws:

CatalogException

stopCatalogStream

public void stopCatalogStream()

Description copied from class: GeminiFileCatalog

Stop streaming the catalog.

Specified by:

stopCatalogStream in class GeminiFileCatalog<GLFImageRecord>

checkDeserialisedCatalog

protected void checkDeserialisedCatalog(String filePath)

Description copied from class: GeminiFileCatalog

Called just after a catalogue object has been deserialised, giving the opportunity to check anything. note that the file path is set elsewhere to allow for the possibility that the absolute path to the file may have changed, so it's probably not necessary to do anything here.

Specified by:

checkDeserialisedCatalog in class GeminiFileCatalog<GLFImageRecord>

Parameters:

filePath -