forestry.core.genetics

Class Classification

java.lang.Object

forestry.core.genetics.Classification

All Implemented Interfaces:

IClassification

Direct Known Subclasses:

Branch

public class Classification
extends java.lang.Object
implements IClassification

Nested Class Summary

Nested classes/interfaces inherited from interface forestry.api.genetics.IClassification

IClassification.EnumClassLevel

Constructor Summary

Constructors

Constructor and Description
Classification(IClassification.EnumClassLevel level, java.lang.String uid, java.lang.String scientific)

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Classification

public Classification(IClassification.EnumClassLevel level,
                      java.lang.String uid,
                      java.lang.String scientific)

Method Detail

getLevel

public IClassification.EnumClassLevel getLevel()

Specified by:

getLevel in interface IClassification

Returns:

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

getUID

public java.lang.String getUID()

Specified by:

getUID in interface IClassification

Returns:

Unique String identifier.

getParent

@Nullable
public IClassification getParent()

Specified by:

getParent in interface IClassification

Returns:

Parent classification, null if this is root.

setParent

public void setParent(IClassification parent)

Description copied from interface: IClassification

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

Specified by:

setParent in interface IClassification

getScientific

public java.lang.String getScientific()

Description copied from interface: IClassification

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

Specified by:

getScientific in interface IClassification

Returns:

flavour text

getName

public java.lang.String getName()

Specified by:

getName in interface IClassification

Returns:

Localized branch name for user display.

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface IClassification

Returns:

Localized description of this branch.

getMemberGroups

public IClassification[] getMemberGroups()

Specified by:

getMemberGroups in interface IClassification

Returns:

Member groups of this one.

addMemberGroup

public void addMemberGroup(IClassification group)

Description copied from interface: IClassification

Adds subgroups to this group.

Specified by:

addMemberGroup in interface IClassification

getMemberSpecies

public IAlleleSpecies[] getMemberSpecies()

Specified by:

getMemberSpecies in interface IClassification

Returns:

Member species of this group.

addMemberSpecies

public void addMemberSpecies(IAlleleSpecies species)

Description copied from interface: IClassification

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

Specified by:

addMemberSpecies in interface IClassification