Git Product home page Git Product logo

gedcom's Introduction

gedcom

-- import "vimagination.zapto.org/gedcom"

Package gedcom implements a parser to read genealogical data in a standard format.

Usage

var (
	ErrNoHeader  = errors.New("no header")
	ErrNoRecords = errors.New("no records")
	ErrNotLevel  = errors.New("not level token")
	ErrNotTag    = errors.New("not tag token")
	ErrNotLine   = errors.New("not line_value token")
)

Errors.

var (
	ErrRequiredMissing = errors.New("required tag missing")
	ErrSingleMultiple  = errors.New("tag was specified more than the one time allowed")
	ErrUnknownTag      = errors.New("unknown tag")
)

Errors.

var (
	ErrInvalidLevel   = errors.New("invalid level num")
	ErrMissingDelim   = errors.New("missing delminitator")
	ErrInvalidPointer = errors.New("invalid pointer string")
	ErrInvalidTag     = errors.New("invalid tag")
	ErrBadEscape      = errors.New("bad escape sequence")
	ErrBadChar        = errors.New("bad character")
)

Errors.

func AllowInvalidChars

func AllowInvalidChars(o *options)

AllowInvalidChars allows control characters (<32) in line_values.

func AllowInvalidEscape

func AllowInvalidEscape(o *options)

AllowInvalidEscape turns off error reporting for invalid escape sequences.

func AllowMissingRequired

func AllowMissingRequired(o *options)

AllowMissingRequired turns off error reporting for a missing required field.

func AllowMoreThanAllowed

func AllowMoreThanAllowed(o *options)

AllowMoreThanAllowed turns off error reporting when more than the maxumum number of a certain item are read.

func AllowTerminatorsInValue

func AllowTerminatorsInValue(o *options)

AllowTerminatorsInValue allows a line_value to contain newlines.

func AllowUnknownCharset

func AllowUnknownCharset(o *options)

AllowUnknownCharset allows the parser to read any character, not just those within ANSEL.

func AllowUnknownTags

func AllowUnknownTags(o *options)

AllowUnknownTags turns off error reporting when an unknown tag is read.

func AllowWrongLength

func AllowWrongLength(o *options)

AllowWrongLength turns off error reporting when a base type has an incorrect length.

func IgnoreInvalidValue

func IgnoreInvalidValue(o *options)

IgnoreInvalidValue turns off error reporting when a non-valid value if read.

type AddressCity

type AddressCity string

AddressCity is a GEDCOM base type.

type AddressCountry

type AddressCountry string

AddressCountry is a GEDCOM base type.

type AddressLine

type AddressLine string

AddressLine is a GEDCOM base type.

type AddressLine1

type AddressLine1 string

AddressLine1 is a GEDCOM base type.

type AddressLine2

type AddressLine2 string

AddressLine2 is a GEDCOM base type.

type AddressPostalCode

type AddressPostalCode string

AddressPostalCode is a GEDCOM base type.

type AddressState

type AddressState string

AddressState is a GEDCOM base type.

type AddressStructure

type AddressStructure struct {
	AddressLine  AddressLine
	AddressLine1 AddressLine1
	AddressLine2 AddressLine2
	City         AddressCity
	State        AddressState
	PostalCode   AddressPostalCode
	Country      AddressCountry
}

AddressStructure is a GEDCOM structure type.

type AdoptedBy

type AdoptedBy string

AdoptedBy is a GEDCOM base type.

type AdoptionEvent

type AdoptionEvent struct {
	Family AdoptionReference
	EventDetail
}

AdoptionEvent is a GEDCOM structure type.

type AdoptionReference

type AdoptionReference struct {
	ID        Xref
	AdoptedBy AdoptedBy
}

AdoptionReference is a GEDCOM structure type.

type AgeAtEvent

type AgeAtEvent string

AgeAtEvent is a GEDCOM base type.

type AgeStructure

type AgeStructure struct {
	Age AgeAtEvent
}

AgeStructure is a GEDCOM structure type.

type AncestralFileNumber

type AncestralFileNumber string

AncestralFileNumber is a GEDCOM base type.

type ApprovedSystemID

type ApprovedSystemID string

ApprovedSystemID is a GEDCOM base type.

type AssociationStructure

type AssociationStructure struct {
	ID         Xref
	RecordType RecordType
	Relation   RelationIsDescriptor
	Notes      []NoteStructure
	Sources    []SourceCitation
}

AssociationStructure is a GEDCOM structure type.

type AttributeType

type AttributeType string

AttributeType is a GEDCOM base type.

type AutomatedRecordID

type AutomatedRecordID string

AutomatedRecordID is a GEDCOM base type.

type CasteEvent

type CasteEvent struct {
	CasteName CasteName
	EventDetail
}

CasteEvent is a GEDCOM structure type.

type CasteName

type CasteName string

CasteName is a GEDCOM base type.

type CauseOfEvent

type CauseOfEvent string

CauseOfEvent is a GEDCOM base type.

type CertaintyAssessment

type CertaintyAssessment uint

CertaintyAssessment is a GEDCOM base type.

type ChangeDate

type ChangeDate string

ChangeDate is a GEDCOM base type.

type ChangeDateStructure

type ChangeDateStructure struct {
	Date  ChangeDateTime
	Notes []NoteStructure
}

ChangeDateStructure is a GEDCOM structure type.

type ChangeDateTime

type ChangeDateTime struct {
	ChangeDate ChangeDate
	Time       TimeValue
}

ChangeDateTime is a GEDCOM structure type.

type CharacterSet

type CharacterSet string

CharacterSet is a GEDCOM base type.

type CharacterSetStructure

type CharacterSetStructure struct {
	CharacterSet  CharacterSet
	VersionNumber VersionNumber
}

CharacterSetStructure is a GEDCOM structure type.

type ChildToFamilyLink

type ChildToFamilyLink struct {
	ID                  Xref
	PedigreeLinkageType []PedigreeLinkageType
	Notes               []NoteStructure
}

ChildToFamilyLink is a GEDCOM structure type.

type ChildrenEvent

type ChildrenEvent struct {
	CountOfChildren CountOfChildren
	EventDetail
}

ChildrenEvent is a GEDCOM structure type.

type ContentDescription

type ContentDescription string

ContentDescription is a GEDCOM base type.

type CopyrightGedcomFile

type CopyrightGedcomFile string

CopyrightGedcomFile is a GEDCOM base type.

type CopyrightSourceData

type CopyrightSourceData string

CopyrightSourceData is a GEDCOM base type.

type CountOfChildren

type CountOfChildren uint8

CountOfChildren is a GEDCOM base type.

type CountOfMarriages

type CountOfMarriages uint8

CountOfMarriages is a GEDCOM base type.

type Date

type Date string

Date is a GEDCOM base type.

type DateApproximated

type DateApproximated string

DateApproximated is a GEDCOM base type.

type DateCalendar

type DateCalendar string

DateCalendar is a GEDCOM base type.

type DateCalendarEscape

type DateCalendarEscape string

DateCalendarEscape is a GEDCOM base type.

type DateExact

type DateExact string

DateExact is a GEDCOM base type.

type DateFren

type DateFren string

DateFren is a GEDCOM base type.

type DateGreg

type DateGreg string

DateGreg is a GEDCOM base type.

type DateHebr

type DateHebr string

DateHebr is a GEDCOM base type.

type DateJuln

type DateJuln string

DateJuln is a GEDCOM base type.

type DateLDSOrd

type DateLDSOrd string

DateLDSOrd is a GEDCOM base type.

type DatePeriod

type DatePeriod string

DatePeriod is a GEDCOM base type.

type DatePhrase

type DatePhrase string

DatePhrase is a GEDCOM base type.

type DateRange

type DateRange string

DateRange is a GEDCOM base type.

type DateValue

type DateValue string

DateValue is a GEDCOM base type.

type Day

type Day uint8

Day is a GEDCOM base type.

type DescriptionEvent

type DescriptionEvent struct {
	PhysicalDescription PhysicalDescription
	EventDetail
}

DescriptionEvent is a GEDCOM structure type.

type DescriptiveTitle

type DescriptiveTitle string

DescriptiveTitle is a GEDCOM base type.

type Digit

type Digit uint8

Digit is a GEDCOM base type.

type EncodedMultimediaLine

type EncodedMultimediaLine string

EncodedMultimediaLine is a GEDCOM base type.

type EntryRecordingDate

type EntryRecordingDate string

EntryRecordingDate is a GEDCOM base type.

type ErrContext

type ErrContext struct {
	Structure, Tag string
	Err            error
}

ErrContext adds context to a returned error.

func (ErrContext) Error

func (e ErrContext) Error() string

Error implements the error interface.

func (ErrContext) Unwrap

func (e ErrContext) Unwrap() error

Unwrap goes through the error list to retrieve the underlying (non-ErrContext) error.

type ErrInvalidLength

type ErrInvalidLength struct {
	Type, Value string
	Min, Max    uint
}

ErrInvalidLength is an error that is generated when a type is given more or less data than is required.

func (ErrInvalidLength) Error

func (e ErrInvalidLength) Error() string

Error is an implementation of the error interface.

type ErrInvalidValue

type ErrInvalidValue struct {
	Type, Value string
}

ErrInvalidValue is an error that is generated when a type is not one of the specified values.

func (ErrInvalidValue) Error

func (e ErrInvalidValue) Error() string

Error is an implementation of the error interface.

type ErrTooMany

type ErrTooMany int

ErrTooMany is an error returned when too many of a particular tag exist.

func (ErrTooMany) Error

func (ErrTooMany) Error() string

Error implements the error interface.

type EventAttributeType

type EventAttributeType string

EventAttributeType is a GEDCOM base type.

type EventDescriptor

type EventDescriptor string

EventDescriptor is a GEDCOM base type.

type EventDetail

type EventDetail struct {
	Type              EventDescriptor
	Date              DateValue
	Place             PlaceStructure
	Address           AddressStructure
	PhoneNumber       []PhoneNumber
	Age               AgeAtEvent
	ResponsibleAgency ResponsibleAgency
	CauseOfEvent      CauseOfEvent
	Sources           []SourceCitation
	Multimedia        []MultimediaLink
	Notes             []NoteStructure
}

EventDetail is a GEDCOM structure type.

type EventTypeCitedFrom

type EventTypeCitedFrom string

EventTypeCitedFrom is a GEDCOM base type.

type EventTypeFamile

type EventTypeFamile string

EventTypeFamile is a GEDCOM base type.

type EventTypeIndividual

type EventTypeIndividual string

EventTypeIndividual is a GEDCOM base type.

type EventsRecorded

type EventsRecorded string

EventsRecorded is a GEDCOM base type.

type EventsRecordedStructure

type EventsRecordedStructure struct {
	DatePeriod              DatePeriod
	SourceJurisdictionPlace SourceJurisdictionPlace
}

EventsRecordedStructure is a GEDCOM structure type.

type Family

type Family struct {
	ID                 Xref
	Annulment          VerifiedFamilyEventDetail
	Census             VerifiedFamilyEventDetail
	Divorce            VerifiedFamilyEventDetail
	DivorceFiled       VerifiedFamilyEventDetail
	Engagement         VerifiedFamilyEventDetail
	Marriage           VerifiedFamilyEventDetail
	MarriageBann       VerifiedFamilyEventDetail
	MarriageContract   VerifiedFamilyEventDetail
	MarriageLicense    VerifiedFamilyEventDetail
	MarriageSettlement VerifiedFamilyEventDetail
	Events             []FamilyEventDetail
	Husband            Xref
	Wife               Xref
	Children           []Xref
	NumChildren        CountOfChildren
	Submitters         []Xref
	LDSSpouseSealing   []LDSSpouseSealing
	Sources            []SourceCitation
	Multimedia         []MultimediaLink
	Notes              []NoteStructure
}

Family is a GEDCOM structure type.

func (Family) Type

func (Family) Type() RecordID

Type implements the Record interface.

type FamilyEventDetail

type FamilyEventDetail struct {
	HusbandAge AgeStructure
	WifeAge    AgeStructure
	EventDetail
}

FamilyEventDetail is a GEDCOM structure type.

type FileName

type FileName string

FileName is a GEDCOM base type.

type Form

type Form string

Form is a GEDCOM base type.

type GenerationsOfAncestors

type GenerationsOfAncestors uint16

GenerationsOfAncestors is a GEDCOM base type.

type GenerationsOfDescendants

type GenerationsOfDescendants uint16

GenerationsOfDescendants is a GEDCOM base type.

type Header

type Header struct {
	Source              HeaderSource
	ReceivingSystemName ReceivingSystemName
	TransmissionLDate   TransmissionDateTime
	Submitter           Xref
	Submission          Xref
	FileName            FileName
	Copyright           CopyrightGedcomFile
	Version             Version
	CharacterSet        CharacterSetStructure
	Language            LanguageOfText
	Place               HeaderPlace
	ContentDescription  ContentDescription
}

Header is a GEDCOM structure type.

func (Header) Type

func (Header) Type() RecordID

Type implements the Record interface.

type HeaderBusiness

type HeaderBusiness struct {
	NameOfBusiness NameOfBusiness
	Address        AddressStructure
	PhoneNumber    []PhoneNumber
}

HeaderBusiness is a GEDCOM structure type.

type HeaderDataSource

type HeaderDataSource struct {
	SourceName          NameOfSourceData
	PublicationDate     PublicationDate
	CopyrightSourceData CopyrightSourceData
}

HeaderDataSource is a GEDCOM structure type.

type HeaderPlace

type HeaderPlace struct {
	PlaceHierarchy PlaceHierarchy
}

HeaderPlace is a GEDCOM structure type.

type HeaderSource

type HeaderSource struct {
	SystemID      ApprovedSystemID
	VersionNumber VersionNumber
	Name          NameOfProduct
	Business      HeaderBusiness
	Data          HeaderDataSource
}

HeaderSource is a GEDCOM structure type.

type Individual

type Individual struct {
	ID                    Xref
	RestrictionNotice     RestrictionNotice
	PersonalNameStructure []PersonalNameStructure
	Gender                SexValue
	Birth                 VerifiedIndividualFamEventDetail
	Christening           VerifiedIndividualFamEventDetail
	Death                 VerifiedEventDetail
	Buried                VerifiedEventDetail
	Cremation             VerifiedEventDetail
	Adoption              AdoptionEvent
	Maptism               VerifiedEventDetail
	BarMitzvah            VerifiedEventDetail
	BasMitzvah            VerifiedEventDetail
	Blessing              VerifiedEventDetail
	AdultChristening      VerifiedEventDetail
	Confirmation          VerifiedEventDetail
	FirstCommunion        VerifiedEventDetail
	Ordination            VerifiedEventDetail
	Naturalization        VerifiedEventDetail
	Emigrated             VerifiedEventDetail
	Immigrated            VerifiedEventDetail
	Census                VerifiedEventDetail
	Probate               VerifiedEventDetail
	Will                  VerifiedEventDetail
	Graduated             VerifiedEventDetail
	Retired               VerifiedEventDetail
	Events                []IndividualEventDetail
	Caste                 []CasteEvent
	Description           []DescriptionEvent
	ScholasticAchievement []ScholasticEvent
	NationalID            []NationalIDEvent
	NationalTribalOrigin  []NationalOriginEvent
	CountOfChildren       []ChildrenEvent
	CountOfMarriages      []MarriagesEvent
	Occupation            []OccupationEvent
	Possessions           []PossessionEvent
	ReligiousAffiliation  []ReligiousEvent
	Residences            []ResidenceEvent
	SocialSecurity        []SSNEvent
	NobilityTypeTitle     []NobilityEvent
	ChildOf               []ChildToFamilyLink
	SpouseOf              []SpouseToFamilyLink
	Submitters            []Xref
	Associations          []AssociationStructure
	Aliases               []Xref
	AncestorInterest      []Xref
	DescendentInterest    []Xref
	Sources               []SourceCitation
	Multimedia            []MultimediaLink
	Notes                 []NoteStructure
	PermanentRecord       PermanentRecordFileNumber
	AncestralFileNumber   AncestralFileNumber
	UserReferences        []UserReferenceStructure
	AutomatedRecordID     AutomatedRecordID
	ChangeDate            ChangeDateStructure
}

Individual is a GEDCOM structure type.

func (Individual) Type

func (Individual) Type() RecordID

Type implements the Record interface.

type IndividualEventDetail

type IndividualEventDetail struct {
	EventDetail
}

IndividualEventDetail is a GEDCOM structure type.

type LDSBaptismDateStatus

type LDSBaptismDateStatus string

LDSBaptismDateStatus is a GEDCOM base type.

type LDSChildSealingDateStatus

type LDSChildSealingDateStatus string

LDSChildSealingDateStatus is a GEDCOM base type.

type LDSEndowmentDateStatus

type LDSEndowmentDateStatus string

LDSEndowmentDateStatus is a GEDCOM base type.

type LDSSpouseSealing

type LDSSpouseSealing struct {
	LDSSpouseSealingDateStatus LDSSpouseSealingDateStatus
	Date                       DateLDSOrd
	TempleCode                 TempleCode
	Place                      PlaceLivingOrdinance
	Sources                    []SourceCitation
	Notes                      []NoteStructure
}

LDSSpouseSealing is a GEDCOM structure type.

type LDSSpouseSealingDateStatus

type LDSSpouseSealingDateStatus string

LDSSpouseSealingDateStatus is a GEDCOM base type.

type LanguageID

type LanguageID string

LanguageID is a GEDCOM base type.

type LanguageOfText

type LanguageOfText string

LanguageOfText is a GEDCOM base type.

type LanguagePreference

type LanguagePreference string

LanguagePreference is a GEDCOM base type.

type Line

type Line struct {
	Sub []Line
}

Line represents an unknown GEDCOM record.

func (Line) Type

func (Line) Type() RecordID

Type implements the Record interface.

type MarriagesEvent

type MarriagesEvent struct {
	CountOfMarriages CountOfMarriages
	EventDetail
}

MarriagesEvent is a GEDCOM structure type.

type Month

type Month string

Month is a GEDCOM base type.

type MonthFren

type MonthFren string

MonthFren is a GEDCOM base type.

type MonthHebr

type MonthHebr string

MonthHebr is a GEDCOM base type.

type MultimediaFileReference

type MultimediaFileReference string

MultimediaFileReference is a GEDCOM base type.

type MultimediaFormat

type MultimediaFormat string

MultimediaFormat is a GEDCOM base type.

type MultimediaLink

type MultimediaLink struct {
	Data Record
}

MultimediaLink splite between MultimediaLinkID and MultimediaLinkFile

type MultimediaLinkFile

type MultimediaLinkFile struct {
	Format MultimediaFormat
	Title  DescriptiveTitle
	File   MultimediaFileReference
	Notes  []NoteStructure
}

MultimediaLinkFile is a GEDCOM structure type.

func (MultimediaLinkFile) Type

func (MultimediaLinkFile) Type() RecordID

Type implements the Record interface.

type MultimediaLinkID

type MultimediaLinkID struct {
	ID Xref
}

MultimediaLinkID is a GEDCOM structure type.

func (MultimediaLinkID) Type

func (MultimediaLinkID) Type() RecordID

Type implements the Record interface.

type MultimediaRecord

type MultimediaRecord struct {
	ID                Xref
	Format            MultimediaFormat
	Title             DescriptiveTitle
	Notes             []NoteStructure
	Blob              EncodedMultimediaLine
	ContinuedObject   Xref
	UserReferences    []UserReferenceStructure
	AutomatedRecordID AutomatedRecordID
	ChangeDate        ChangeDateStructure
}

MultimediaRecord is a GEDCOM structure type.

func (MultimediaRecord) Type

func (MultimediaRecord) Type() RecordID

Type implements the Record interface.

type NameOfBusiness

type NameOfBusiness string

NameOfBusiness is a GEDCOM base type.

type NameOfFamilyFile

type NameOfFamilyFile string

NameOfFamilyFile is a GEDCOM base type.

type NameOfProduct

type NameOfProduct string

NameOfProduct is a GEDCOM base type.

type NameOfRepository

type NameOfRepository string

NameOfRepository is a GEDCOM base type.

type NameOfSourceData

type NameOfSourceData string

NameOfSourceData is a GEDCOM base type.

type NamePersonal

type NamePersonal string

NamePersonal is a GEDCOM base type.

type NamePiece

type NamePiece string

NamePiece is a GEDCOM base type.

type NamePieceGiven

type NamePieceGiven string

NamePieceGiven is a GEDCOM base type.

type NamePieceNickname

type NamePieceNickname string

NamePieceNickname is a GEDCOM base type.

type NamePiecePrefix

type NamePiecePrefix string

NamePiecePrefix is a GEDCOM base type.

type NamePieceSuffix

type NamePieceSuffix string

NamePieceSuffix is a GEDCOM base type.

type NamePieceSurname

type NamePieceSurname string

NamePieceSurname is a GEDCOM base type.

type NamePieceSurnamePrefix

type NamePieceSurnamePrefix string

NamePieceSurnamePrefix is a GEDCOM base type.

type NationalIDEvent

type NationalIDEvent struct {
	NationalIDNumber NationalIDNumber
	EventDetail
}

NationalIDEvent is a GEDCOM structure type.

type NationalIDNumber

type NationalIDNumber string

NationalIDNumber is a GEDCOM base type.

type NationalOrTribalOrigin

type NationalOrTribalOrigin string

NationalOrTribalOrigin is a GEDCOM base type.

type NationalOriginEvent

type NationalOriginEvent struct {
	NationalOrTribalOrigin NationalOrTribalOrigin
	EventDetail
}

NationalOriginEvent is a GEDCOM structure type.

type NewTag

type NewTag string

NewTag is a GEDCOM base type.

type NobilityEvent

type NobilityEvent struct {
	NobilityTypeTitle NobilityTypeTitle
	EventDetail
}

NobilityEvent is a GEDCOM structure type.

type NobilityTypeTitle

type NobilityTypeTitle string

NobilityTypeTitle is a GEDCOM base type.

type NoteID

type NoteID struct {
	ID Xref
}

NoteID is a GEDCOM structure type.

func (NoteID) Type

func (NoteID) Type() RecordID

Type implements the Record interface.

type NoteRecord

type NoteRecord struct {
	ID                Xref
	SubmitterText     SubmitterText
	Sources           []SourceCitation
	UserReferences    []UserReferenceStructure
	AutomatedRecordID AutomatedRecordID
	ChangeDate        ChangeDateStructure
}

NoteRecord is a GEDCOM structure type.

func (NoteRecord) Type

func (NoteRecord) Type() RecordID

Type implements the Record interface.

type NoteStructure

type NoteStructure struct {
	Data Record
}

NoteStructure splits between NoteID and NoteText.

type NoteText

type NoteText struct {
	SubmitterText SubmitterText
	Sources       []SourceCitation
}

NoteText is a GEDCOM structure type.

func (NoteText) Type

func (NoteText) Type() RecordID

Type implements the Record interface.

type Number

type Number uint

Number is a GEDCOM base type.

type Occupation

type Occupation string

Occupation is a GEDCOM base type.

type OccupationEvent

type OccupationEvent struct {
	Occupation Occupation
	EventDetail
}

OccupationEvent is a GEDCOM structure type.

type Option

type Option func(o *options)

Option type for turning off generated errors.

type OrdinanceProcessFlag

type OrdinanceProcessFlag string

OrdinanceProcessFlag is a GEDCOM base type.

type PedigreeLinkageType

type PedigreeLinkageType string

PedigreeLinkageType is a GEDCOM base type.

type PermanentRecordFileNumber

type PermanentRecordFileNumber string

PermanentRecordFileNumber is a GEDCOM base type.

type PersonalNameStructure

type PersonalNameStructure struct {
	NamePersonal  NamePersonal
	Prefix        NamePiecePrefix
	Given         NamePieceGiven
	Nickname      NamePieceNickname
	SurnamePrefix NamePieceSurnamePrefix
	Surname       NamePieceSurname
	Suffix        NamePieceSuffix
	Sources       []SourceCitation
	Notes         []NoteStructure
}

PersonalNameStructure is a GEDCOM structure type.

type PhoneNumber

type PhoneNumber string

PhoneNumber is a GEDCOM base type.

type PhysicalDescription

type PhysicalDescription string

PhysicalDescription is a GEDCOM base type.

type PlaceHierarchy

type PlaceHierarchy string

PlaceHierarchy is a GEDCOM base type.

type PlaceLivingOrdinance

type PlaceLivingOrdinance string

PlaceLivingOrdinance is a GEDCOM base type.

type PlaceStructure

type PlaceStructure struct {
	Place          PlaceValue
	PlaceHierarchy PlaceHierarchy
	Sources        []SourceCitation
	Notes          []NoteStructure
}

PlaceStructure is a GEDCOM structure type.

type PlaceValue

type PlaceValue string

PlaceValue is a GEDCOM base type.

type PossessionEvent

type PossessionEvent struct {
	Possessions Possessions
	EventDetail
}

PossessionEvent is a GEDCOM structure type.

type Possessions

type Possessions string

Possessions is a GEDCOM base type.

type PublicationDate

type PublicationDate string

PublicationDate is a GEDCOM base type.

type Reader

type Reader struct {
}

Reader reads Records from the underlying GEDCOM file.

func NewReader

func NewReader(r io.Reader, opts ...Option) *Reader

NewReader creates a new Reader, setting the given options.

func (*Reader) Record

func (r *Reader) Record() (Record, error)

Record returns a GEDCOM Record. Record types are: -

*Header
*Submission
*Family
*Invididual
*MultimediaNote
*Repository
*Source
*Submitter
*Trailer

type ReceivingSystemName

type ReceivingSystemName string

ReceivingSystemName is a GEDCOM base type.

type Record

type Record interface {
	Type() RecordID
	// contains filtered or unexported methods
}

Record is the interface to contain all of the record types.

type RecordID

type RecordID uint

RecordID stores the type of record.

const (
	RecordHeader RecordID = iota
	RecordSubmission
	RecordFamily
	RecordIndividual
	RecordMultimedia
	RecordNote
	RecordRepository
	RecordSource
	RecordSubmitter
	RecordTrailer
	RecordUnknown
	RecordMultimediaLinkID
	RecordMultimediaLinkFile
	RecordNoteID
	RecordNoteText
	RecordSourceID
	RecordSourceText
)

RecordIDs.

type RecordIdentifier

type RecordIdentifier string

RecordIdentifier is a GEDCOM base type.

type RecordType

type RecordType string

RecordType is a GEDCOM base type.

type RegisteredResourceIdentifier

type RegisteredResourceIdentifier string

RegisteredResourceIdentifier is a GEDCOM base type.

type RelationIsDescriptor

type RelationIsDescriptor string

RelationIsDescriptor is a GEDCOM base type.

type ReligiousAffiliation

type ReligiousAffiliation string

ReligiousAffiliation is a GEDCOM base type.

type ReligiousEvent

type ReligiousEvent struct {
	ReligiousAffiliation ReligiousAffiliation
	EventDetail
}

ReligiousEvent is a GEDCOM structure type.

type RepositoryRecord

type RepositoryRecord struct {
	ID                Xref
	NameOfRepository  NameOfRepository
	Address           AddressStructure
	PhoneNumber       []PhoneNumber
	Notes             []NoteStructure
	UserReferences    []UserReferenceStructure
	AutomatedRecordID AutomatedRecordID
	ChangeDate        ChangeDateStructure
}

RepositoryRecord is a GEDCOM structure type.

func (RepositoryRecord) Type

func (RepositoryRecord) Type() RecordID

Type implements the Record interface.

type ResidenceEvent

type ResidenceEvent struct {
	EventDetail
}

ResidenceEvent is a GEDCOM structure type.

type ResponsibleAgency

type ResponsibleAgency string

ResponsibleAgency is a GEDCOM base type.

type RestrictionNotice

type RestrictionNotice string

RestrictionNotice is a GEDCOM base type.

type RoleDescriptor

type RoleDescriptor string

RoleDescriptor is a GEDCOM base type.

type RoleInEvent

type RoleInEvent string

RoleInEvent is a GEDCOM base type.

type SSNEvent

type SSNEvent struct {
	SocialSecurityNumber SocialSecurityNumber
	EventDetail
}

SSNEvent is a GEDCOM structure type.

type ScholasticAchievement

type ScholasticAchievement string

ScholasticAchievement is a GEDCOM base type.

type ScholasticEvent

type ScholasticEvent struct {
	ScholasticAchievement ScholasticAchievement
	EventDetail
}

ScholasticEvent is a GEDCOM structure type.

type SexValue

type SexValue string

SexValue is a GEDCOM base type.

type SocialSecurityNumber

type SocialSecurityNumber string

SocialSecurityNumber is a GEDCOM base type.

type SourceCallNumber

type SourceCallNumber string

SourceCallNumber is a GEDCOM base type.

type SourceCallStructure

type SourceCallStructure struct {
	SourceCallNumber SourceCallNumber
	Type             SourceMediaType
}

SourceCallStructure is a GEDCOM structure type.

type SourceCitation

type SourceCitation struct {
	Data Record
}

SourceCitation splits between SourceID and SourceText

type SourceCitationEvent

type SourceCitationEvent struct {
	EventTypeCitedFrom EventTypeCitedFrom
	Role               RoleInEvent
}

SourceCitationEvent is a GEDCOM structure type.

type SourceData

type SourceData struct {
	Date EntryRecordingDate
	Text []TextFromSource
}

SourceData is a GEDCOM structure type.

type SourceDescription

type SourceDescription string

SourceDescription is a GEDCOM base type.

type SourceDescriptiveTitle

type SourceDescriptiveTitle string

SourceDescriptiveTitle is a GEDCOM base type.

type SourceFiledByEntry

type SourceFiledByEntry string

SourceFiledByEntry is a GEDCOM base type.

type SourceID

type SourceID struct {
	ID                  Xref
	WhereWithinSource   WhereWithinSource
	SourceCitationEvent SourceCitationEvent
	Data                SourceData
	Certainty           CertaintyAssessment
	Multimedia          []MultimediaLink
	Notes               []NoteStructure
}

SourceID is a GEDCOM structure type.

func (SourceID) Type

func (SourceID) Type() RecordID

Type implements the Record interface.

type SourceJurisdictionPlace

type SourceJurisdictionPlace string

SourceJurisdictionPlace is a GEDCOM base type.

type SourceMediaType

type SourceMediaType string

SourceMediaType is a GEDCOM base type.

type SourceOriginator

type SourceOriginator string

SourceOriginator is a GEDCOM base type.

type SourcePublicationFacts

type SourcePublicationFacts string

SourcePublicationFacts is a GEDCOM base type.

type SourceRecord

type SourceRecord struct {
	ID                       Xref
	Data                     SourceRecordDataStructure
	Originator               SourceOriginator
	Title                    SourceDescriptiveTitle
	FiledBy                  SourceFiledByEntry
	PublicationFacts         SourcePublicationFacts
	TextFromSource           TextFromSource
	SourceRepositoryCitation SourceRepositoryCitation
	ContinuedObject          Xref
	Notes                    []NoteStructure
	UserReferences           []UserReferenceStructure
	AutomatedRecordID        AutomatedRecordID
	ChangeDate               ChangeDateStructure
}

SourceRecord is a GEDCOM structure type.

func (SourceRecord) Type

func (SourceRecord) Type() RecordID

Type implements the Record interface.

type SourceRecordDataStructure

type SourceRecordDataStructure struct {
	EventsRecorded    []EventsRecordedStructure
	ResponsibleAgency ResponsibleAgency
	Notes             []NoteStructure
}

SourceRecordDataStructure is a GEDCOM structure type.

type SourceRepositoryCitation

type SourceRepositoryCitation struct {
	ID      Xref
	Numbers []SourceCallStructure
}

SourceRepositoryCitation is a GEDCOM structure type.

type SourceText

type SourceText struct {
	Description SourceDescription
	Texts       []TextFromSource
	Notes       []NoteStructure
}

SourceText is a GEDCOM structure type.

func (SourceText) Type

func (SourceText) Type() RecordID

Type implements the Record interface.

type SpouseToFamilyLink

type SpouseToFamilyLink struct {
	ID    Xref
	Notes []NoteStructure
}

SpouseToFamilyLink is a GEDCOM structure type.

type SubmissionRecord

type SubmissionRecord struct {
	ID                       Xref
	NameOfFamilyFile         NameOfFamilyFile
	TempleCode               TempleCode
	GenerationsOfAncestors   GenerationsOfAncestors
	GenerationsOfDescendants GenerationsOfDescendants
	OrdinanceProcessFlag     OrdinanceProcessFlag
	AutomatedRecordID        AutomatedRecordID
}

SubmissionRecord is a GEDCOM structure type.

func (SubmissionRecord) Type

func (SubmissionRecord) Type() RecordID

Type implements the Record interface.

type SubmitterName

type SubmitterName string

SubmitterName is a GEDCOM base type.

type SubmitterRecord

type SubmitterRecord struct {
	ID                     Xref
	SubmitterName          SubmitterName
	Address                AddressStructure
	PhoneNumber            []PhoneNumber
	Multimedia             []MultimediaLink
	LanguagePreference     []LanguagePreference
	SubmitterRegisteredRFN SubmitterRegisteredRFN
	AutomatedRecordID      AutomatedRecordID
	ChangeDate             ChangeDateStructure
}

SubmitterRecord is a GEDCOM structure type.

func (SubmitterRecord) Type

func (SubmitterRecord) Type() RecordID

Type implements the Record interface.

type SubmitterRegisteredRFN

type SubmitterRegisteredRFN string

SubmitterRegisteredRFN is a GEDCOM base type.

type SubmitterText

type SubmitterText string

SubmitterText is a GEDCOM base type.

type TempleCode

type TempleCode string

TempleCode is a GEDCOM base type.

type Text

type Text string

Text is a GEDCOM base type.

type TextFromSource

type TextFromSource string

TextFromSource is a GEDCOM base type.

type TimeValue

type TimeValue string

TimeValue is a GEDCOM base type.

type Trailer

type Trailer struct{}

Trailer type

func (Trailer) Type

func (Trailer) Type() RecordID

Type implements the Record interface.

type TransmissionDate

type TransmissionDate string

TransmissionDate is a GEDCOM base type.

type TransmissionDateTime

type TransmissionDateTime struct {
	TransmissionDate TransmissionDate
	Time             TimeValue
}

TransmissionDateTime is a GEDCOM structure type.

type UserReferenceNumber

type UserReferenceNumber string

UserReferenceNumber is a GEDCOM base type.

type UserReferenceStructure

type UserReferenceStructure struct {
	UserReferenceNumber UserReferenceNumber
	Type                UserReferenceType
}

UserReferenceStructure is a GEDCOM structure type.

type UserReferenceType

type UserReferenceType string

UserReferenceType is a GEDCOM base type.

type Verified

type Verified string

Verified is a GEDCOM base type.

type VerifiedEventDetail

type VerifiedEventDetail struct {
	Verified Verified
	EventDetail
}

VerifiedEventDetail is a GEDCOM structure type.

type VerifiedFamilyEventDetail

type VerifiedFamilyEventDetail struct {
	Verified Verified
	FamilyEventDetail
}

VerifiedFamilyEventDetail is a GEDCOM structure type.

type VerifiedIndividualFamEventDetail

type VerifiedIndividualFamEventDetail struct {
	Famc Xref
	VerifiedEventDetail
}

VerifiedIndividualFamEventDetail is a GEDCOM structure type.

type Version

type Version struct {
	VersionNumber VersionNumber
	Form          Form
}

Version is a GEDCOM structure type.

type VersionNumber

type VersionNumber string

VersionNumber is a GEDCOM base type.

type WhereWithinSource

type WhereWithinSource string

WhereWithinSource is a GEDCOM base type.

type Xref

type Xref string

Xref is a GEDCOM base type.

type Year

type Year string

Year is a GEDCOM base type.

type YearGreg

type YearGreg string

YearGreg is a GEDCOM base type.

gedcom's People

Contributors

mjkwoolnough avatar

Stargazers

Adam Hunt avatar Wilk avatar

Watchers

James Cloos avatar  avatar  avatar

Forkers

voxadam

gedcom's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.