Package clickTrainDetector.logging

Class ClickTrainDetLogging

java.lang.Object

generalDatabase.SQLLogging

generalDatabase.SuperDetLogging

clickTrainDetector.logging.ClickTrainDetLogging

public class ClickTrainDetLogging
extends SuperDetLogging

Functions for saving a click train.

Author:

Jamie Macaulay

Field Summary

Fields inherited from class generalDatabase.SuperDetLogging

SUBTABLECLAUSE_PARENTDATABASEID, SUBTABLECLAUSE_PARENTUID, SUBTABLECLAUSE_TIME

Fields inherited from class generalDatabase.SQLLogging

UPDATE_POLICY_OVERWRITE, UPDATE_POLICY_WRITENEW

Constructor Summary

Constructors

Constructor	Description
ClickTrainDetLogging(ClickTrainControl clickTrainControl, ClickTrainDataBlock<CTDataUnit> pamDataBlock)

Method Summary

Modifier and Type	Method	Description
PamTableDefinition	createBaseTable()	Create the basic table definition for the group detection.
ClickTrainControl	getClickTrainControl()	Reference to the click train control.
String	getViewerLoadClause(SQLTypes sqlTypes, PamViewParameters pvp)	Get a standard select clause for loading viewer data, this is basically that UTC is between two times.
boolean	logData(PamConnection con, PamDataUnit dataUnit, PamDataUnit superDetection)	Called when a new PamDataUnit is added to a PamDataBlock to write those data to the database.
boolean	reLogData(PamConnection con, PamDataUnit dataUnit, PamDataUnit superDetection)	Called when an old PamDataUnit is updated.
void	setTableData(SQLTypes sqlTypes, PamDataUnit pamDataUnit)	Callback function when new data are created that allows the user to set the data for each column.

Methods inherited from class generalDatabase.SuperDetLogging

anySubTableItems, checkSubTableCount, countSubTableItems, deleteData, deleteIndexedItems, doSubTableUIDRepairs, getEventEndTimeItem, getSubLogging, getSubTableClausePolicy, isCreateDataUnits, loadViewData, saveOfflineData, setCreateDataUnits, setEventEndTimeItem, setSubLogging, setSubTableClausePolicy

Methods inherited from class generalDatabase.SQLLogging

addAddOn, clearAllAddOns, countTableItems, countTableItems, createInClause, deleteData, deleteData, doExtraChecks, double2Float, findClosestDataPoint, findLogger, getBaseTableDefinition, getEarlyLoadClause, getIdListUpdatClause, getLastLoadIndex, getLastLoadUID, getLastTime, getLoggingAddOns, getPamDataBlock, getTableDefinition, getTimesUpdateClause, getUIDMatchClause, getUpdatePolicy, getViewerCursorFinder, getViewerEverythingClause, getViewerLessThanClause, getViewerOverlapClause, getViewerUpdateClause, isCanView, isLoadViewData, loadDataFrom, loadEarlyData, loadEarlyData, loadLastDataUnit, loadSubtableData, loadSubtableData, loadViewData, loadViewerData, logData, prepareEmulation, prepareForMixedMode, readLastData, readMixedModeData, readNextEmulation, reCheckTable, reLogData, removeAddOn, removeAddOn, reset, setCanView, setColumnData, setLoadViewData, setTableDefinition, setUpdatePolicy, transferDataFromResult

Methods inherited from class java.lang.Object

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

Constructor Details

ClickTrainDetLogging

public ClickTrainDetLogging(ClickTrainControl clickTrainControl,
 ClickTrainDataBlock<CTDataUnit> pamDataBlock)

Method Details

createBaseTable

public PamTableDefinition createBaseTable()

Create the basic table definition for the group detection.

Returns:

basic table - annotations will be added shortly !

setTableData

public void setTableData(SQLTypes sqlTypes,
 PamDataUnit pamDataUnit)

Description copied from class: SQLLogging

Callback function when new data are created that allows the user to set the data for each column. Columns that have data which can be filled automatically (counters, primary keys and columns cross referenced to data in other tables) are filled automatically in fillTableData()

Specified by:

setTableData in class SQLLogging

getClickTrainControl

public ClickTrainControl getClickTrainControl()

Reference to the click train control.

Returns:

the detectionGroupControl.

getViewerLoadClause

public String getViewerLoadClause(SQLTypes sqlTypes,
 PamViewParameters pvp)

Description copied from class: SQLLogging

Get a standard select clause for loading viewer data, this is basically that UTC is between two times.

Overrides:

getViewerLoadClause in class SQLLogging

Parameters:

sqlTypes - SQL types - database specific functions

pvp - load parameters.

Returns:

Clause, in the form WHERE UTC BETWEEN A and B ORDER BY UTC

logData

public boolean logData(PamConnection con,
 PamDataUnit dataUnit,
 PamDataUnit superDetection)

Description copied from class: SQLLogging

Called when a new PamDataUnit is added to a PamDataBlock to write those data to the database. Functionality moved down to PamCursor so that exact writing method can become database specific if necessary.

Overrides:

logData in class SuperDetLogging

Parameters:

con - Database Connection

dataUnit - Pamguard Data unit.

superDetection - reference to a super detection so additional cross referencing can be filled

Returns:

true if written and new index of dataUnit retrieved OK

See Also:

• PamDataUnit

reLogData

public boolean reLogData(PamConnection con,
 PamDataUnit dataUnit,
 PamDataUnit superDetection)

Description copied from class: SQLLogging

Called when an old PamDataUnit is updated. The record is either updated or a new record is written, but cross referenced to the old unit for bookkeeping purposes based on the updatePolicy flag.

Overrides:

reLogData in class SuperDetLogging

Parameters:

con - Database Connection

dataUnit - Pamguard Data unit.

superDetection - reference to a super detection so additional cross referencing can be filled

Returns:

the number of rows written to the database.

See Also:

• PamDataUnit