forestry.api.genetics

Interface IClassification

All Known Implementing Classes:

Branch, BranchBees, BranchButterflies, BranchTrees, Classification

public interface IClassification

Biological classifications from domain down to genus.

Used by the *alyzers to display hierarchies.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IClassification.EnumClassLevel

Method Summary

Modifier and Type	Method and Description
void	addMemberGroup(IClassification group) Adds subgroups to this group.
void	addMemberSpecies(IAlleleSpecies species) Used by the allele registry to populate internal collection of branch members on the fly.
java.lang.String	getDescription()
IClassification.EnumClassLevel	getLevel()
IClassification[]	getMemberGroups()
IAlleleSpecies[]	getMemberSpecies()
java.lang.String	getName()
IClassification	getParent()
java.lang.String	getScientific() A branch approximates a "genus" in real life.
java.lang.String	getUID()
void	setParent(IClassification parent) Only used internally by the AlleleRegistry if this classification has been added to another one.

Method Detail

getLevel

IClassification.EnumClassLevel getLevel()

Returns:

Level inside the full hierarchy this particular classification is located at.

getUID

java.lang.String getUID()

Returns:

Unique String identifier.

getName

java.lang.String getName()

Returns:

Localized branch name for user display.

getScientific

java.lang.String getScientific()

A branch approximates a "genus" in real life. Real life examples: "Micrapis", "Megapis"

Returns:

flavour text

getDescription

java.lang.String getDescription()

Returns:

Localized description of this branch.

getMemberGroups

IClassification[] getMemberGroups()

Returns:

Member groups of this one.

addMemberGroup

void addMemberGroup(IClassification group)

Adds subgroups to this group.

getMemberSpecies

IAlleleSpecies[] getMemberSpecies()

Returns:

Member species of this group.

addMemberSpecies

void addMemberSpecies(IAlleleSpecies species)

Used by the allele registry to populate internal collection of branch members on the fly.

getParent

@Nullable
IClassification getParent()

Returns:

Parent classification, null if this is root.

setParent

void setParent(IClassification parent)

Only used internally by the AlleleRegistry if this classification has been added to another one.