File Coverage

blib/lib/Finnigan/GenericRecord.pm

Criterion	Covered	Total	%
statement	15	15	100.0
branch			n/a
condition			n/a
subroutine	5	5	100.0
pod	1	1	100.0
total	21	21	100.0

package Finnigan::GenericRecord;

use strict;
use warnings FATAL => qw( all );
our $VERSION = 0.0206;

use Finnigan;
use base 'Finnigan::Decoder';

sub decode {
  my ($class, $stream, $field_templates) = @_;

  # This is a sleazy way of decoding this structure. The result will
  # be a hash whose keys start with the ordinal numbers of elements;
  # this answers the need to preserve order and to introduce gaps and
  # section titles commanded by the GenericDataHeader but not present
  # in the actual record. The field_templates() method of
  # GenericDataHeader modifies all keys by adding ordinals to them.

  # To decode a combination of specific and generic content, simply
  # create a copy of this object and in it, combine
  # $header->field_templates with specific fields and call
  # Decoder->read. Just make sure the specific fields' keys start with
  # a number and have the form 'x|key', and that number is unique in
  # each field (does not co-incide with the range of numbers in the
  # header (which is 1 .. n).
  my $self = Finnigan::Decoder->read($stream, $field_templates);
  return bless $self, $class;
}

1;
__END__