Package org.biojavax.ontology
Interface ComparableOntology
- All Superinterfaces:
Changeable
,Comparable
,Ontology
- All Known Implementing Classes:
SimpleComparableOntology
An Ontology that can be compared to another.
- Since:
- 1.5
- Author:
- Richard Holland
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.biojava.ontology.Ontology
Ontology.Impl
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ChangeType
static final ChangeType
static final ChangeType
-
Method Summary
Modifier and TypeMethodDescriptionReturn a human-readable description of this ontology.getOrCreateTerm
(String name) Looks for a term with the given name and returns it.getOrCreateTriple
(Term subject, Term object, Term predicate) Looks for a triple with the given subject object and predicate and returns it.getOrImportTerm
(Term term) Looks for a term with the same name as the given term and returns it.Returns the set of terms in this ontology.Returns the set of triples in this ontology.void
setDescription
(String description) Sets a human-readable description of this ontology.void
setTermSet
(Set terms) Clears out all the terms and populates the ontology with the contents of the set passed.void
setTripleSet
(Set triples) Clears out all the triples and populates the ontology with the contents of the set passed.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.biojava.ontology.Ontology
containsTerm, containsTriple, createTerm, createTerm, createTerm, createTriple, createVariable, deleteTerm, getName, getOps, getTerm, getTerms, getTriples, importTerm, setName
-
Field Details
-
TERM
-
TRIPLE
-
DESCRIPTION
-
-
Method Details
-
setDescription
Sets a human-readable description of this ontology.- Specified by:
setDescription
in interfaceOntology
- Parameters:
description
- the description.- Throws:
ChangeVetoException
- in case of problems.
-
getDescription
Return a human-readable description of this ontology.- Specified by:
getDescription
in interfaceOntology
- Returns:
- the description.
-
setTermSet
Clears out all the terms and populates the ontology with the contents of the set passed. The terms should be ComparableTerms.- Parameters:
terms
- a set of Term objects this ontology should have.- Throws:
ChangeVetoException
- if any of them are unacceptable.- See Also:
-
getTermSet
Returns the set of terms in this ontology.- Returns:
- a set of ComparableTerm objects.
- See Also:
-
setTripleSet
Clears out all the triples and populates the ontology with the contents of the set passed.- Parameters:
triples
- the set of ComparableTriple objects this ontology should have.- Throws:
ChangeVetoException
- if any of them are unacceptable.- See Also:
-
getTripleSet
Returns the set of triples in this ontology.- Returns:
- the set of ComparableTriple objects.
-
getOrCreateTerm
Looks for a term with the given name and returns it. If it couldn't be found, then it creates it, adds it to the ontology, then returns it.- Parameters:
name
- the name of the term to look for.- Returns:
- the ComparableTerm representing that name.
-
getOrCreateTriple
Looks for a triple with the given subject object and predicate and returns it. If it couldn't be found, then it creates it, adds it to the ontology, then returns it.- Parameters:
subject
- the subject of the triple eg appleobject
- the object of the triple eg fruitpredicate
- the relationship of the triple eg is_a- Returns:
- the ComparableTriple representing the object subject and predicate.
-
getOrImportTerm
Looks for a term with the same name as the given term and returns it. If it couldn't be found, then it creates it, adds it to the ontology, then returns it.- Parameters:
term
- the term to look for.- Returns:
- the ComparableTerm representing that term in this ontology.
-