Package bearinglocaliser.annotation

Class BearingAnnotationType

java.lang.Object

annotation.DataAnnotationType<BearingAnnotation>

bearinglocaliser.annotation.BearingAnnotationType

public class BearingAnnotationType
extends DataAnnotationType<BearingAnnotation>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from class annotation.DataAnnotationType

SHORTIDCODELENGTH

Constructor Summary

Constructors

Constructor	Description
BearingAnnotationType()

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<BearingAnnotation>	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.
SQLLoggingAddon	getSQLLoggingAddon()	Get an SQLLogging add on.

Methods inherited from class annotation.DataAnnotationType

autoAnnotate, canAutoAnnotate, getAnnotationOptions, getDataSelector, getDialogPanel, getSettingsPanel, getSymbolModifier, getTargetDataBlock, hasSettingsPanel, isAnnotating, setAnnotationOptions, setTargetDataBlock, toString, toString

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

BearingAnnotationType

public BearingAnnotationType()

Method Details

getAnnotationName

public String getAnnotationName()

Specified by:

getAnnotationName in class DataAnnotationType<BearingAnnotation>

getAnnotationClass

public Class getAnnotationClass()

Specified by:

getAnnotationClass in class DataAnnotationType<BearingAnnotation>

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

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.

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

Returns:

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

getBinaryHandler

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

Returns:

handler for binary data i/o.

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

Returns:

a four character id string.