net.sourceforge.nite.meta
Interface NAnnotationSpec

All Known Implementing Classes:

NiteAnnotationSpec

public interface NAnnotationSpec

Information about an annotation board specification (used by the OTAB to display an annotation view). getType returns either DISPLAY or EDITOR.

Author:

jonathan

Field Summary

static int	DISPLAY
static int	EDITOR

Method Summary

java.lang.String	getDescription() returns some descriptive text about the annotation-board for the purposes of GUI list of choices for example.
java.util.List	getEditableCodingNames() Find the codings that can be edited - returns n List of Strings
java.util.List	getEditableObjectSetNames() Find the object sets that can be edited - returns n List of Strings
java.lang.String	getFileName() returns the file name in which the annotation-board description is stored
int	getType() returns one of EDITOR or DISPLAY depending on whether the NOM can be changed by this annotation board.
java.util.List	getUsedCodingNames() Find the codings that can be used but not edited - returns a List of Strings
java.util.List	getUsedObjectSetNames() Find the codings that can be used but not edited - returns a List of Strings
java.util.List	getUsedOntologyNames() Find the ontologies that can be used but not edited - returns a List of Strings
java.util.List	getUsedSignals() Find the names of the signals that should be displayed with this stylesheet - returns a List of Strings

Field Detail

EDITOR

static final int EDITOR

See Also:

Constant Field Values

DISPLAY

static final int DISPLAY

See Also:

Constant Field Values

Method Detail

getFileName

java.lang.String getFileName()

returns the file name in which the annotation-board description is stored

getDescription

java.lang.String getDescription()

returns some descriptive text about the annotation-board for the purposes of GUI list of choices for example.

getType

int getType()

returns one of EDITOR or DISPLAY depending on whether the NOM can be changed by this annotation board.

getEditableCodingNames

java.util.List getEditableCodingNames()

Find the codings that can be edited - returns n List of Strings

getUsedCodingNames

java.util.List getUsedCodingNames()

Find the codings that can be used but not edited - returns a List of Strings

getEditableObjectSetNames

java.util.List getEditableObjectSetNames()

Find the object sets that can be edited - returns n List of Strings

getUsedOntologyNames

java.util.List getUsedOntologyNames()

Find the ontologies that can be used but not edited - returns a List of Strings

getUsedObjectSetNames

java.util.List getUsedObjectSetNames()

Find the codings that can be used but not edited - returns a List of Strings

getUsedSignals

java.util.List getUsedSignals()

Find the names of the signals that should be displayed with this stylesheet - returns a List of Strings