Package annotation.userforms

Class UserFormAnnotationType

java.lang.Object

annotation.DataAnnotationType<UserFormAnnotation<?>>

annotation.userforms.UserFormAnnotationType

public class UserFormAnnotationType
extends DataAnnotationType<UserFormAnnotation<?>>

Field Summary

Fields inherited from class annotation.DataAnnotationType

SHORTIDCODELENGTH

Constructor Summary

Constructors

Constructor	Description
UserFormAnnotationType()
UserFormAnnotationType(PamDataBlock pamDataBlock)

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()
protected FormDescription	findFormDescription()	Find the form descriptions, load form definitions if not already done.
Class	getAnnotationClass()
String	getAnnotationName()
AnnotationOptions	getAnnotationOptions()
AnnotationBinaryHandler<UserFormAnnotation<?>>	getBinaryHandler()	Get an optional AnnotationBinaryHandler which can be used to add the annotation information for binary files and also read data back from them.
DataBlockSpeciesManager	getDataBlockSpeciesManager()	Annotations may have a species manager.
AnnotationDataSelCreator	getDataSelectCreator(String selectorName, boolean allowScores)
AnnotationDialogPanel	getDialogPanel()	Get a dialog component that can be incorporated into a larger dialog.
FormDescription	getFormDescription()	Get the form description for this annotation (the annotation only holds one)
static FormsControl	getFormsControl()	Get a logger forms controller.
AnnotationSettingsPanel	getSettingsPanel()
SQLLoggingAddon	getSQLLoggingAddon()	Get an SQLLogging add on.
SymbolModifier	getSymbolModifier(PamSymbolChooser symbolChooser)	Some annotations may be able to set the type of symbol.
UserFormAnnotationOptions	getUserFormAnnotationOptions()
AnnotationXMLWriter<UserFormAnnotation<?>>	getXMLWriter()	Get something that can write an annotation as XML
boolean	hasSettingsPanel()
void	setAnnotationOptions(AnnotationOptions annotationOptions)

Methods inherited from class annotation.DataAnnotationType

autoAnnotate, getDataSelector, getShortIdCode, getTargetDataBlock, isAnnotating, setTargetDataBlock, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Details

UserFormAnnotationType

public UserFormAnnotationType()

UserFormAnnotationType

public UserFormAnnotationType(PamDataBlock pamDataBlock)

Method Details

getAnnotationName

public String getAnnotationName()

Specified by:

getAnnotationName in class DataAnnotationType<UserFormAnnotation<?>>

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

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

Returns:

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

getSettingsPanel

public AnnotationSettingsPanel getSettingsPanel()

Overrides:

getSettingsPanel in class DataAnnotationType<UserFormAnnotation<?>>

hasSettingsPanel

public boolean hasSettingsPanel()

Overrides:

hasSettingsPanel in class DataAnnotationType<UserFormAnnotation<?>>

getAnnotationOptions

public AnnotationOptions getAnnotationOptions()

Overrides:

getAnnotationOptions in class DataAnnotationType<UserFormAnnotation<?>>

Returns:

the annotationOptions

setAnnotationOptions

public void setAnnotationOptions(AnnotationOptions annotationOptions)

Overrides:

setAnnotationOptions in class DataAnnotationType<UserFormAnnotation<?>>

Parameters:

annotationOptions - the annotationOptions to set

findFormDescription

protected FormDescription findFormDescription()

Find the form descriptions, load form definitions if not already done.

Returns:

form description or null;

getFormsControl

public static FormsControl getFormsControl()

Get a logger forms controller. This may be the main Logger forms unit, but if there isn't one, we create one anyway and use it globally for all the form annotations.

Returns:

Logger forms controller.

getUserFormAnnotationOptions

public UserFormAnnotationOptions getUserFormAnnotationOptions()

Returns:

the userFormAnnotationOptions

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

Returns:

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

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

Returns:

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

getAnnotationClass

public Class getAnnotationClass()

Specified by:

getAnnotationClass in class DataAnnotationType<UserFormAnnotation<?>>

Returns:

Class type for the annotations

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

Returns:

getFormDescription

public FormDescription getFormDescription()

Get the form description for this annotation (the annotation only holds one)

Returns:

form description. Will be null if not configured.

getBinaryHandler

public AnnotationBinaryHandler<UserFormAnnotation<?>> 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<UserFormAnnotation<?>>

Returns:

handler for binary data i/o.

getDataSelectCreator

public AnnotationDataSelCreator getDataSelectCreator(String selectorName,
 boolean allowScores)

Overrides:

getDataSelectCreator in class DataAnnotationType<UserFormAnnotation<?>>

getXMLWriter

public AnnotationXMLWriter<UserFormAnnotation<?>> getXMLWriter()

Description copied from class: DataAnnotationType

Get something that can write an annotation as XML

Overrides:

getXMLWriter in class DataAnnotationType<UserFormAnnotation<?>>

Returns:

getDataBlockSpeciesManager

public DataBlockSpeciesManager getDataBlockSpeciesManager()

Description copied from class: DataAnnotationType

Annotations may have a species manager. Most won't.

Overrides:

getDataBlockSpeciesManager in class DataAnnotationType<UserFormAnnotation<?>>

Returns: