lib/CXGN/Stock/StockLookup.pm

   1 package CXGN::Stock::StockLookup;
   2
   3 =head1 NAME
   4
   5 CXGN::Stock::StockLookup - a module to lookup stock names by unique name or synonym.
   6
   7 =head1 USAGE
   8
   9  my $stock_lookup = CXGN::Stock::StockLookup->new({ schema => $schema} );
  10
  11
  12 =head1 DESCRIPTION
  13
  14 Looks up stocks ("Stock::Stock") that have a match with the unique name or synonym to the searched name.  Provides a count of matching stocks when more than one stock is found.  Provides the Stock::Stock object when only a single stock matches.
  15
  16 =head1 AUTHORS
  17
  18  Jeremy D. Edwards (jde22@cornell.edu)
  19
  20 =cut
  21
  22 use Moose;
  23 use MooseX::FollowPBP;
  24 use Moose::Util::TypeConstraints;
  25 use Try::Tiny;
  26
  27 has 'schema' => (
  28                  is       => 'rw',
  29                  isa      => 'DBIx::Class::Schema',
  30                  lazy_build => 1,
  31                 );
  32
  33 =head2 predicate has_stock_name(), clearer clear_stock_name(), accessors stock_name()
  34
  35 functions to test, clear, set or get the stock name.
  36
  37 =cut
  38
  39 has 'stock_name' => (isa => 'Str', is => 'rw', predicate => 'has_stock_name', clearer => 'clear_stock_name');
  40
  41 =head2 function get_stock()
  42
  43 retrieves a stock row
  44
  45 =cut
  46
  47 sub get_stock {
  48   my $self = shift;
  49   my $stock_rs = $self->_get_stock_resultset();
  50   my $stock;
  51   if ($stock_rs->count == 1) {
  52     $stock = $stock_rs->first;
  53   } else {
  54     return;
  55   }
  56   return $stock;
  57 }
  58
  59 =head2 function get_stock_exact()
  60
  61 retrieves the stock row with an exact match to the stock name or synonym
  62
  63 =cut
  64
  65 sub get_stock_exact {
  66   my $self = shift;
  67   my $stock_rs = $self->_get_stock_resultset_exact();
  68   my $stock;
  69   if ($stock_rs->count == 1) {
  70     $stock = $stock_rs->first;
  71   } else {
  72     return;
  73   }
  74   return $stock;
  75 }
  76
  77 =head2 function get_matching_stock_count()
  78
  79 retrieves the number of stocks that match the name (or synonym)
  80
  81 =cut
  82
  83 sub get_matching_stock_count {
  84   my $self = shift;
  85   my $stock_name = $self->get_stock_name();
  86   my $stock_rs = $self->_get_stock_resultset();
  87   if (!$stock_rs) {
  88     return;
  89   }
  90   my $stock_match_count = $stock_rs->count;
  91   if (!$stock_match_count) {
  92     return 0;
  93   }
  94   if ($stock_match_count == 0) {
  95     return;
  96   }
  97   return $stock_match_count;
  98 }
  99
 100 sub _get_stock_resultset {
 101   my $self = shift;
 102   my $schema = $self->get_schema();
 103   my $stock_name = $self->get_stock_name();
 104   my $stock_rs = $schema->resultset("Stock::Stock")
 105       ->search({ 'me.is_obsolete' => { '!=' => 't' },
 106               -or => [
 107                       'lower(me.uniquename)' => { like => lc($stock_name) },
 108
 109                       -and => [
 110                                'lower(type.name)'       => { like => '%synonym%' },
 111                                'lower(stockprops.value)' => { like => lc($stock_name) },
 112                               ],
 113                      ],
 114              },
 115              {
 116               join => { 'stockprops' => 'type'} ,
 117               distinct => 1
 118              }
 119             );
 120   return $stock_rs;
 121 }
 122
 123 sub _get_stock_resultset_exact {
 124   my $self = shift;
 125   my $schema = $self->get_schema();
 126   my $stock_name = $self->get_stock_name();
 127   my $stock_rs = $schema->resultset("Stock::Stock")
 128     ->search({ 'me.is_obsolete' => { '!=' => 't' },
 129               'lower(uniquename)' => lc($stock_name),
 130              },
 131              {
 132               join => { 'stockprops' => 'type'} ,
 133               distinct => 1,
 134              }
 135             );
 136   return $stock_rs;
 137 }
 138
 139 #######
 140 1;
 141 #######