lib/CXGN/Cview/ChrLinkList.pm

   1
   2 =head1 NAME
   3
   4 CXGN::Cview::ChrLinkList - a class to handle a list of CXGN::Cview::ChrLink objects
   5
   6 =head1 AUTHOR
   7
   8 Lukas Mueller <lam87@cornell.edu>
   9
  10 =head1 FUNCTIONS
  11
  12 This class implements the following functions:
  13
  14 =cut
  15
  16 use strict;
  17
  18 package CXGN::Cview::ChrLinkList;
  19
  20 =head2 new
  21
  22  Usage:        my $link_list = CXGN::Cview::ChrLinkList->new();
  23  Desc:         generates a new link list object.
  24  Args:         none
  25  Side Effects: none
  26  Example:
  27
  28 =cut
  29
  30 sub new {
  31     my $class = shift;
  32     my $self = bless {}, $class;
  33     return $self;
  34 }
  35
  36 =head2 function add_link()
  37
  38  Usage:        $link_list->add_link($marker_name, $link_object)
  39  Desc:         adds another CXGN::Cview::ChrLink object to the list
  40  Ret:          nothing
  41  Args:         a marker name [string], a link list object
  42                [CXGN::Cview::ChrList]
  43  Side Effects: the link is added to the list...
  44  Example:
  45
  46 =cut
  47
  48 sub add_link {
  49     my $self = shift;
  50     my $marker_name = shift;
  51     my $link_object = shift;
  52     #print STDERR "adding link for marker $marker_name...\n";
  53     $self->{links}->{$marker_name} = $link_object;
  54
  55 }
  56
  57 =head2 function has_link()
  58
  59  Usage:        my $flag = $map_link->has_link($marker_name)
  60  Desc:         checks if the marker named $marker_name has
  61                a corresponding link object in the list
  62  Ret:          a boolean
  63  Args:         a marker name [string
  64  Side Effects: none
  65  Example:
  66
  67 =cut
  68
  69 sub has_link {
  70     my $self = shift;
  71     my $marker_name = shift;
  72     if (exists($self->{links}->{$marker_name})) {
  73         return 1;
  74     }
  75     return 0;
  76
  77 }
  78
  79 =head2 function get_link_list()
  80
  81  Usage:        my @link_list = $link_list->get_link_list()
  82
  83  Ret:          returns the list of link objects as a list
  84  Args:         none
  85  Side Effects: none
  86  Example:
  87
  88 =cut
  89
  90 sub get_link_list {
  91     my $self = shift;
  92 #    if (!exists($self->{links}) || !defined($self->{links})) {
  93 #       return ();
  94 #    }
  95     my @link_objects = ();
  96     foreach my $name (keys(%{$self->{links}})) {
  97         #print STDERR "Pushing $name...\n\n";
  98         push @link_objects, $self->{links}->{$name};
  99     }
 100
 101     return @link_objects;
 102 }
 103
 104
 105 return 1;