org.jscience.biology
Class HistoricalIndividual

java.lang.Object
  extended by org.jscience.biology.Individual
      extended by org.jscience.biology.HistoricalIndividual
All Implemented Interfaces:
java.lang.Cloneable, Positioned
Direct Known Subclasses:
Human

public class HistoricalIndividual
extends Individual

A class representing an individual as part of a genealogical tree. Also used to represent the genealogical relations between individuals.


Constructor Summary
HistoricalIndividual(Species species, java.util.Date dateOfBirth)
          Creates a new HistoricalIndividual object.
HistoricalIndividual(Species species, java.util.Date dateOfBirth, java.util.Date dateOfDeath)
          Creates a new HistoricalIndividual object.
 
Method Summary
 void addChild(HistoricalIndividual child)
          DOCUMENT ME!
 boolean equals(java.lang.Object o)
          DOCUMENT ME!
static Tree extractTree(HistoricalIndividual hIndividual1, HistoricalIndividual hIndividual2)
          DOCUMENT ME!
 java.util.Set getAllChildren()
          DOCUMENT ME!
 Biography getBiography()
          DOCUMENT ME!
 java.util.Set getChildren()
          DOCUMENT ME!
static HistoricalIndividual getCommonRoot(HistoricalIndividual hIndividual1, HistoricalIndividual hIndividual2)
          DOCUMENT ME!
 java.util.Date getDateOfBirth()
          DOCUMENT ME!
 java.util.Date getDateOfDeath()
          DOCUMENT ME!
 java.util.Set getFamily()
          DOCUMENT ME!
static java.util.Vector getLineage(HistoricalIndividual hIndividual1, HistoricalIndividual hIndividual2)
          DOCUMENT ME!
 java.util.Set getMates()
          DOCUMENT ME!
 java.util.Set getParents()
          DOCUMENT ME!
 java.util.Set getRoots()
          DOCUMENT ME!
static java.util.Set getRoots(HistoricalIndividual hIndividual)
          DOCUMENT ME!
 boolean hasBothParents()
          DOCUMENT ME!
 boolean hasChild()
          DOCUMENT ME!
 boolean hasChild(HistoricalIndividual child)
          DOCUMENT ME!
 boolean hasDistantChild(HistoricalIndividual child)
          DOCUMENT ME!
 boolean hasParent()
          DOCUMENT ME!
 boolean isParent(HistoricalIndividual hIndividual)
          DOCUMENT ME!
 void removeChild(HistoricalIndividual child)
          DOCUMENT ME!
 void reparent(HistoricalIndividual oldParent, HistoricalIndividual newParent)
          DOCUMENT ME!
 void setBiography(Biography biography)
          DOCUMENT ME!
 void setChildren(java.util.Set children)
          DOCUMENT ME!
 void setDateOfBirth(java.util.Date dateOfBirth)
          DOCUMENT ME!
 void setDateOfDeath(java.util.Date dateOfDeath)
          DOCUMENT ME!
 
Methods inherited from class org.jscience.biology.Individual
addBehavior, addRole, checkGenome, clone, getAllCells, getAttribute, getBehaviors, getOrgans, getPosition, getRoles, getSex, getSpecies, getStage, getTerritory, getTissues, removeBehavior, removeRole, reproduce, setAttribute, setBehaviors, setOrgans, setPosition, setRoles, setSex, setSpecies, setStage, setTerritory, setTissues
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HistoricalIndividual

public HistoricalIndividual(Species species,
                            java.util.Date dateOfBirth)
Creates a new HistoricalIndividual object.

Parameters:
species - DOCUMENT ME!
dateOfBirth - DOCUMENT ME!

HistoricalIndividual

public HistoricalIndividual(Species species,
                            java.util.Date dateOfBirth,
                            java.util.Date dateOfDeath)
Creates a new HistoricalIndividual object.

Parameters:
species - DOCUMENT ME!
dateOfBirth - DOCUMENT ME!
dateOfDeath - DOCUMENT ME!
Method Detail

getDateOfBirth

public java.util.Date getDateOfBirth()
DOCUMENT ME!

Returns:
DOCUMENT ME!

setDateOfBirth

public void setDateOfBirth(java.util.Date dateOfBirth)
DOCUMENT ME!

Parameters:
dateOfBirth - DOCUMENT ME!

getDateOfDeath

public java.util.Date getDateOfDeath()
DOCUMENT ME!

Returns:
DOCUMENT ME!

setDateOfDeath

public void setDateOfDeath(java.util.Date dateOfDeath)
DOCUMENT ME!

Parameters:
dateOfDeath - DOCUMENT ME!

getBiography

public Biography getBiography()
DOCUMENT ME!

Returns:
DOCUMENT ME!

setBiography

public void setBiography(Biography biography)
DOCUMENT ME!

Parameters:
biography - DOCUMENT ME!

hasChild

public boolean hasChild()
DOCUMENT ME!

Returns:
DOCUMENT ME!

hasChild

public boolean hasChild(HistoricalIndividual child)
DOCUMENT ME!

Parameters:
child - DOCUMENT ME!
Returns:
DOCUMENT ME!

getChildren

public java.util.Set getChildren()
DOCUMENT ME!

Returns:
DOCUMENT ME!

setChildren

public void setChildren(java.util.Set children)
                 throws CircularReferenceException,
                        java.lang.IllegalArgumentException
DOCUMENT ME!

Parameters:
children - DOCUMENT ME!
Throws:
CircularReferenceException - DOCUMENT ME!
java.lang.IllegalArgumentException - DOCUMENT ME!

addChild

public void addChild(HistoricalIndividual child)
              throws CircularReferenceException,
                     java.lang.IllegalArgumentException
DOCUMENT ME!

Parameters:
child - DOCUMENT ME!
Throws:
CircularReferenceException - DOCUMENT ME!
java.lang.IllegalArgumentException - DOCUMENT ME!

removeChild

public void removeChild(HistoricalIndividual child)
DOCUMENT ME!

Parameters:
child - DOCUMENT ME!
Throws:
java.lang.IllegalArgumentException - DOCUMENT ME!

isParent

public boolean isParent(HistoricalIndividual hIndividual)
DOCUMENT ME!

Parameters:
hIndividual - DOCUMENT ME!
Returns:
DOCUMENT ME!

hasParent

public boolean hasParent()
DOCUMENT ME!

Returns:
DOCUMENT ME!

hasBothParents

public boolean hasBothParents()
DOCUMENT ME!

Returns:
DOCUMENT ME!

getParents

public java.util.Set getParents()
DOCUMENT ME!

Returns:
DOCUMENT ME!

reparent

public void reparent(HistoricalIndividual oldParent,
                     HistoricalIndividual newParent)
              throws java.lang.IllegalArgumentException
DOCUMENT ME!

Parameters:
oldParent - DOCUMENT ME!
newParent - DOCUMENT ME!
Throws:
java.lang.IllegalArgumentException - DOCUMENT ME!

getMates

public java.util.Set getMates()
DOCUMENT ME!

Returns:
DOCUMENT ME!

getFamily

public java.util.Set getFamily()
DOCUMENT ME!

Returns:
DOCUMENT ME!

getRoots

public java.util.Set getRoots()
DOCUMENT ME!

Returns:
DOCUMENT ME!

getRoots

public static java.util.Set getRoots(HistoricalIndividual hIndividual)
DOCUMENT ME!

Parameters:
hIndividual - DOCUMENT ME!
Returns:
DOCUMENT ME!

getCommonRoot

public static HistoricalIndividual getCommonRoot(HistoricalIndividual hIndividual1,
                                                 HistoricalIndividual hIndividual2)
DOCUMENT ME!

Parameters:
hIndividual1 - DOCUMENT ME!
hIndividual2 - DOCUMENT ME!
Returns:
DOCUMENT ME!

getLineage

public static java.util.Vector getLineage(HistoricalIndividual hIndividual1,
                                          HistoricalIndividual hIndividual2)
DOCUMENT ME!

Parameters:
hIndividual1 - DOCUMENT ME!
hIndividual2 - DOCUMENT ME!
Returns:
DOCUMENT ME!

extractTree

public static Tree extractTree(HistoricalIndividual hIndividual1,
                               HistoricalIndividual hIndividual2)
DOCUMENT ME!

Parameters:
hIndividual1 - DOCUMENT ME!
hIndividual2 - DOCUMENT ME!
Returns:
DOCUMENT ME!

getAllChildren

public java.util.Set getAllChildren()
DOCUMENT ME!

Returns:
DOCUMENT ME!

hasDistantChild

public boolean hasDistantChild(HistoricalIndividual child)
DOCUMENT ME!

Parameters:
child - DOCUMENT ME!
Returns:
DOCUMENT ME!
Throws:
java.lang.IllegalArgumentException - DOCUMENT ME!

equals

public boolean equals(java.lang.Object o)
DOCUMENT ME!

Overrides:
equals in class Individual
Parameters:
o - DOCUMENT ME!
Returns:
DOCUMENT ME!