Package Localiser.algorithms.timeDelayLocalisers.bearingLoc.annotation

Class BearingLocAnnotationType

java.lang.Object

annotation.DataAnnotationType<BearingLocAnnotation>

Localiser.algorithms.timeDelayLocalisers.bearingLoc.annotation.BearingLocAnnotationType

public class BearingLocAnnotationType
extends DataAnnotationType<BearingLocAnnotation>

Field Summary

Fields inherited from class annotation.DataAnnotationType

SHORTIDCODELENGTH

Constructor Summary

Constructors

Constructor	Description
BearingLocAnnotationType()

Method Summary

Modifier and Type	Method	Description
boolean	canAnnotate(Class dataUnitType)	Find out whether or not a particular type of data can be annotated
Class	getAnnotationClass()
String	getAnnotationName()
AnnotationBinaryHandler<BearingLocAnnotation>	getBinaryHandler()	Get an optional AnnotationBinaryHandler which can be used to add the annotation information for binary files and also read data back from them.
String	getShortIdCode()	A short identifying code which MUST be unique to the data annotation and MUST be four characters long.

Methods inherited from class annotation.DataAnnotationType

autoAnnotate, canAutoAnnotate, getAnnotationOptions, getDataBlockSpeciesManager, getDataSelectCreator, getDataSelector, getDialogPanel, getSettingsPanel, getSQLLoggingAddon, getSymbolModifier, getTargetDataBlock, getXMLWriter, hasSettingsPanel, isAnnotating, setAnnotationOptions, setTargetDataBlock, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Details

BearingLocAnnotationType

public BearingLocAnnotationType()

Method Details

getAnnotationName

public String getAnnotationName()

Specified by:

getAnnotationName in class DataAnnotationType<BearingLocAnnotation>

getAnnotationClass

public Class getAnnotationClass()

Specified by:

getAnnotationClass in class DataAnnotationType<BearingLocAnnotation>

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

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.

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

Returns:

a four character id string.

getBinaryHandler

public AnnotationBinaryHandler<BearingLocAnnotation> 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<BearingLocAnnotation>

Returns:

handler for binary data i/o.