class Citation - jcobban/Genealogy GitHub Wiki

Up: Object-Oriented Access to Database Records

This class is derived from class Record to implement the logical interface to a record in the Citation table (Citations or tblSX). Each entry in this table contains a description of citation to a master Source document.

Source Code

Fields

This record presents the following fields:

field name description synonyms
'idsx' unique numeric identifier of this Citation
'idsr' unique numeric identifier of instance of Source
'idime' unique numeric identifier of instance of Record describing the fact or event documented by this Citation 'idir', 'idmr', 'ider', 'idcr', 'idnx'
'type' type. See the STYPE constants below.
'srcdetail' citation reference, for example page number text 'detail'
'srcprintdetail' if 1 print srcdetail 'printdetail'
'srcdettext' text from the original document 'dettext'
'srcprinttext' if 1 print srcdettext 'printtext'
'srcdetnote' comments about the citation 'detnote'
'srcprintnote' if 1 print srcdetnote 'printnote'
'srcprint' if 1 include this citation in reports 'print'
'srcsurety' confidence level, see the SURETY constants 'surety'
'enteredsd' entered date yyyymmdd
'enteredd' entered date internal representation
'filingref' user filing reference
'order' sort order
'used' 1 if used
'verified' 1 if verified
'content' content text
'srcname' name from master Source
'srctitle' title from master Source
'idst' source type from master Source
'srcauthor' author from master Source
'srcpubl' publisher from master Source
'srctext' text from master Source
'psrctext' print text? from master Source
'fsrctext' footnote text? from master Source
'srcnote' notes from master Source
'psrcnote' print notes? from master Source
'fsrcnote' footnote notes from master Source
'srccallnum' call number in repository from master Source
'srctag' tagged? from master Source
'srcexclude' exclude from reports from master Source
'idar' numeric identifier of repository from master Source
'idar2' numeric identifier of additional repository from master Source

Constants

This class defines the following constants which indicate the type of fact or event that the Citation documents:

Constant Name Description Value Class
Citation::STYPE_UNSPECIFIED unspecified 0 Person
Citation::STYPE_NAME name 1 Person
Citation::STYPE_BIRTH birth 2 Person
Citation::STYPE_CHRISTEN christen 3 Person
Citation::STYPE_DEATH death 4 Person
Citation::STYPE_BURIED buried 5 Person
Citation::STYPE_NOTESGENERAL general notes 6 Person
Citation::STYPE_NOTESRESEARCH research notes 7 Person
Citation::STYPE_NOTESMEDICAL medical notes 8 Person
Citation::STYPE_DEATHCAUSE Cause of Death 9 Person
Citation::STYPE_LDSB Baptism 15 Person
Citation::STYPE_LDSE Endowment 16 Person
Citation::STYPE_LDSC Confirmation 26 Person
Citation::STYPE_LDSI Initiatory 27 Person
Citation::STYPE_ALTNAME alternate name 10 Name
Citation::STYPE_CHILDSTATUS Child Status 11 Child
Citation::STYPE_CPRELDAD Relationship to Father 12 Child
Citation::STYPE_CPRELMOM Relationship to Mother 13 Child
Citation::STYPE_LDSP Sealed to Parents 17 Child
Citation::STYPE_LDSS Sealed to Spouse 18 Family
Citation::STYPE_NEVERMARRIED This individual never married 19 Family
Citation::STYPE_MAR Marriage 20 Family
Citation::STYPE_MARNOTE Marriage Note 21 Family
Citation::STYPE_MARNEVER Never Married 22 Family
Citation::STYPE_MARNOKIDS This couple had no children 23 Family
Citation::STYPE_MAREND Marriage ended 24 Family
Citation::STYPE_EVENT Event on a Person 30 Event
Citation::STYPE_MAREVENT Event on a Family relationship 31 Event
Citation::STYPE_CHILDEVENT Event on the relationship between a Child and parents 32 Event
Citation::STYPE_TODO To-Do 40 ToDo
Confidence levels
Citation::SURETY_CONVINCING Convincing Evidence 4
Citation::SURETY_ALMOSTCERTAIN Almost Certain Conclusion 3
Citation::SURETY_PROBABLE Probable Conclusion 2
Citation::SURETY_MARGINAL Marginal Evidence 1
Citation::SURETY_UNDECIDED Have not decided yet 0

Table of Contents

Next: new Citation($parms)