Data.FamilyTree

This module is for Family Trees.

It uses lenses for the manipulation of people. For the usage of lenses, see Data.Lens.Lazy

It is reccomended to use Data.Binary to do saving and loading.

Main types

data Person

The basic type for a person. Nothing meaning unknown (or otherwise non-existent, for intance a death date for someone still alive) is a convention used throughout this library.

Constructors

Person

Fields

name :: Maybe Text

birthdate :: Maybe Day

birthplace :: Maybe Location

deathdate :: Maybe Day

deathplace :: Maybe Location

attributes :: HashMap Text Text

attendedEvents :: IntSet

Instances

Eq Person

Show Person

Binary Person

data Family

The basic type for a family. Which person is head1 and which is head2 is arbitrary, but try to use a consistent rule

Constructors

Family

Fields

head1 :: Maybe Int

head2 :: Maybe Int

relationship :: Maybe Relationship

relationFrom :: Maybe Day

relationTo :: Maybe Day

children :: IntSet

Instances

Eq Family

Show Family

Binary Family

data Event

The basic type for an event. For example:

   Event {
     eventInfo = "Battle of Agincourt"
     eventDate = fromGregorianValid 1415 10 25
     eventAttendees = IM.empty
         }

Constructors

Event

Fields

eventInfo :: Text

eventDate :: Maybe Day

eventAttendees :: IntSet

Instances

Eq Event

Show Event

Binary Event

data FamilyTree

The core structure of a family tree.

Constructors

FamilyTree

Fields

treeName :: Text

people :: IntMap Person

families :: IntMap Family

events :: IntMap Event

Instances

Eq FamilyTree

Show FamilyTree

Binary FamilyTree

Other types

data Location

The Location type. Either a coordinate or a placename.

Constructors

Coord Double Double

PlaceName Text

Instances

Eq Location

Show Location

Binary Location

data Relationship

The Relationship type. Marriage is the default for similarity to GEDCOM.

Constructors

Marriage

Other Text

Instances

Eq Relationship

Show Relationship

Binary Relationship

newtype ID

ID represents an identifier for a person, family, or event. While the constructor is exported, it is probably better to use the various lenses for manipulation, as they echo the changes around the tree.

Constructors

ID Int

Creation

newTree :: Text -> FamilyTree

Creates a new tree with a given name.

addPerson :: FamilyTree -> (FamilyTree, ID)

Adds a person with minimal information, returning the updated family tree and the ID of the new person.

addFamily :: FamilyTree -> (FamilyTree, ID)

Adds a family with minimal information, returning the updated family tree and the ID of the new family.

addEvent :: FamilyTree -> (FamilyTree, ID)

Adds an event with minimal information, returning the updated family tree and the ID of the new event.

Manipulation

personLens :: ID -> Lens FamilyTree Person

Constructs a lens for the manipulation of a person in a family tree, from that person's ID. Using an ID that does not correspond to a person is an error, and it is impossible to create or destroy people using a lens created by this.

familyLens :: ID -> Lens FamilyTree Family

Constructs a lens for the manipulation of a family in a family tree, from that family's ID. Using an ID that does not correspond to a family is an error, and it is impossible to create or destroy families using a lens created by this.

eventLens :: ID -> Lens FamilyTree Event

Constructs a lens for the manipulation of an event in a family tree, from that event's ID. Using an ID that does not correspond to an event is an error, and it is impossible to create or destroy events using a lens created by this.

Destruction

deletePerson :: ID -> FamilyTree -> FamilyTree

Deletes a person from the family tree, removing all references to them.

deleteFamily :: ID -> FamilyTree -> FamilyTree

Deletes a family from the family tree, removing all references to it.

deleteEvent :: ID -> FamilyTree -> FamilyTree

Deletes an event from the family tree, removing all references to it.