Class: Multimedia_record

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

Overview

Internal representation of the GEDCOM OBJE record type GEDCOM has both inline OBJE records and references to level 0 OBJE records. both are stored here and referenced through a Multimedia_citation_record class. =GEDCOM 5.5 =MULTIMEDIA_RECORD:= 0 @XREF:OBJE@ OBJE 0:M +1 FORM <MULTIMEDIA_FORMAT> 1:1 +1 TITL <DESCRIPTIVE_TITLE> 0:1 +1 <<NOTE_STRUCTURE>> 0:M +1 BLOB 1:1 +2 CONT <ENCODED_MULTIMEDIA_LINE> 1:M +1 OBJE @<XREF:OBJE>@ 0:1 (chain to continued object) +1 REFN <USER_REFERENCE_NUMBER> 0:M +2 TYPE <USER_REFERENCE_TYPE> 0:1 +1 RIN <AUTOMATED_RECORD_ID> 0:1 +1 <<CHANGE_DATE>> 0:1

Large whole multimedia objects embedded in a GEDCOM file would break some systems. For this purpose, large multimedia files should be divided into smaller multimedia records by using the subordinate OBJE tag to chain to the next <MULTIMEDIA_RECORD> fragment. This will allow GEDCOM records to be maintained below the 32K limit for use in systems with limited resources.

=MULTIMEDIA_LINK:= n OBJE <XREF> 1:1 is a reference to level 0 multimedia record. | n OBJE 1:1 is a reference to an external file, rather than inline blob. +1 FORM <MULTIMEDIA_FORMAT> 1:1 +1 TITL <DESCRIPTIVE_TITLE> 0:1 +1 FILE <MULTIMEDIA_FILE_REFERENCE> 1:1 +1 <<NOTE_STRUCTURE>> 0:M

This second method allows the GEDCOM context to be connected to an external multimedia file. GEDCOM defines this in the MULTIMEDIA_LINK definition, but I have put it into the Multimedia_record. as the attributes are the same, except BLOB becomes FILE. A Multimedia_citation_record is also created to make all references to Multimedia records consistent.

This process is only managed by GEDCOM in the sense that the appropriate file name is included in the GEDCOM file in context, but the maintenance and transfer of the multimedia files are external to GEDCOM. The parser can just treat this as a comment and doesn't check for the file being present.

=GEDCOM 5.5.1 =MULTIMEDIA_RECORD:= 0 @XREF:OBJE@ OBJE 0:M +1 FILE <MULTIMEDIA_FILE_REFN> 1:M New in 5.5.1 +2 FORM <MULTIMEDIA_FORMAT> 1:1 Was as level 1 in GEDCOM 5.5 +3 TYPE <SOURCE_MEDIA_TYPE> 0:1 New in 5.5.1 +2 TITL <DESCRIPTIVE_TITLE> 0:1 Was as level 1 in GEDCOM 5.5 +1 <<NOTE_STRUCTURE>> 0:M +1 <<SOURCE_CITATION>> 0:M New in 5.5.1 +1 REFN <USER_REFERENCE_NUMBER> 0:M +2 TYPE <USER_REFERENCE_TYPE> 0:1 +1 RIN <AUTOMATED_RECORD_ID> 0:1 +1 <<CHANGE_DATE>> 0:1

=MULTIMEDIA_LINK:= n OBJE <XREF> 1:1 is a reference to level 0 multimedia record. | n OBJE 1:1 is inline reference to an external file, rather than multimedia record. +1 FILE <MULTIMEDIA_FILE_REFN> 1:M Now 1:M in 5.5.1, was 1:1 in 5.5 +2 FORM <MULTIMEDIA_FORMAT> 1:1 Was as level 1 in GEDCOM 5.5 +3 TYPE <SOURCE_MEDIA_TYPE> 0:1 New in 5.5.1 +1 TITL <DESCRIPTIVE_TITLE> 0:1

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, #initialize, #locked?, no_tabs, #private?, #save, tabs, #to_db, #to_s, #to_s_ordered, #to_s_r, #token_to_s, #xref_check

Constructor Details

This class inherits a constructor from GEDCOMBase

Instance Attribute Details

#automated_record_id ⇒ Object

Returns the value of attribute automated_record_id.



72
73
74
 
# File 'lib/gedcom/multimedia_record.rb', line 72

def automated_record_id
  @automated_record_id
end

#change_date_record ⇒ Object

Returns the value of attribute change_date_record.



72
73
74
 
# File 'lib/gedcom/multimedia_record.rb', line 72

def change_date_record
  @change_date_record
end

#encoded_line_record ⇒ Object

Returns the value of attribute encoded_line_record.



71
72
73
 
# File 'lib/gedcom/multimedia_record.rb', line 71

def encoded_line_record
  @encoded_line_record
end

#multimedia_file_record ⇒ Object

GEDCOM 5.5.1, though some 5.5 variants need this too.



74
75
76
 
# File 'lib/gedcom/multimedia_record.rb', line 74

def multimedia_file_record
  @multimedia_file_record
end

#multimedia_format_record ⇒ Object

GEDCOM 5.5.1, though some 5.5 variants need this too.



74
75
76
 
# File 'lib/gedcom/multimedia_record.rb', line 74

def multimedia_format_record
  @multimedia_format_record
end

#multimedia_obje_file_record ⇒ Object

GEDCOM 5.5.1, though some 5.5 variants need this too.



73
74
75
 
# File 'lib/gedcom/multimedia_record.rb', line 73

def multimedia_obje_file_record
  @multimedia_obje_file_record
end

#multimedia_ref ⇒ Object

Returns the value of attribute multimedia_ref.



71
72
73
 
# File 'lib/gedcom/multimedia_record.rb', line 71

def multimedia_ref
  @multimedia_ref
end

#next_multimedia_ref ⇒ Object

Returns the value of attribute next_multimedia_ref.



71
72
73
 
# File 'lib/gedcom/multimedia_record.rb', line 71

def next_multimedia_ref
  @next_multimedia_ref
end

#note_citation_record ⇒ Object

Returns the value of attribute note_citation_record.



72
73
74
 
# File 'lib/gedcom/multimedia_record.rb', line 72

def note_citation_record
  @note_citation_record
end

#refn_record ⇒ Object

Returns the value of attribute refn_record.



72
73
74
 
# File 'lib/gedcom/multimedia_record.rb', line 72

def refn_record
  @refn_record
end

#source_citation_record ⇒ Object

Gedcom 5.5.1



75
76
77
 
# File 'lib/gedcom/multimedia_record.rb', line 75

def source_citation_record
  @source_citation_record
end

#title ⇒ Object

Returns the value of attribute title.



71
72
73
 
# File 'lib/gedcom/multimedia_record.rb', line 71

def title
  @title
end

Instance Method Details

#filename ⇒ Object

Replacing :filename with multimedia_file_record could break some code, so def filename returns the filename in the first multimedia_file_record's filename field.



106
107
108
109
110
 
# File 'lib/gedcom/multimedia_record.rb', line 106

def filename
  #ALL Tag values get stored in arrays, as there could be more than one instance of a Tag
  #Hence the 'first' is added.
    multimedia_obj_file_record != nil ? multimedia_obj_file_record.first.filename : nil
end

#format ⇒ Object

Replacing :format with multimedia_format_record could break some code, so def format returns the format in the first multimedia_format_record's format field.



114
115
116
117
118
 
# File 'lib/gedcom/multimedia_record.rb', line 114

def format
  #ALL Tag values get stored in arrays, as there could be more than one instance of a Tag
  #Hence the 'first' is added.
    multimedia_obj_format_record != nil ? multimedia_obj_format_record.first.format : nil
end

#to_gedcom(level = 0) ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/gedcom/multimedia_record.rb', line 79

def to_gedcom(level=0)
  
  if @multimedia_ref != nil 
    @this_level =  [ [:xref, "OBJE", :multimedia_ref]]
  else
    @this_level =  [ [:nodata, "OBJE", nil] ]
  end

  @sub_level =  [#level 1
                  [:walk, nil,    :multimedia_obje_file_record ], #"FILE", GEDCOM 5.5.1, FILE reference, rather than blobs.
                  [:walk, nil,    :multimedia_file_record ], #"FILE", GEDCOM 5.5.1, FILE reference, rather than blobs.
                  [:print, "TITL",:title ],                    #GEDCOM 5.5, Subordinate to FILE in 5.5.1
                  [:walk, nil,    :multimedia_format_record ], # "FORM", GEDCOM 5.5, Subordinate to FILE in 5.5.1
                  [:walk, nil,    :encoded_line_record ],       #GEDCOM 5.5 BLOB
                  [:xref, nil,    :next_multimedia_ref ],      #GEDCOM 5.5 OBJE, Next BLOB reference.
                  [:walk, nil,    :source_citation_record],      #GEDCOM 5.5.1
                  [:walk, nil,    :note_citation_record ],    
                  [:walk, nil,    :refn_record ],
                  [:print, "RIN", :automated_record_id ],
                  [:walk, nil,    :change_date_record ],
                ]
    
  super(level)
end