Acquisition.offlineFuncs

Class OfflineFileServer

java.lang.Object

Acquisition.offlineFuncs.OfflineFileServer

All Implemented Interfaces:

OfflineDataStore, PamSettings

Direct Known Subclasses:

RonaOfflineFileServer

public class OfflineFileServer
extends java.lang.Object
implements OfflineDataStore, PamSettings

Functionality for handling data from files offline.

Author:

Doug Gillespie

Constructor Summary

Constructors

Constructor and Description
OfflineFileServer(OfflineRawDataStore offlineRawDataStore)

Method Summary

Methods

Modifier and Type	Method and Description
void	createOfflineDataMap(java.awt.Window parentFrame) Create a basic map of the data including first and last times and some kind of data/unit time count plus ideally some kind of start and stop time list of where there are gaps in the data.
DatagramManager	getDatagramManager()
WavFileDataMap	getDataMap()
java.lang.String	getDataSourceName() Get the data source name
OfflineFileParameters	getOfflineFileParameters()
PamRawDataBlock	getRawDataBlock()
java.io.Serializable	getSettingsReference()
long	getSettingsVersion()
java.lang.String	getUnitName()
java.lang.String	getUnitType()
boolean	loadData(PamDataBlock dataBlock, long dataStart, long dataEnd, RequestCancellationObject cancellationObject, ViewLoadObserver loadObserver) Load data for a given datablock between two time limits.
boolean	loadSerialisedMap()
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
boolean	rewriteIndexFile(PamDataBlock dataBlock, OfflineDataMapPoint dmp) Moved this function over from binary data store.
boolean	saveData(PamDataBlock dataBlock) Save data previously loaded from the store during offline viewing.
void	saveSerialisedMap()
void	setOfflineFileParameters(OfflineFileParameters offlineFileParameters)

Methods inherited from class java.lang.Object

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

Constructor Detail

OfflineFileServer

public OfflineFileServer(OfflineRawDataStore offlineRawDataStore)

Parameters:

acquisitionControl -

Method Detail

createOfflineDataMap

public void createOfflineDataMap(java.awt.Window parentFrame)

Description copied from interface: OfflineDataStore

Create a basic map of the data including first and last times and some kind of data/unit time count plus ideally some kind of start and stop time list of where there are gaps in the data.

Specified by:

createOfflineDataMap in interface OfflineDataStore

loadSerialisedMap

public boolean loadSerialisedMap()

saveSerialisedMap

public void saveSerialisedMap()

getDataSourceName

public java.lang.String getDataSourceName()

Description copied from interface: OfflineDataStore

Get the data source name

Specified by:

getDataSourceName in interface OfflineDataStore

Returns:

data source name

loadData

public boolean loadData(PamDataBlock dataBlock,
               long dataStart,
               long dataEnd,
               RequestCancellationObject cancellationObject,
               ViewLoadObserver loadObserver)

Description copied from interface: OfflineDataStore

Load data for a given datablock between two time limits.

Specified by:

loadData in interface OfflineDataStore

Parameters:

dataBlock - datablock owner of the data

dataStart - start time in milliseconds

dataEnd - end time in milliseconds

Returns:

true if load successful.

saveData

public boolean saveData(PamDataBlock dataBlock)

Description copied from interface: OfflineDataStore

Save data previously loaded from the store during offline viewing.

Specified by:

saveData in interface OfflineDataStore

Parameters:

dataBlock - datablock owner of the data

Returns:

true if saved or save not needed. False if an error prevents saving.

getSettingsReference

public java.io.Serializable getSettingsReference()

Specified by:

getSettingsReference in interface PamSettings

Returns:

The serialisable object that will be stored

getSettingsVersion

public long getSettingsVersion()

Specified by:

getSettingsVersion in interface PamSettings

Returns:

An integer version number for the settings

getUnitName

public java.lang.String getUnitName()

Specified by:

getUnitName in interface PamSettings

Returns:

A Name specific to this instance of the particular class, e.g. Sperm whale detector, Beaked whale detector, etc.

getUnitType

public java.lang.String getUnitType()

Specified by:

getUnitType in interface PamSettings

Returns:

A Name specific to the type, e.g. Glick detector

restoreSettings

public boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Specified by:

restoreSettings in interface PamSettings

Returns:

true if successful The object performs final checks (if needed) and then casts the settings data pamcontrolledunitSettings.settings into the correct type and uses as required

getOfflineFileParameters

public OfflineFileParameters getOfflineFileParameters()

Returns:

the offlineFileParameters

setOfflineFileParameters

public void setOfflineFileParameters(OfflineFileParameters offlineFileParameters)

Parameters:

offlineFileParameters - the offlineFileParameters to set

getDataMap

public WavFileDataMap getDataMap()

Returns:

the dataMap

getRawDataBlock

public PamRawDataBlock getRawDataBlock()

Returns:

the rawDataBlock

rewriteIndexFile

public boolean rewriteIndexFile(PamDataBlock dataBlock,
                       OfflineDataMapPoint dmp)

Description copied from interface: OfflineDataStore

Moved this function over from binary data store. Many storage systems may notbe able to do this, but some might !

Specified by:

rewriteIndexFile in interface OfflineDataStore

Returns:

getDatagramManager

public DatagramManager getDatagramManager()

Specified by:

getDatagramManager in interface OfflineDataStore

Returns:

the datagramManager