1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
require_relative "error"
require_relative "field_array"
# Methods for accessing the GFA header information.
#
# The GFA header is accessed using {#header RGFA#header},
# which returns a {RGFA::Line::Header} object.
#
# @example Accessing the header information
# rgfa.header.VN # => “1.0”
# rgfa.header.co = “This the header comment”
# rgfa.header.ni = 100
# rgfa.header.field_to_s(:ni) # => “ni:i:100”
#
# == Multiple header lines defining the same tag
#
# The specification does not explicitely forbid to have the same tag on
# different lines. To represent this case, a "field array"
# ({RGFA::FieldArray RGFA::FieldArray}) is used, which is an array of
# instances of a tag, from different lines of the header.
#
# @example Header with tags repeated on different lines (see {RGFA::FieldArray})
# rgfa.header.ni # => RGFA::FieldArray<[100,200] @datatype: :i>
# rgfa.header.ni[0] # 100
# rgfa.header.ni << 200 # “200” is also OK
# rgfa.header.ni.map!{|i|i-10}
# rgfa.header.ni = [100,200,300].to_rgfa_field_array
#
# @example Adding instances of a tag (will go on different header lines)
# rgfa.header.add(:xx, 100) # => 100 # single i tag, if .xx did not exist yet
# rgfa.header.add(:xx, 100) # => RGFA::FieldArray<[100,100] @datatype: :i>
# rgfa.header.add(:xx, 100) # => RGFA::FieldArray<[100,100,100] @datatype :i>
#
module RGFA::Headers
# @return [RGFA::Line::Header] an header line representing the entire header
# information; if multiple header line were present, and they contain the
# same tag, the tag value is represented by a {RGFA::FieldArray}
def header
@headers
end
# Header information in single-tag-lines.
#
# Returns an array of RGFA::Line::Header
# objects, each containing a single field of the header.
# @!macro readonly
# @note Read-only! The returned array containes copies of the original
# values, i.e.\ changes in the lines will not affect the RGFA object; to
# update the values in the RGFA use the #header method.
# @return [Array<RGFA::Line::Header>]
# @api private
def headers
@headers.split
end
# Remove all information from the header.
# @return [RGFA] self
# @api private
def delete_headers
init_headers
return self
end
protected
# Add a GFA line to the header. This is useful for constructing the graph.
# For adding values to the header, see #header.
# @param gfa_line [String, RGFA::Line::Header] a string representing a valid
# header line, or a RGFA header line object
def add_header(gfa_line)
gfa_line = gfa_line.to_rgfa_line(validate: @validate)
@headers.merge(gfa_line)
end
end
|
