Package annotation.classifier

Class BaseClassificationAnnotationType

java.lang.Object

annotation.DataAnnotationType<BaseClassificationAnnotation>

annotation.classifier.BaseClassificationAnnotationType

public class BaseClassificationAnnotationType
extends DataAnnotationType<BaseClassificationAnnotation>

Field Summary

Fields inherited from class annotation.DataAnnotationType

SHORTIDCODELENGTH

Constructor Summary

Constructors

Constructor	Description
BaseClassificationAnnotationType(String methodName)

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<BaseClassificationAnnotation>	getBinaryHandler()	Get an optional AnnotationBinaryHandler which can be used to add the annotation information for binary files and also read data back from them.
AnnotationDataSelCreator	getDataSelectCreator(String selectorName, boolean allowScores)
String	getShortIdCode()	A short identifying code which MUST be unique to the data annotation and MUST be four characters long.
SymbolModifier	getSymbolModifier(PamSymbolChooser symbolChooser)	Some annotations may be able to set the type of symbol.
String	toString(BaseClassificationAnnotation dataAnnotation)	Get the annotation as a string for use in tables, tool tips, etc.

Methods inherited from class annotation.DataAnnotationType

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

Methods inherited from class java.lang.Object

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

Constructor Details

BaseClassificationAnnotationType

public BaseClassificationAnnotationType(String methodName)

Method Details

getAnnotationName

public String getAnnotationName()

Specified by:

getAnnotationName in class DataAnnotationType<BaseClassificationAnnotation>

getAnnotationClass

public Class getAnnotationClass()

Specified by:

getAnnotationClass in class DataAnnotationType<BaseClassificationAnnotation>

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

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(BaseClassificationAnnotation dataAnnotation)

Description copied from class: DataAnnotationType

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

Overrides:

toString in class DataAnnotationType<BaseClassificationAnnotation>

Parameters:

dataAnnotation - Data Annotation

Returns:

String representation of the data

getBinaryHandler

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

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

Returns:

a four character id string.

getSymbolModifier

public SymbolModifier getSymbolModifier(PamSymbolChooser symbolChooser)

Description copied from class: DataAnnotationType

Some annotations may be able to set the type of symbol. This will be accessed from a datablocks SymbolManager

Overrides:

getSymbolModifier in class DataAnnotationType<BaseClassificationAnnotation>

Returns:

getDataSelectCreator

public AnnotationDataSelCreator getDataSelectCreator(String selectorName,
 boolean allowScores)