Class: Header_record

Inherits:
GEDCOMBase show all
Defined in:
lib/gedcom/header_record.rb

Overview

Internal representation of the GEDCOM level 0 HEAD record type

=HEADER:= n HEAD 1:1 +1 SOUR <APPROVED_SYSTEM_ID> 1:1 +2 VERS <VERSION_NUMBER> 0:1 +2 NAME <NAME_OF_PRODUCT> 0:1 +2 CORP <NAME_OF_BUSINESS> 0:1 +3 <<ADDRESS_STRUCTURE>> 0:1 +2 DATA <NAME_OF_SOURCE_DATA> 0:1 +3 DATE <PUBLICATION_DATE> 0:1 +3 COPR <COPYRIGHT_SOURCE_DATA> 0:1 +1 DEST <RECEIVING_SYSTEM_NAME> 0:1 (See NOTE below) +1 DATE <TRANSMISSION_DATE> 0:1 +2 TIME <TIME_VALUE> 0:1 +1 SUBM @XREF:SUBM@ 1:1 +1 SUBN @XREF:SUBN@ 0:1 +1 FILE <FILE_NAME> 0:1 +1 COPR <COPYRIGHT_GEDCOM_FILE> 0:1 +1 GEDC 1:1 +2 VERS <VERSION_NUMBER> 1:1 +2 FORM <GEDCOM_FORM> 1:1 +1 CHAR <CHARACTER_SET> 1:1 +2 VERS <VERSION_NUMBER> 0:1 +1 LANG <LANGUAGE_OF_TEXT> 0:1 +1 PLAC 0:1 +2 FORM <PLACE_HIERARCHY> 1:1 +1 NOTE <GEDCOM_CONTENT_DESCRIPTION> 0:1 +2 [CONT|CONC] <GEDCOM_CONTENT_DESCRIPTION> 0:M NOTE:: Submissions to the Family History Department for Ancestral File submission or for clearing temple ordinances must use a DESTination of ANSTFILE or TempleReady.

The header structure provides information about the entire transmission. The SOURce system name identifies which system sent the data. The DESTination system name identifies the intended receiving system.

Additional GEDCOM standards will be produced in the future to reflect GEDCOM expansion and maturity. This requires the reading program to make sure it can read the GEDC.VERS and the GEDC.FORM values to insure proper readability. The CHAR tag is required. All character codes greater than 0x7F must be converted to ANSEL.

The attributes are all arrays for the level +1 tags/records. * Those ending in ref are GEDCOM XREF index keys * Those ending in record are array of classes of that type. * The remainder are arrays of attributes that could be present in this record.

Instance Attribute Summary collapse

Attributes inherited from GEDCOMBase

#restriction

Instance Method Summary collapse

Methods inherited from GEDCOMBase

#changed, #changed?, #created?, #find, #locked?, no_tabs, #private?, #save, tabs, #to_db, #to_gedcom, #to_s, #to_s_ordered, #to_s_r, #token_to_s, #xref_check

Constructor Details

#initialize(*a) ⇒ Header_record

new sets up the state engine arrays @this_level and @sub_level, which drive the to_gedcom method generating GEDCOM output.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/gedcom/header_record.rb', line 57

def initialize(*a)
  super(*a)
  @this_level = [ [:nodata, "HEAD", nil] ]
  @sub_level =  [ #level + 1
                  [:walk, nil,:header_source_record],
                  [:print, "DEST", :destination],
                  [:walk, nil, :date_record], 
                  [:xref, "SUBM", :submitter_ref], 
                  [:xref, "SUBN", :submission_ref],
                  [:print, "FILE", :file_name], 
                  [:print, "COPR", :copyright], 
                  [:walk, nil, :gedcom_record],  
                  [:walk, nil, :character_set_record], 
                  [:print, "LANG", :language_id], 
                  [:walk, nil, :place_record], 
                  [:walk, nil, :note_citation_record],
                ]
end

Instance Attribute Details

#character_set_record ⇒ Object

Returns the value of attribute character_set_record.



51
52
53
 
# File 'lib/gedcom/header_record.rb', line 51

def character_set_record
  @character_set_record
end

#copyright ⇒ Object

Returns the value of attribute copyright.



51
52
53
 
# File 'lib/gedcom/header_record.rb', line 51

def copyright
  @copyright
end

#date_record ⇒ Object

Returns the value of attribute date_record.



50
51
52
 
# File 'lib/gedcom/header_record.rb', line 50

def date_record
  @date_record
end

#destination ⇒ Object

Returns the value of attribute destination.



50
51
52
 
# File 'lib/gedcom/header_record.rb', line 50

def destination
  @destination
end

#file_name ⇒ Object

Returns the value of attribute file_name.



51
52
53
 
# File 'lib/gedcom/header_record.rb', line 51

def file_name
  @file_name
end

#gedcom_record ⇒ Object

Returns the value of attribute gedcom_record.



51
52
53
 
# File 'lib/gedcom/header_record.rb', line 51

def gedcom_record
  @gedcom_record
end

#header_source_record ⇒ Object

Returns the value of attribute header_source_record.



50
51
52
 
# File 'lib/gedcom/header_record.rb', line 50

def header_source_record
  @header_source_record
end

#language_id ⇒ Object

Returns the value of attribute language_id.



51
52
53
 
# File 'lib/gedcom/header_record.rb', line 51

def language_id
  @language_id
end

#note_citation_record ⇒ Object

Returns the value of attribute note_citation_record.



52
53
54
 
# File 'lib/gedcom/header_record.rb', line 52

def note_citation_record
  @note_citation_record
end

#place_record ⇒ Object

Returns the value of attribute place_record.



52
53
54
 
# File 'lib/gedcom/header_record.rb', line 52

def place_record
  @place_record
end

#submission_ref ⇒ Object

Returns the value of attribute submission_ref.



50
51
52
 
# File 'lib/gedcom/header_record.rb', line 50

def submission_ref
  @submission_ref
end

#submitter_ref ⇒ Object

Returns the value of attribute submitter_ref.



50
51
52
 
# File 'lib/gedcom/header_record.rb', line 50

def submitter_ref
  @submitter_ref
end