org.coolmap.core.api.data.ontology

Interface CoolMapOntology

All Known Implementing Classes:

CoolMapOntologyImpl

public interface CoolMapOntology

This class serves the purpose of holding an Ontology structure. It will be used to query parent-child relationships of the Ontology terms it contains. Created by Keqiang Li on 2/14/17.

Method Summary

Modifier and Type	Method and Description
void	addRelationship(java.lang.String parentTermId, java.lang.String childTermId) Add the specified parent-child relationship in this Ontology if the relationship doesn't exist
java.util.Set<java.lang.String>	getAllTermIds() Get all term IDs
java.lang.String	getDescription() Get the description of this Ontology
java.lang.String	getID() Get the ID of this Ontology
java.util.List<java.lang.String>	getImmediateChildTermIds(java.lang.String parentTermId) Get all the immediate child terms of a specified parent term
java.util.List<java.lang.String>	getImmediateParentTermIds(java.lang.String childTermId) Get all the immediate parent terms of a specified child term
java.util.Set<java.lang.String>	getLeafTermIds() Get all leaf term IDs
java.lang.String	getName() Get the name of this Ontology
java.util.Set<java.lang.String>	GetRootTermIds() Get all root term IDs
boolean	hasChildTerms(java.lang.String parentTermID) Check if a specified term has at least one child term
boolean	hasParentTerms(java.lang.String childTermID) Check if a specified term has at least one parent term
boolean	hasRelationship(java.lang.String parentTermId, java.lang.String childTermId) Check if a specified parent-child relationship exists in this Ontology
boolean	hasTerm(java.lang.String termId) Check if a term with specified ID exists
void	setDescription(java.lang.String newDescription) Set or change the description of this Ontology
void	setName(java.lang.String newName) Set or rename this Ontology

Method Detail

getName

java.lang.String getName()

Get the name of this Ontology

Returns:

name of the Ontology

setName

void setName(java.lang.String newName)

Set or rename this Ontology

Parameters:

newName - the new name of the Otology to be used

getID

java.lang.String getID()

Get the ID of this Ontology

Returns:

ID of the Ontology

getDescription

java.lang.String getDescription()

Get the description of this Ontology

Returns:

description of the Ontology

setDescription

void setDescription(java.lang.String newDescription)

Set or change the description of this Ontology

Parameters:

newDescription - the new description of the Ontology

getLeafTermIds

java.util.Set<java.lang.String> getLeafTermIds()

Get all leaf term IDs

Returns:

leaf term IDs

GetRootTermIds

java.util.Set<java.lang.String> GetRootTermIds()

Get all root term IDs

Returns:

root term IDs

getAllTermIds

java.util.Set<java.lang.String> getAllTermIds()

Get all term IDs

Returns:

all term IDs

hasTerm

boolean hasTerm(java.lang.String termId)

Check if a term with specified ID exists

Parameters:

termId - term ID

Returns:

true if the term found, otherwise false

getImmediateChildTermIds

java.util.List<java.lang.String> getImmediateChildTermIds(java.lang.String parentTermId)

Get all the immediate child terms of a specified parent term

Parameters:

parentTermId - ID of the parent term

Returns:

all child term IDs

getImmediateParentTermIds

java.util.List<java.lang.String> getImmediateParentTermIds(java.lang.String childTermId)

Get all the immediate parent terms of a specified child term

Parameters:

childTermId - ID of the child term

Returns:

all parent term IDs

hasChildTerms

boolean hasChildTerms(java.lang.String parentTermID)

Check if a specified term has at least one child term

Parameters:

parentTermID - the ID of the term on which to check

Returns:

true if this term has at least one child term, otherwise false

hasParentTerms

boolean hasParentTerms(java.lang.String childTermID)

Check if a specified term has at least one parent term

Parameters:

childTermID - the ID of the term on which to check

Returns:

true if this term has at least one parent term, otherwise false

addRelationship

void addRelationship(java.lang.String parentTermId,
                     java.lang.String childTermId)

Add the specified parent-child relationship in this Ontology if the relationship doesn't exist

Parameters:

parentTermId - ID of the parent term

childTermId - ID of the child term

hasRelationship

boolean hasRelationship(java.lang.String parentTermId,
                        java.lang.String childTermId)

Check if a specified parent-child relationship exists in this Ontology

Parameters:

parentTermId - ID of the parent term

childTermId - ID of the child term

Returns:

true if the relationship exists, otherwise false