net.sf.basedb.core.plugin
Interface AnnotationSetterPlugin

All Superinterfaces:

Plugin

All Known Implementing Classes:

ManualTransformCreator, RawDataFlatFileImporter

public interface AnnotationSetterPlugin
extends Plugin

This is a interface that should be implemented by plug-ins that are setting annotations on items thy create or work with. By implementing this interface it will be possible to store annotations at the plugin definition and/or plugin configuration level for any item type. The plug-in must copy the annotation values itself.

Version:

2.5

Author:

nicklas

See Also:

AnnotationSet.copyFrom(net.sf.basedb.core.Annotatable, boolean)

Last modified

$Date: 2008-09-11 22:09:17 +0200 (Thu, 11 Sep 2008) $

Nested Class Summary

Nested classes/interfaces inherited from interface net.sf.basedb.core.plugin.Plugin

Plugin.MainType

Method Summary

String	getAnnotationMessage() Get a message that explains what the plug-in does with the annotations it has.
ItemQuery<AnnotationType>	getAnnotationTypes() Create a query that returns the annotation types that can be used by the current plug-in.

Methods inherited from interface net.sf.basedb.core.plugin.Plugin

done, getAbout, getMainType, getPermissions, init, requiresConfiguration, run, supportsConfigurations

Method Detail

getAnnotationTypes

ItemQuery<AnnotationType> getAnnotationTypes()

Create a query that returns the annotation types that can be used by the current plug-in. For example the RawDataFlatFileImporter plug-in can set annotations on the raw bioassay and thus return all annotation types that can be used on raw bioassays: AnnotationType.getQuery(Item.RAWBIOASSAY).

Returns:

A query returning annotation types, or null if the current setup doesn't allow any annotations

getAnnotationMessage

String getAnnotationMessage()

Get a message that explains what the plug-in does with the annotations it has.

Returns:

A message or null