com.rubecula.darwin.domain.genetics
Class Allele_Dominance

java.lang.Object
  net.sf.tostring0.AToString
      com.rubecula.darwin.domain.helper.Attribute_
          com.rubecula.darwin.domain.genetics.Allele_
              com.rubecula.darwin.domain.genetics.Allele_Binary
                  com.rubecula.darwin.domain.genetics.Allele_Dominance

All Implemented Interfaces:

Dominance, Allele, Attribute, Basic, CacheSignature, Censusible, EitherOr, net.sf.tostring0.Identifiable, net.sf.tostring0.IToString

public final class Allele_Dominance
extends Allele_Binary
implements Dominance

Lifespan: permanent. A simple implementation of Allele which models two competing alleles: one dominant and one recessive. The base pairs that define each allele are set as a property.

Author:

Robin Hillyard

Field Summary

Fields inherited from class com.rubecula.darwin.domain.genetics.Allele_

LOG

Fields inherited from interface net.sf.tostring0.IToString

ANGBR_OPEN, ANGBRA_CLSE, BRA_CLSE, BRA_OPEN, BRCE_OPEN, BRCS_CLSE, COLON, LIST_SEPARATOR, MAX_ELEMENTS_DEFAULT, S_MT, S_PERCENT, SEPARATOR, SPACE

Constructor Summary

Allele_Dominance(java.lang.String identifier, boolean dominant)
Primary constructor for Allele_Dominance.

Method Summary

boolean

isDominant()

Methods inherited from class com.rubecula.darwin.domain.genetics.Allele_Binary

getBases, getValueAsBoolean, setBases, setValue

Methods inherited from class com.rubecula.darwin.domain.genetics.Allele_

censusMe, getCensusibleChildren, getLocus, getSignature, getStringChars, setLocus, setStringChars, toString

Methods inherited from class com.rubecula.darwin.domain.helper.Attribute_

equals, getAttribute, getIdentifier, getValue, hashCode

Methods inherited from class net.sf.tostring0.AToString

toString, toStringBrief, toStringId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.rubecula.darwin.domain.helper.Attribute

getAttribute, getValue

Methods inherited from interface net.sf.tostring0.IToString

toStringBrief, toStringId

Methods inherited from interface net.sf.tostring0.Identifiable

getIdentifier

Constructor Detail

Allele_Dominance

public Allele_Dominance(java.lang.String identifier,
                        boolean dominant)

Primary constructor for Allele_Dominance. The identifier is forced into a suitable form by calling StringUtilities.capitalizeInitial(String, boolean) such that the initial letter is either capitalized (if dominant) or not. The other letters are uncapitalized. Normally, such alleles are constructed using AlleleFactory.makeDominanceAllele(String, boolean) method.

Parameters:

identifier - the identifier for this pair of alleles (case and number of characters are unconstrained).

dominant - any value.

Method Detail

isDominant

public boolean isDominant()

Specified by:

isDominant in interface Dominance

Returns:

true if this allele is dominant.

See Also:

Dominance.isDominant()