Model
Table of Contents
Classes
- Age
- An age at an event: a duration in years, months, weeks and days, or a 5.x word (CHILD,
INFANT, STILLBORN), with "<" or ">" before it, and a phrase. The same value object for every version:
{@see self::parse()} reads the grammar of a version, {@see self::toGedcom()} writes it. The
phrase is the 7.0 PHRASE substructure; 5.x has none.
- Coordinates
- The MAP of a place: LATI and LONG as degrees, north and east positive ("N50.45", "E30.52").
- Date
- One calendar date of a {@see GedcomDate}: a year, optionally a month and a day, in a
calendar. Calendars, months and epochs are GEDCOM tags, written the same for every version:
the 5.x escape "@#DFRENCH R@" is FRENCH_R, "B.C." is the epoch BCE. A 7.0 extension calendar,
month or epoch keeps its tag ("_MAYA"). A dual year ("1648/49", 5.x only) keeps both years.
- Event
- A live view of an event of an individual or a family (BIRT, MARR, EVEN …): its date, place,
age and type. Dates and ages are read and written by the rules of the document's version: in
7.0 their phrase is the PHRASE substructure, in 5.x part of the value.
- Family
- A live view of a FAM record: partners, children and events. Linking an individual also adds
the pointer back (FAMS, FAMC), so the links stay mutual.
- GedcomDate
- A date value: a kind (a date, a range, a period, an approximation or none), its dates and a
phrase. The same value object for every version: {@see self::parse()} reads the grammar of a
version, {@see self::toGedcom()} writes it. In 7.0 the phrase is not part of the value but the
PHRASE substructure; in 5.x it is "INT date (phrase)" or "(phrase)".
- Grammars
- The validator's grammars for the values of the model: a value object accepts exactly what
the validator finds valid, without warnings.
- Individual
- A live view of an INDI record: names, sex, events, and the families it is a child or a
spouse in. Values that are not valid for the version read as null; their text stays on
{@see node()}.
- MediaFile
- A live view of a FILE of a media object: path or URL, format and title.
- MediaObject
- A live view of an OBJE record: its files and title.
- PersonalName
- The value of a personal NAME: the text before the surname, the surname between slashes and
the text after it ("Анна /Коваль/", "Ivan /Petrenko/ Jr."). The same in every version. The
name pieces (GIVN, SURN, NPFX and the others) are substructures, not part of the value.
- Place
- The value of a PLAC: its jurisdictions from the smallest to the largest, "Полтава, Україна".
- RecordView
- A live view of a record: it reads from and writes to the tree, so nothing the view does not
know about is lost. Records it points to are looked up in the file it belongs to; a view of a
streamed record has none and throws {@see RequiresDocumentException} when asked for them.
- Repository
- A live view of a REPO record: an archive or library that holds sources.
- SharedNote
- A live view of a note record: SNOTE in 7.0, NOTE in 5.x; its text is the record's value.
- Source
- A live view of a SOUR record: title, author, publication, abbreviation, text and repositories.
- Submitter
- A live view of a SUBM record: who contributed the data.
Enums
- AgeBound
- "<" or ">" before an age: younger or older than the duration.
- DateKind
- What a {@see GedcomDate} says about its dates.
- Sex
- INDI.SEX.