forestry.core.genetics

Class SpeciesRoot

java.lang.Object

forestry.core.genetics.SpeciesRoot

All Implemented Interfaces:

ISpeciesRoot

Direct Known Subclasses:

BeeRoot, ButterflyRoot, TreeRoot

public abstract class SpeciesRoot
extends java.lang.Object
implements ISpeciesRoot

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.HashMap<java.lang.String,IAllele[]>	speciesTemplates

Constructor Summary

Constructors

Constructor and Description
SpeciesRoot()

Method Summary

Modifier and Type	Method and Description
java.util.List<IMutation>	getCombinations(IAllele other)
java.util.List<IMutation>	getCombinations(IAlleleSpecies parentSpecies0, IAlleleSpecies parentSpecies1, boolean shuffle)
java.util.Map<java.lang.String,IAllele[]>	getGenomeTemplates()
java.util.Collection<? extends IMutation>	getPaths(IAllele result, IChromosomeType chromosomeType)
IAllele[]	getRandomTemplate(java.util.Random rand)
java.util.Map<net.minecraft.item.ItemStack,java.lang.Float>	getResearchCatalysts()
java.util.List<? extends IMutation>	getResultantMutations(IAllele other)
IAllele[]	getTemplate(IAlleleSpecies species) Retrieves a registered template using the passed species.
IAllele[]	getTemplate(java.lang.String identifier) Retrieves a registered template using the passed species unique identifier.
<O,I extends IIndividual> IIndividualTranslator<I,O>	getTranslator(java.lang.Object translatorKey)
void	registerTemplate(IAllele[] template) Registers a bee template using the UID of the first allele as identifier.
<O,I extends IIndividual> void	registerTranslator(java.lang.Object translatorKey, IIndividualTranslator<I,O> translator)
void	setResearchSuitability(net.minecraft.item.ItemStack itemstack, float suitability) Sets an item stack as a valid (generic) research catalyst for this class.
IChromosome[]	templateAsChromosomes(IAllele[] template)
IChromosome[]	templateAsChromosomes(IAllele[] templateActive, IAllele[] templateInactive)
<O,I extends IIndividual> I	translateMember(O objectToTranslator)

Methods inherited from class java.lang.Object

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

Methods inherited from interface forestry.api.genetics.ISpeciesRoot

getAlyzerPlugin, getBreedingTracker, getDefaultTemplate, getIconType, getIndividualTemplates, getKaryotype, getMember, getMember, getMemberClass, getMemberStack, getMemberStack, getMemberStack, getMutations, getSpeciesChromosomeType, getSpeciesCount, getSpeciesPlugin, getType, getTypeForMutation, getTypes, getUID, isMember, isMember, isMember, registerMutation, registerTemplate, templateAsGenome, templateAsGenome, templateAsIndividual, templateAsIndividual

Field Detail

speciesTemplates

protected final java.util.HashMap<java.lang.String,IAllele[]> speciesTemplates

Constructor Detail

SpeciesRoot

public SpeciesRoot()

Method Detail

getResearchCatalysts

public java.util.Map<net.minecraft.item.ItemStack,java.lang.Float> getResearchCatalysts()

Specified by:

getResearchCatalysts in interface ISpeciesRoot

Returns:

List of generic catalysts which should be accepted for research by species of this class.

setResearchSuitability

public void setResearchSuitability(net.minecraft.item.ItemStack itemstack,
                                   float suitability)

Description copied from interface: ISpeciesRoot

Sets an item stack as a valid (generic) research catalyst for this class.

Specified by:

setResearchSuitability in interface ISpeciesRoot

Parameters:

itemstack - ItemStack to set as suitable.

suitability - Float between 0 and 1 to indicate suitability.

getGenomeTemplates

public java.util.Map<java.lang.String,IAllele[]> getGenomeTemplates()

Specified by:

getGenomeTemplates in interface ISpeciesRoot

registerTemplate

public void registerTemplate(IAllele[] template)

Description copied from interface: ISpeciesRoot

Registers a bee template using the UID of the first allele as identifier.

Specified by:

registerTemplate in interface ISpeciesRoot

getRandomTemplate

public IAllele[] getRandomTemplate(java.util.Random rand)

Specified by:

getRandomTemplate in interface ISpeciesRoot

Parameters:

rand - Random to use.

Returns:

A random template from the pool of registered species templates.

getTemplate

public IAllele[] getTemplate(java.lang.String identifier)

Description copied from interface: ISpeciesRoot

Retrieves a registered template using the passed species unique identifier.

Specified by:

getTemplate in interface ISpeciesRoot

Parameters:

identifier - species UID

Returns:

Array of IAllele representing a genome.

getTemplate

public IAllele[] getTemplate(IAlleleSpecies species)

Description copied from interface: ISpeciesRoot

Retrieves a registered template using the passed species.

Specified by:

getTemplate in interface ISpeciesRoot

Parameters:

species - species

Returns:

Array of IAllele representing a genome.

registerTranslator

public <O,I extends IIndividual> void registerTranslator(java.lang.Object translatorKey,
                                                         IIndividualTranslator<I,O> translator)

Specified by:

registerTranslator in interface ISpeciesRoot

getTranslator

@Nullable
public <O,I extends IIndividual> IIndividualTranslator<I,O> getTranslator(java.lang.Object translatorKey)

Specified by:

getTranslator in interface ISpeciesRoot

translateMember

@Nullable
public <O,I extends IIndividual> I translateMember(O objectToTranslator)

Specified by:

translateMember in interface ISpeciesRoot

getCombinations

public java.util.List<IMutation> getCombinations(IAllele other)

Specified by:

getCombinations in interface ISpeciesRoot

Parameters:

other - Allele to match mutations against.

Returns:

All registered mutations the given allele is part of.

getResultantMutations

public java.util.List<? extends IMutation> getResultantMutations(IAllele other)

Specified by:

getResultantMutations in interface ISpeciesRoot

Parameters:

other - Allele to match mutations against.

Returns:

All registered mutations the give allele is resolute of.

getCombinations

public java.util.List<IMutation> getCombinations(IAlleleSpecies parentSpecies0,
                                                 IAlleleSpecies parentSpecies1,
                                                 boolean shuffle)

Specified by:

getCombinations in interface ISpeciesRoot

Returns:

all possible mutations that result from breeding two species

getPaths

public java.util.Collection<? extends IMutation> getPaths(IAllele result,
                                                          IChromosomeType chromosomeType)

Specified by:

getPaths in interface ISpeciesRoot

templateAsChromosomes

public IChromosome[] templateAsChromosomes(IAllele[] template)

Specified by:

templateAsChromosomes in interface ISpeciesRoot

templateAsChromosomes

public IChromosome[] templateAsChromosomes(IAllele[] templateActive,
                                           IAllele[] templateInactive)

Specified by:

templateAsChromosomes in interface ISpeciesRoot