Package beamformer.annotation

Class BFAnnotationType

java.lang.Object

annotation.DataAnnotationType<BeamFormerAnnotation>

beamformer.annotation.BFAnnotationType

public class BFAnnotationType
extends DataAnnotationType<BeamFormerAnnotation>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANNOTATIONNAME

Fields inherited from class annotation.DataAnnotationType

SHORTIDCODELENGTH

Constructor Summary

Constructors

Constructor	Description
BFAnnotationType(BeamFormLocaliserControl beamFormerLocControl)

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<BeamFormerAnnotation>	getBinaryHandler()	Get an optional AnnotationBinaryHandler which can be used to add the annotation information for binary files and also read data back from them.
SQLLoggingAddon	getSQLLoggingAddon()	Get an SQLLogging add on.

Methods inherited from class annotation.DataAnnotationType

autoAnnotate, canAutoAnnotate, getAnnotationOptions, getDataSelector, getDialogPanel, getSettingsPanel, getShortIdCode, 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

ANNOTATIONNAME

public static final String ANNOTATIONNAME

See Also:

• Constant Field Values

Constructor Details

BFAnnotationType

public BFAnnotationType(BeamFormLocaliserControl beamFormerLocControl)

Method Details

getAnnotationName

public String getAnnotationName()

Specified by:

getAnnotationName in class DataAnnotationType<BeamFormerAnnotation>

getAnnotationClass

public Class getAnnotationClass()

Specified by:

getAnnotationClass in class DataAnnotationType<BeamFormerAnnotation>

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

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.

getBinaryHandler

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

Returns:

handler for binary data i/o.

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

Returns:

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