Package annotation.localise.targetmotion

Class TMAnnotationType

java.lang.Object

annotation.DataAnnotationType<TMAnnotation>

annotation.localise.targetmotion.TMAnnotationType

All Implemented Interfaces:

LocalisationAlgorithm

Direct Known Subclasses:

CTMAnntoationType

public class TMAnnotationType
extends DataAnnotationType<TMAnnotation>
implements LocalisationAlgorithm

Annotation type for target motion analysis. Target motion analysis requires a parent data unit which has multiple sub units.

Author:

Jamie Macaulay

Field Summary

Fields

Modifier and Type	Field	Description
protected TMSettingsPanel	clickLocDialogPanel	The dialog panel for target motion options.,
static final String	TMANNOTATIONNAME
protected annotation.localise.targetmotion.TMAnnotationType.TMGroupLocaliser	tmGroupLocaliser	The target motion localisation algorithm.

Fields inherited from class annotation.DataAnnotationType

SHORTIDCODELENGTH

Constructor Summary

Constructors

Constructor	Description
TMAnnotationType()

Method Summary

Modifier and Type	Method	Description
TMAnnotation	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()
LocaliserModel	findLocaliserModel(String modelName)
LocalisationAlgorithmInfo	getAlgorithmInfo()	Get information about the localisation algorithm.
Class	getAnnotationClass()
String	getAnnotationName()
AnnotationOptions	getAnnotationOptions()
AnnotationBinaryHandler<TMAnnotation>	getBinaryHandler()	Get an optional AnnotationBinaryHandler which can be used to add the annotation information for binary files and also read data back from them.
AnnotationDialogPanel	getDialogPanel()	Get a dialog component that can be incorporated into a larger dialog.
AnnotationSettingsPanel	getSettingsPanel()
String	getShortIdCode()	A short identifying code which MUST be unique to the data annotation and MUST be four characters long.
SQLLoggingAddon	getSQLLoggingAddon()	Get an SQLLogging add on.
LocalizationCreator	getTethysCreator()	Get something that can make LocalisationType objects of a form a bit bespoke to the type of localiser.
boolean	hasSettingsPanel()
void	setAnnotationOptions(AnnotationOptions annotationOptions)

Methods inherited from class annotation.DataAnnotationType

getDataBlockSpeciesManager, getDataSelectCreator, getDataSelector, getSymbolModifier, getTargetDataBlock, getXMLWriter, isAnnotating, setTargetDataBlock, toString, toString

Methods inherited from class java.lang.Object

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

Field Details

TMANNOTATIONNAME

public static final String TMANNOTATIONNAME

See Also:

• Constant Field Values

clickLocDialogPanel

protected TMSettingsPanel clickLocDialogPanel

The dialog panel for target motion options.,

tmGroupLocaliser

protected annotation.localise.targetmotion.TMAnnotationType.TMGroupLocaliser tmGroupLocaliser

The target motion localisation algorithm.

Constructor Details

TMAnnotationType

public TMAnnotationType()

Method Details

getAnnotationName

public String getAnnotationName()

Specified by:

getAnnotationName in class DataAnnotationType<TMAnnotation>

getAnnotationClass

public Class getAnnotationClass()

Specified by:

getAnnotationClass in class DataAnnotationType<TMAnnotation>

Returns:

Class type for the annotations

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<TMAnnotation>

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.

canAutoAnnotate

public boolean canAutoAnnotate()

Overrides:

canAutoAnnotate in class DataAnnotationType<TMAnnotation>

Returns:

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

getShortIdCode

public String getShortIdCode()

Description copied from class: DataAnnotationType

A short identifying code which MUST be unique to the data annotation and MUST be four characters long. Classes can override this with something even more cryptic so long as it remains unique.

Overrides:

getShortIdCode in class DataAnnotationType<TMAnnotation>

Returns:

a four character id string.

autoAnnotate

public TMAnnotation autoAnnotate(PamDataUnit pamDataUnit)

Description copied from class: DataAnnotationType

Automatically annotate the data unit with this annotation.

Overrides:

autoAnnotate in class DataAnnotationType<TMAnnotation>

Parameters:

pamDataUnit - data unit to annotate

Returns:

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

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<TMAnnotation>

Returns:

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

getBinaryHandler

public AnnotationBinaryHandler<TMAnnotation> getBinaryHandler()

Description copied from class: DataAnnotationType

Get an optional AnnotationBinaryHandler which can be used to add the annotation information for binary files and also read data back from them.

Overrides:

getBinaryHandler in class DataAnnotationType<TMAnnotation>

Returns:

handler for binary data i/o.

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<TMAnnotation>

Returns:

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

getSettingsPanel

public AnnotationSettingsPanel getSettingsPanel()

Overrides:

getSettingsPanel in class DataAnnotationType<TMAnnotation>

hasSettingsPanel

public boolean hasSettingsPanel()

Overrides:

hasSettingsPanel in class DataAnnotationType<TMAnnotation>

getAnnotationOptions

public AnnotationOptions getAnnotationOptions()

Overrides:

getAnnotationOptions in class DataAnnotationType<TMAnnotation>

Returns:

the annotationOptions

setAnnotationOptions

public void setAnnotationOptions(AnnotationOptions annotationOptions)

Overrides:

setAnnotationOptions in class DataAnnotationType<TMAnnotation>

Parameters:

annotationOptions - the annotationOptions to set

findLocaliserModel

public LocaliserModel findLocaliserModel(String modelName)

getAlgorithmInfo

public LocalisationAlgorithmInfo getAlgorithmInfo()

Description copied from interface: LocalisationAlgorithm

Get information about the localisation algorithm.

Specified by:

getAlgorithmInfo in interface LocalisationAlgorithm

Returns:

algorithm information.

getTethysCreator

public LocalizationCreator getTethysCreator()

Description copied from interface: LocalisationAlgorithm

Get something that can make LocalisationType objects of a form a bit bespoke to the type of localiser. This may be better than having the standard functions in LocalizationBuilder guess what's best.

Specified by:

getTethysCreator in interface LocalisationAlgorithm

Returns:

can be null in which case standard functions will do the best they can.