Package annotation.calcs.spl

Class SPLAnnotationType

java.lang.Object

annotation.DataAnnotationType<SPLAnnotation>

annotation.calcs.spl.SPLAnnotationType

public class SPLAnnotationType
extends DataAnnotationType<SPLAnnotation>

SPL annotation type. Can add a single double SPL to a data unit. Can automatically calculate the SPL from the time frequency box of the data unit.

Author:

Doug Gillespie

Field Summary

Fields inherited from class annotation.DataAnnotationType

SHORTIDCODELENGTH

Constructor Summary

Constructors

Constructor	Description
SPLAnnotationType()

Method Summary

Modifier and Type	Method	Description
SPLAnnotation	autoAnnotate(PamDataUnit pamDataUnit)	Automatically annotate the data unit with this annotation.
boolean	canAnnotate(Class dataUnitType)	Find out whether or not a particular type of data can be annotated
boolean	canAutoAnnotate()
Class	getAnnotationClass()
String	getAnnotationName()
AnnotationDialogPanel	getDialogPanel()	Get a dialog component that can be incorporated into a larger dialog.
SQLLoggingAddon	getSQLLoggingAddon()	Get an SQLLogging add on.
String	toString(SPLAnnotation dataAnnotation)	Get the annotation as a string for use in tables, tool tips, etc.

Methods inherited from class annotation.DataAnnotationType

getAnnotationOptions, getBinaryHandler, getDataBlockSpeciesManager, getDataSelectCreator, getDataSelector, getSettingsPanel, getShortIdCode, getSymbolModifier, getTargetDataBlock, getXMLWriter, hasSettingsPanel, isAnnotating, setAnnotationOptions, setTargetDataBlock, toString

Methods inherited from class java.lang.Object

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

Constructor Details

SPLAnnotationType

public SPLAnnotationType()

Method Details

getAnnotationName

public String getAnnotationName()

Specified by:

getAnnotationName in class DataAnnotationType<SPLAnnotation>

canAnnotate

public boolean canAnnotate(Class dataUnitType)

Description copied from class: DataAnnotationType

Find out whether or not a particular type of data can be annotated

Specified by:

canAnnotate in class DataAnnotationType<SPLAnnotation>

Parameters:

dataUnitType - Class of a type of data unit. Can be null in which case annotation can be stand alone.

Returns:

true if the data unit Class can be annotated.

toString

public String toString(SPLAnnotation dataAnnotation)

Description copied from class: DataAnnotationType

Get the annotation as a string for use in tables, tool tips, etc.

Overrides:

toString in class DataAnnotationType<SPLAnnotation>

Parameters:

dataAnnotation - Data Annotation

Returns:

String representation of the data

getSQLLoggingAddon

public SQLLoggingAddon getSQLLoggingAddon()

Description copied from class: DataAnnotationType

Get an SQLLogging add on. For stand alone annotations, this will be used to generate a stand alone database table. For annotations of existing data this will be used to add additional columns to the existing data tables.

Overrides:

getSQLLoggingAddon in class DataAnnotationType<SPLAnnotation>

Returns:

An SQLLoggingAddon or null if SQL logging unavailable for this type of annotation.

autoAnnotate

public SPLAnnotation autoAnnotate(PamDataUnit pamDataUnit)

Description copied from class: DataAnnotationType

Automatically annotate the data unit with this annotation.

Overrides:

autoAnnotate in class DataAnnotationType<SPLAnnotation>

Parameters:

pamDataUnit - data unit to annotate

Returns:

the annotation (though this should have already been added to the data unit).

canAutoAnnotate

public boolean canAutoAnnotate()

Overrides:

canAutoAnnotate in class DataAnnotationType<SPLAnnotation>

Returns:

True if annotation can be automatic (i.e. calculated rather than input by user).

getDialogPanel

public AnnotationDialogPanel getDialogPanel()

Description copied from class: DataAnnotationType

Get a dialog component that can be incorporated into a larger dialog.

Note that this is for setting the data for a specific annotation, NOT the dialog for setting options controlling how the annotation type works.

Overrides:

getDialogPanel in class DataAnnotationType<SPLAnnotation>

Returns:

a dialog panel (contains a component = a few other functions).

getAnnotationClass

public Class getAnnotationClass()

Specified by:

getAnnotationClass in class DataAnnotationType<SPLAnnotation>

Returns:

Class type for the annotations