org.biojavax.ontology
Interface ComparableTerm
- All Superinterfaces:
- Annotatable, Changeable, java.lang.Comparable, RankedCrossRefable, Term
- All Known Implementing Classes:
- SimpleComparableTerm
public interface ComparableTerm
- extends Term, RankedCrossRefable, java.lang.Comparable, Changeable
Makes Term objects comparable properly and adds some extra features to them.
- Since:
- 1.5
- Author:
- Richard Holland
Nested classes/interfaces inherited from interface org.biojava.ontology.Term |
Term.Impl |
Fields inherited from interface org.biojava.ontology.Term |
ONTOLOGY |
Method Summary |
java.lang.String |
getIdentifier()
Returns the (optional) identifier associated with this term. |
java.lang.Boolean |
getObsolete()
Checks to see if this term is obsolete. |
void |
setDescription(java.lang.String description)
Sets the description associated with this term. |
void |
setIdentifier(java.lang.String identifier)
Sets the (optional) identifier associated with this term. |
void |
setObsolete(java.lang.Boolean obsolete)
Sets the obsolescence flag associated with this term. |
Methods inherited from interface java.lang.Comparable |
compareTo |
IDENTIFIER
static final ChangeType IDENTIFIER
OBSOLETE
static final ChangeType OBSOLETE
DESCRIPTION
static final ChangeType DESCRIPTION
RANKEDCROSSREF
static final ChangeType RANKEDCROSSREF
getIdentifier
java.lang.String getIdentifier()
- Returns the (optional) identifier associated with this term.
- Returns:
- the string identifier.
setIdentifier
void setIdentifier(java.lang.String identifier)
throws ChangeVetoException
- 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
java.lang.Boolean 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
void setObsolete(java.lang.Boolean obsolete)
throws ChangeVetoException
- 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
void setDescription(java.lang.String description)
throws ChangeVetoException
- Sets the description associated with this term.
- Specified by:
setDescription
in interface Term
- Parameters:
description
- the description to give the term. Nullable.
- Throws:
ChangeVetoException
- if the description is unacceptable.