lib/CXGN/MapFactory/CviewAndCmap.pm

   1
   2
   3 =head1 NAME
   4
   5 CXGN::Cview::MapFactory::CviewAndCmap - a class to access maps in both cview and cmap databases.
   6
   7 =head1 DESCRIPTION
   8
   9 For the interface to be implemented, see L<CXGN::Cview::MapFactory>, and for an example, see L<CXGN::Cview::MapFactory::SGN>.
  10
  11 =head1 AUTHOR
  12
  13 Lukas Mueller <lam87@cornell.edu>
  14
  15 =cut
  16
  17 use strict;
  18
  19 package CXGN::Cview::MapFactory::CviewAndCmap;
  20
  21 use base qw| CXGN::DB::Object |;
  22
  23 use CXGN::Cview::Map::SGN::Genetic;
  24 use CXGN::Cview::Map::SGN::User;
  25 use CXGN::Cview::Map::SGN::Fish;
  26 use CXGN::Cview::Map::SGN::Sequence;
  27 use CXGN::Cview::Map::SGN::IL;
  28 use CXGN::Cview::Map::SGN::Physical;
  29 use CXGN::Cview::Map::SGN::ProjectStats;
  30 use CXGN::Cview::Map::SGN::AGP;
  31 use CXGN::Cview::Map::SGN::Contig;
  32 use CXGN::Cview::Map::GMOD::Cmap;
  33
  34 =head2 function new()
  35
  36   Synopsis:     constructor
  37   Arguments:    none
  38   Returns:      a CXGN::Cview::MapFactory object
  39   Side effects: none
  40   Description:  none
  41
  42 =cut
  43
  44 sub new {
  45     my $class = shift;
  46     my $dbh = shift;
  47
  48     my $self = $class->SUPER::new($dbh);
  49
  50     $self->{cview} = CXGN::Cview::MapFactory::SGN->new($dbh);
  51
  52
  53     $self->{cmap} = CXGN::Cview::MapFactory::Cmap->new($dbh);
  54
  55
  56     return $self;
  57 }
  58
  59 =head2 function create()
  60
  61   Description:  creates a map based on the hashref given, which
  62                 should either contain the key map_id or map_version_id
  63                 and an appropriate identifier. The function returns undef
  64                 if a map of the given id cannot be found/created.
  65   Example:
  66
  67 =cut
  68
  69 sub create {
  70     my $self = shift;
  71     my $args = shift;
  72
  73     my $id = 0;
  74     if (exists($args->{map_version_id})) {
  75         $id=$args->{map_version_id};
  76
  77     }
  78     elsif (exists($args->{map_id})) {
  79         $id=$args->{map_id};
  80     }
  81     else {
  82         die "Need a map_id or map_version_id key in hashref\n";
  83     }
  84
  85     my $map;
  86
  87     if ($id =~ /cmap/) {
  88         $map = $self->{cmap}->create($args);
  89     }
  90     else {
  91         $map = $self->{cview}->create($args);
  92     }
  93
  94     return $map;
  95
  96
  97
  98 }
  99
 100 =head2 function get_all_maps()
 101
 102   Synopsis:     my @maps = $map_factory->get_all_maps();
 103   Arguments:    none
 104   Returns:      a list of all maps currently defined, as
 105                 CXGN::Cview::Map objects (and subclasses)
 106   Side effects: Queries the database for certain maps
 107   Description:
 108
 109 =cut
 110
 111 sub get_all_maps {
 112     my $self = shift;
 113
 114     my @maps = ();
 115
 116     @maps = ($self->{cview}->get_all_maps(), $self->{cmap}->get_all_maps());
 117
 118     return @maps;
 119 }
 120
 121 sub get_system_maps {
 122     my $self = shift;
 123     return $self->get_all_maps();
 124 }
 125
 126 sub get_user_maps {
 127     my $self = shift;
 128     my @maps = ();
 129     @maps = $self->{cview}->get_user_maps();
 130     return @maps;
 131 }
 132
 133 return 1;