Package annotation.string

Class StringAnnotationType

java.lang.Object

annotation.DataAnnotationType<StringAnnotation<?>>

annotation.string.StringAnnotationType

public class StringAnnotationType
extends DataAnnotationType<StringAnnotation<?>>

Simple annotation type that does nothing by add a string text to a datat unit.

Author:

Doug Gillespie

Field Summary

Fields inherited from class annotation.DataAnnotationType

SHORTIDCODELENGTH

Constructor Summary

Constructors

Constructor	Description
StringAnnotationType(String annotationName, int maxLength)

Method Summary

Modifier and Type	Method	Description
boolean	canAnnotate(Class dataUnitType)	Find out whether or not a particular type of data can be annotated
boolean	canAutoAnnotate()
Class	getAnnotationClass()
String	getAnnotationName()
AnnotationOptions	getAnnotationOptions()
AnnotationDialogPanel	getDialogPanel()	Get a dialog component that can be incorporated into a larger dialog.
int	getMaxLength()
SQLLoggingAddon	getSQLLoggingAddon()	Get an SQLLogging add on.
void	setAnnotationOptions(AnnotationOptions annotationOptions)

Methods inherited from class annotation.DataAnnotationType

autoAnnotate, getBinaryHandler, getDataBlockSpeciesManager, getDataSelectCreator, getDataSelector, getSettingsPanel, getShortIdCode, getSymbolModifier, getTargetDataBlock, getXMLWriter, hasSettingsPanel, isAnnotating, setTargetDataBlock, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Details

StringAnnotationType

public StringAnnotationType(String annotationName,
 int maxLength)

Method Details

getAnnotationName

public String getAnnotationName()

Specified by:

getAnnotationName in class DataAnnotationType<StringAnnotation<?>>

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<StringAnnotation<?>>

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<StringAnnotation<?>>

Returns:

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

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<StringAnnotation<?>>

Returns:

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

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<StringAnnotation<?>>

Returns:

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

getMaxLength

public int getMaxLength()

Returns:

the maxLength

getAnnotationOptions

public AnnotationOptions getAnnotationOptions()

Overrides:

getAnnotationOptions in class DataAnnotationType<StringAnnotation<?>>

Returns:

the annotationOptions

setAnnotationOptions

public void setAnnotationOptions(AnnotationOptions annotationOptions)

Overrides:

setAnnotationOptions in class DataAnnotationType<StringAnnotation<?>>

Parameters:

annotationOptions - the annotationOptions to set

getAnnotationClass

public Class getAnnotationClass()

Specified by:

getAnnotationClass in class DataAnnotationType<StringAnnotation<?>>

Returns:

Class type for the annotations