view release on metacpan or  search on metacpan

lib/Finance/Bank/SentinelBenefits/Csv401kConverter/SymbolMap.pm  view on Meta::CPAN

package Finance::Bank::SentinelBenefits::Csv401kConverter::SymbolMap;
$Finance::Bank::SentinelBenefits::Csv401kConverter::SymbolMap::VERSION = '1.3';
use Modern::Perl;

=head1 NAME



Finance::Bank::SentinelBenefits::Csv401kConverter::SymbolMap - fuzzy lookup 
of security descriptions to symbols



=head1 VERSION

version 1.3

=head1 SYNOPSIS



This class is necessary because Sentinel does not always supply the symbol
in the download, so it can become necessary to do a lookup based on the 
description field that they supply to find the correct security symbol.



=cut 

use Moose;
use Scalar::Util qw{ openhandle };

=head1 Constructor



=head2 new()



    my $st = Bank::SentinelBenefits::Csv401kConverter::SymbolMap->new({
        symbol_map => $HashRef[Str] | FileHandle });

Can be initialzed either from a hash mapping of the form description -> symbol
or a comma delimited file of the same type.



=cut 

=head1 Internal accessors



=head2 $foo->symbol_map()



This is either a hash ref of strings, mapping descriptions to symbols,
 or a filehandle pointing to a file of the format C<'description','symbol>