annotation

Class DataAnnotationType<TDataAnnotation extends DataAnnotation>

java.lang.Object

annotation.DataAnnotationType<TDataAnnotation>

Direct Known Subclasses:

SNRAnnotationType, StringAnnotationType

public abstract class DataAnnotationType<TDataAnnotation extends DataAnnotation>
extends java.lang.Object

Something that can tell us a little more about a type of DataAnnotation, such as how to store and display and edit the data in that annotation.

This base type is intended for annotations which are genuinely annotations of existing data units. Stand alone annotations, which create their own dataunit should base upon SoloAnnotationType

Author:

Doug Gillespie

See Also:

SoloAnnotationType

Constructor Summary

Constructors

Constructor and Description
DataAnnotationType()

Method Summary

Methods

Modifier and Type	Method and Description
TDataAnnotation	autoAnnotate(PamDataUnit pamDataUnit) Automatically annotate the data unit with this annotation.
abstract boolean	canAnnotate(java.lang.Class dataUnitType) Find out whether or not a particular type of data can be annotated
boolean	canAutoAnnotate()
abstract java.lang.String	getAnnotationName()
AnnotationDialogPanel	getDialogPanel() Get a dialog component that can be incorporated into a larger dialog.
SQLLoggingAddon	getSQLLoggingAddon() Get an SQLLogging add on.
java.lang.String	toString(TDataAnnotation dataAnnotation)

Methods inherited from class java.lang.Object

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

Constructor Detail

DataAnnotationType

public DataAnnotationType()

Method Detail

getAnnotationName

public abstract java.lang.String getAnnotationName()

toString

public java.lang.String toString(TDataAnnotation dataAnnotation)

canAnnotate

public abstract boolean canAnnotate(java.lang.Class dataUnitType)

Find out whether or not a particular type of data can be annotated

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

Returns:

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

autoAnnotate

public TDataAnnotation autoAnnotate(PamDataUnit pamDataUnit)

Automatically annotate the data unit with this annotation.

Parameters:

pamDataUnit - data unit to annotate

Returns:

the annotation (though this should have already been added to the data unit).

getSQLLoggingAddon

public SQLLoggingAddon getSQLLoggingAddon()

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.

Returns:

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

getDialogPanel

public AnnotationDialogPanel getDialogPanel()

Get a dialog component that can be incorporated into a larger dialog.

Returns:

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