Maintainer	nvd124@gmail.com
Stability	unstable
Portability	portable
Safe Haskell	None
Language	Haskell98

Data.FamilyTree

Contents

Types
- Main types
- Other types
Functions
Utility functions

Description

This module is for Family Trees.

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

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

Synopsis

Types

Main types

data Person Source

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 _personId :: Int _name :: Maybe Text _birthdate :: Maybe PartialDate _birthplace :: Maybe Location _deathdate :: Maybe PartialDate _deathplace :: Maybe Location _attributes :: HashMap Text Text

Instances

Eq Person
Show Person
Generic Person
Monoid Person
Binary Person
Tabular Person
FamilyTreePart Person
type Rep Person
data Tab Person = PersonTab (i Primary Int) (i SupplementalHash (Maybe Text)) (i Supplemental (Maybe PartialDate)) (i SupplementalHash (Maybe Location)) (i Supplemental (Maybe PartialDate)) (i SupplementalHash (Maybe Location))
type PKT Person = Int
data Key k Person where PersonID :: Key Primary Person Int Name :: Key SupplementalHash Person (Maybe Text) BirthDate :: Key Supplemental Person (Maybe PartialDate) BirthPlace :: Key SupplementalHash Person (Maybe Location) DeathDate :: Key Supplemental Person (Maybe PartialDate) DeathPlace :: Key SupplementalHash Person (Maybe Location)

name :: Lens' Person (Maybe Text) Source

attributes :: Lens' Person (HashMap Text Text) Source

birthdate :: Lens' Person (Maybe PartialDate) Source

birthplace :: Lens' Person (Maybe Location) Source

deathdate :: Lens' Person (Maybe PartialDate) Source

deathplace :: Lens' Person (Maybe Location) Source

data Family Source

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 _familyId :: Int _head1 :: Maybe Int _head2 :: Maybe Int _relationship :: Maybe Relationship _relationFrom :: Maybe PartialDate _relationTo :: Maybe PartialDate _children :: IntSet

Instances

Eq Family
Show Family
Generic Family
Monoid Family
Binary Family
Tabular Family
FamilyTreePart Family
type Rep Family
data Tab Family = FamilyTab (i Primary Int) (i Supplemental (Maybe Int)) (i Supplemental (Maybe Int)) (i SupplementalHash (Maybe Relationship)) (i Supplemental (Maybe PartialDate)) (i Supplemental (Maybe PartialDate)) (i InvertedInt IntSet)
type PKT Family = Int
data Key k Family where FamilyID :: Key Primary Family Int Head1 :: Key Supplemental Family (Maybe Int) Head2 :: Key Supplemental Family (Maybe Int) Relationship :: Key SupplementalHash Family (Maybe Relationship) RelationFrom :: Key Supplemental Family (Maybe PartialDate) RelationTo :: Key Supplemental Family (Maybe PartialDate) Children :: Key InvertedInt Family IntSet

head1 :: Lens' Family (Maybe Int) Source

head2 :: Lens' Family (Maybe Int) Source

children :: Lens' Family IntSet Source

relationFrom :: Lens' Family (Maybe PartialDate) Source

relationTo :: Lens' Family (Maybe PartialDate) Source

relationship :: Lens' Family (Maybe Relationship) Source

data FamilyTree Source

The core structure of a family tree.

Constructors

FamilyTree
Fields _treeName :: Text _people :: Table Person _families :: Table Family

Instances

Eq FamilyTree
Show FamilyTree
Generic FamilyTree
Binary FamilyTree
type Rep FamilyTree

treeName :: Lens' FamilyTree Text Source

people :: Lens' FamilyTree (Table Person) Source

families :: Lens' FamilyTree (Table Family) Source

Other types

type PartialDate = Interval Day Source

data Location Source

The Location type. Either a coordinate or a placename.

Constructors

Coord Double Double
PlaceName Text

Instances

Eq Location
Show Location
IsString Location
Generic Location
Binary Location
Hashable Location
type Rep Location

data Relationship Source

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

Constructors

Marriage
Other Text

Instances

Eq Relationship
Show Relationship
Generic Relationship
Binary Relationship
Hashable Relationship
type Rep Relationship

Functions

Creation

newTree :: Text -> FamilyTree Source

Creates a new tree with a given name.

addPerson :: FamilyTree -> (Int, FamilyTree) Source

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

addFamily :: FamilyTree -> (Int, FamilyTree) Source

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

Manipulation

class FamilyTreePart part where Source

Methods

accessFT :: Int -> IndexedTraversal' Int FamilyTree part Source

accessFT is a Traversal to the part of the family tree (either a Person or a Family)

Instances

FamilyTreePart Person
FamilyTreePart Family

Destruction

deletePerson :: Int -> FamilyTree -> FamilyTree Source

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

deleteFamily :: Int -> FamilyTree -> FamilyTree Source

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

Utility functions

partialDateFromYear :: Integer -> PartialDate Source

partialDateFromMonth :: Integer -> Int -> PartialDate Source

partialDateFromDay :: Integer -> Int -> Int -> PartialDate Source