Package org.biojavax.ontology
Interface ComparableTerm
- All Superinterfaces:
Annotatable
,Changeable
,Comparable
,RankedCrossRefable
,Term
- All Known Implementing Classes:
SimpleComparableTerm
Makes Term objects comparable properly and adds some extra features to them.
- Since:
- 1.5
- Author:
- Richard Holland
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.biojava.bio.Annotatable
Annotatable.AnnotationForwarder
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ChangeType
static final ChangeType
static final ChangeType
static final ChangeType
Fields inherited from interface org.biojava.bio.Annotatable
ANNOTATION
-
Method Summary
Modifier and TypeMethodDescriptionReturns the (optional) identifier associated with this term.Checks to see if this term is obsolete.void
setDescription
(String description) Sets the description associated with this term.void
setIdentifier
(String identifier) Sets the (optional) identifier associated with this term.void
setObsolete
(Boolean obsolete) Sets the obsolescence flag associated with this term.Methods inherited from interface org.biojava.bio.Annotatable
getAnnotation
Methods inherited from interface org.biojava.utils.Changeable
addChangeListener, addChangeListener, isUnchanging, removeChangeListener, removeChangeListener
Methods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface org.biojavax.RankedCrossRefable
addRankedCrossRef, getRankedCrossRefs, removeRankedCrossRef, setRankedCrossRefs
Methods inherited from interface org.biojava.ontology.Term
addSynonym, getDescription, getName, getOntology, getSynonyms, removeSynonym
-
Field Details
-
IDENTIFIER
-
OBSOLETE
-
DESCRIPTION
-
RANKEDCROSSREF
-
-
Method Details
-
getIdentifier
Returns the (optional) identifier associated with this term.- Returns:
- the string identifier.
-
setIdentifier
Sets the (optional) identifier associated with this term.- Parameters:
identifier
- the identifier to give the term. Null will unset it.- Throws:
ChangeVetoException
- if the identifier is unacceptable.
-
getObsolete
Checks to see if this term is obsolete. As the column in the database is nullable, this value is a Boolean object instead of a boolean simple type. Hence it may also be null.- Returns:
- true if it is, false if not.
-
setObsolete
Sets the obsolescence flag associated with this term.- Parameters:
obsolete
- true if it is obsolete, false if not. Nullable.- Throws:
ChangeVetoException
- if the change is unacceptable.
-
setDescription
Sets the description associated with this term.- Specified by:
setDescription
in interfaceTerm
- Parameters:
description
- the description to give the term. Nullable.- Throws:
ChangeVetoException
- if the description is unacceptable.
-