net.sourceforge.nite.meta.impl
Class NiteAnnotationSpec

java.lang.Object
  net.sourceforge.nite.meta.impl.NiteAnnotationSpec

All Implemented Interfaces:

NAnnotationSpec

public class NiteAnnotationSpec
extends java.lang.Object
implements NAnnotationSpec

A AnnotationSpec as referred to in the metadata

Author:

jonathan

Field Summary

Fields inherited from interface net.sourceforge.nite.meta.NAnnotationSpec

DISPLAY, EDITOR

Constructor Summary

NiteAnnotationSpec(int type, java.lang.String name, java.lang.String description, java.util.ArrayList ecodings, java.util.ArrayList ucodings, java.util.ArrayList eobjectsets, java.util.ArrayList uobjectsets, java.util.ArrayList uontologies, java.util.ArrayList signals)

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 an ArrayList 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 spec.
java.util.List	getUsedCodingNames() Find the codings that can be used but not edited - returns an ArrayList 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 AnnotationSpec - returns ArrayList of Strings

Methods inherited from class java.lang.Object

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

Constructor Detail

NiteAnnotationSpec

public NiteAnnotationSpec(int type,
                          java.lang.String name,
                          java.lang.String description,
                          java.util.ArrayList ecodings,
                          java.util.ArrayList ucodings,
                          java.util.ArrayList eobjectsets,
                          java.util.ArrayList uobjectsets,
                          java.util.ArrayList uontologies,
                          java.util.ArrayList signals)

Method Detail

getFileName

public java.lang.String getFileName()

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

Specified by:

getFileName in interface NAnnotationSpec

getDescription

public java.lang.String getDescription()

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

Specified by:

getDescription in interface NAnnotationSpec

getType

public int getType()

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

Specified by:

getType in interface NAnnotationSpec

getEditableCodingNames

public java.util.List getEditableCodingNames()

Find the codings that can be edited - returns an ArrayList of Strings

Specified by:

getEditableCodingNames in interface NAnnotationSpec

getUsedCodingNames

public java.util.List getUsedCodingNames()

Find the codings that can be used but not edited - returns an ArrayList of Strings

Specified by:

getUsedCodingNames in interface NAnnotationSpec

getUsedObjectSetNames

public java.util.List getUsedObjectSetNames()

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

Specified by:

getUsedObjectSetNames in interface NAnnotationSpec

getEditableObjectSetNames

public java.util.List getEditableObjectSetNames()

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

Specified by:

getEditableObjectSetNames in interface NAnnotationSpec

getUsedOntologyNames

public java.util.List getUsedOntologyNames()

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

Specified by:

getUsedOntologyNames in interface NAnnotationSpec

getUsedSignals

public java.util.List getUsedSignals()

Find the names of the signals that should be displayed with this AnnotationSpec - returns ArrayList of Strings

Specified by:

getUsedSignals in interface NAnnotationSpec