eu.etaxonomy.cdm.model.taxon
Interface ITreeNode

All Superinterfaces:

IAnnotatableEntity, ICdmBase, IVersionableEntity

All Known Implementing Classes:

AlternativeTreeRoot, Classification, TaxonNode

public interface ITreeNode
extends IAnnotatableEntity

Version:

1.0

Author:

n.hoffmann

Method Summary

TaxonNode	addChildNode(TaxonNode childNode, Reference citation, String microCitation, Synonym synonymToBeUsed) Adds a taxon node as a child of the ITreeNode
TaxonNode	addChildTaxon(Taxon taxon, Reference citation, String microCitation, Synonym synonymToBeUsed) Adds a taxon as a child of the ITreeNode
boolean	deleteChildNode(TaxonNode node) This recursively removes all child nodes from this node and from this taxonomic view.
Set<TaxonNode>	getChildNodes()
String	getMicroReference()
Reference	getReference()
boolean	hasChildNodes() Whether this TreeNode has child nodes attached

Methods inherited from interface eu.etaxonomy.cdm.model.common.IAnnotatableEntity

addAnnotation, addMarker, getAnnotations, getMarkers, hasMarker, hasMarker, removeAnnotation, removeMarker

Methods inherited from interface eu.etaxonomy.cdm.model.common.IVersionableEntity

getUpdated, getUpdatedBy, setUpdated, setUpdatedBy

Methods inherited from interface eu.etaxonomy.cdm.model.common.ICdmBase

getCreated, getCreatedBy, getId, getUuid, setCreated, setCreatedBy, setId, setUuid

Method Detail

addChildNode

TaxonNode addChildNode(TaxonNode childNode,
                       Reference citation,
                       String microCitation,
                       Synonym synonymToBeUsed)

Adds a taxon node as a child of the ITreeNode

Parameters:

childNode -

citation -

microCitation -

synonymToBeUsed -

Returns:

the child node

addChildTaxon

TaxonNode addChildTaxon(Taxon taxon,
                        Reference citation,
                        String microCitation,
                        Synonym synonymToBeUsed)

Adds a taxon as a child of the ITreeNode

Parameters:

taxon -

citation -

microCitation -

synonymToBeUsed -

Returns:

the child node

hasChildNodes

boolean hasChildNodes()

Whether this TreeNode has child nodes attached

Returns:

true if this node has children

deleteChildNode

boolean deleteChildNode(TaxonNode node)

This recursively removes all child nodes from this node and from this taxonomic view. TODO remove orphan nodes completely

Parameters:

node -

Returns:

true on success

getReference

Reference getReference()

Returns:

the citation for the parent child relationship or the tree itself

getChildNodes

Set<TaxonNode> getChildNodes()

getMicroReference

String getMicroReference()

Returns:

the microCitation for the parent child relationship or the tree itself