rocca

Class RoccaSidePanel

java.lang.Object

rocca.RoccaSidePanel

All Implemented Interfaces:

PamObserver, PamSidePanel

public class RoccaSidePanel
extends java.lang.Object
implements PamSidePanel, PamObserver

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RoccaSidePanel.SidePanel

Constructor Summary

Constructors

Constructor and Description
RoccaSidePanel(RoccaControl roccaControl)

Method Summary

Methods

Modifier and Type	Method and Description
void	addSpeciesTreeVotes(java.lang.String sNum, double[] newTreeVotes) Finds the RoccaSightingDataUnit with the passed sighting number, and adds the tree votes to the running total.
RoccaSightingDataUnit	findSightingUnit(java.lang.String sNum) Searches through the Sighting Data Block for the passed sighting number.
int	getAutosaveFreq()
java.lang.String	getObserverName()
PamObserver	getObserverObject()
javax.swing.JComponent	getPanel()
long	getRequiredDataHistory(PamObservable o, java.lang.Object arg)
RoccaSightingDataBlock	getRSDB()
java.lang.String	getSightingNum()
int[]	getSpeciesClassCount() Returns the classification counts for the current species list
void	incSpeciesCount(java.lang.String sNum, int speciesToInc, double startTime) Increments a specific species classification count serialVersionUID=15 2014/11/12 add start time to method, and pass to the RoccaSightingDataUnit.
void	incSpeciesCount(java.lang.String sNum, java.lang.String speciesToInc, double startTime) Increments a specific species classification count serialVersionUID=15 2014/11/12 add start time to method, and pass to the RoccaSightingDataUnit.
void	masterClockUpdate(long milliSeconds, long sampleNumber)
void	noteNewSettings()
void	removeObservable(PamObservable o) called when an Observable (PamDataBlock) is removed from the system
void	rename(java.lang.String newName)
void	setAutosaveFreq(int autosaveFreq) Note: this method changes the field, but does not update the timer.
void	setCurrentUnit(RoccaSightingDataUnit currentUnit)
void	setEndOfWhistle(long time, double freq)
void	setSampleRate(float sampleRate, boolean notify) New sample rate
void	setSpecies(java.lang.String[] speciesAsString) Creates a new list of species and sets the counts to 0.
void	setSpeciesClassCount(int[] speciesClassCount) Sets all the species counts.
void	setStartOfWhistle(long time, double freq)
void	update(PamObservable o, PamDataUnit arg) Informs the PamObserver that new data have been added to the Observable class
void	updateSightingClass()

Methods inherited from class java.lang.Object

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

Constructor Detail

RoccaSidePanel

public RoccaSidePanel(RoccaControl roccaControl)

Method Detail

getRSDB

public RoccaSightingDataBlock getRSDB()

getObserverObject

public PamObserver getObserverObject()

Specified by:

getObserverObject in interface PamObserver

Returns:

the actual observer. In most cases concrete classes will just return 'this' in response. The exception is the Threaded observer, which will return the single thread observer.

getPanel

public javax.swing.JComponent getPanel()

Specified by:

getPanel in interface PamSidePanel

Returns:

Reference to a graphics component that can be added to the view. This will typically be a JPanel or a JInternalFrame; The component will be displayed to the side of the main tab control.

rename

public void rename(java.lang.String newName)

Specified by:

rename in interface PamSidePanel

getObserverName

public java.lang.String getObserverName()

Specified by:

getObserverName in interface PamObserver

setSpecies

public void setSpecies(java.lang.String[] speciesAsString)

Creates a new list of species and sets the counts to 0. Repaints the sidepanel once the fields are updated

Parameters:

speciesAsString - a string array of species names (max 5 characters). Note that "Ambig" is automatically added to the beginning of the list, and should note be included in the speciesAsString parameter.

updateSightingClass

public void updateSightingClass()

getSpeciesClassCount

public int[] getSpeciesClassCount()

Returns the classification counts for the current species list

Returns:

an int array containing the classification counts

setSpeciesClassCount

public void setSpeciesClassCount(int[] speciesClassCount)

Sets all the species counts.

Parameters:

speciesClassCount - an int array with the counts for each species. The length of the array must match the length of the species list

findSightingUnit

public RoccaSightingDataUnit findSightingUnit(java.lang.String sNum)

Searches through the Sighting Data Block for the passed sighting number. If the sighting number is not found, a "-1" is returned

Parameters:

sNum - The sighting number to search for

Returns:

The RoccaSightingDataUnit matching the sighting number passed, or a new RoccaSightingDataUnit if the sighting number wasn't found found

incSpeciesCount

public void incSpeciesCount(java.lang.String sNum,
                   int speciesToInc,
                   double startTime)

Increments a specific species classification count serialVersionUID=15 2014/11/12 add start time to method, and pass to the RoccaSightingDataUnit.

Parameters:

sNum - the sighting number to increment

speciesToInc - the index of the species to increment

startTime - the time of the first data unit, in milliseconds

incSpeciesCount

public void incSpeciesCount(java.lang.String sNum,
                   java.lang.String speciesToInc,
                   double startTime)

Increments a specific species classification count serialVersionUID=15 2014/11/12 add start time to method, and pass to the RoccaSightingDataUnit.

Parameters:

sNum - the sighting number to increment

speciesToInc - the index of the species to increment

startTime - the time of the first data unit, in milliseconds

addSpeciesTreeVotes

public void addSpeciesTreeVotes(java.lang.String sNum,
                       double[] newTreeVotes)

Finds the RoccaSightingDataUnit with the passed sighting number, and adds the tree votes to the running total. If the sighting number is not found, a new RoccaSightingDataUnit is created.

Parameters:

sNum - The sighting number to search for

newTreeVotes - An array of tree votes

getSightingNum

public java.lang.String getSightingNum()

setStartOfWhistle

public void setStartOfWhistle(long time,
                     double freq)

setEndOfWhistle

public void setEndOfWhistle(long time,
                   double freq)

getAutosaveFreq

public int getAutosaveFreq()

setAutosaveFreq

public void setAutosaveFreq(int autosaveFreq)

Note: this method changes the field, but does not update the timer. In order to adjust the period the old timer would need to be deleted and a new timer started. Could also use a ScheduledThreadPoolExecutor...

Parameters:

autosaveFreq -

setCurrentUnit

public void setCurrentUnit(RoccaSightingDataUnit currentUnit)

getRequiredDataHistory

public long getRequiredDataHistory(PamObservable o,
                          java.lang.Object arg)

Specified by:

getRequiredDataHistory in interface PamObserver

Parameters:

o - PamObservable class requiring the data

arg - optional argument from PamObservable

Returns:

time in milliseconds requried by data held in PamObservable

noteNewSettings

public void noteNewSettings()

Specified by:

noteNewSettings in interface PamObserver

removeObservable

public void removeObservable(PamObservable o)

Description copied from interface: PamObserver

called when an Observable (PamDataBlock) is removed from the system

Specified by:

removeObservable in interface PamObserver

setSampleRate

public void setSampleRate(float sampleRate,
                 boolean notify)

Description copied from interface: PamObserver

New sample rate

Specified by:

setSampleRate in interface PamObserver

notify - Notify other PamObservers and PamObservables in the chain.

masterClockUpdate

public void masterClockUpdate(long milliSeconds,
                     long sampleNumber)

Specified by:

masterClockUpdate in interface PamObserver

update

public void update(PamObservable o,
          PamDataUnit arg)

Description copied from interface: PamObserver

Informs the PamObserver that new data have been added to the Observable class

Specified by:

update in interface PamObserver

Parameters:

o - Reference to the Observable (a PamDataBlock)

arg - Reference to the new PamDataUnit