lib/Bio/DB/GFF/Aggregator/ucsc_ensgene.pm

   1 =head1 NAME
   2
   3 Bio::DB::GFF::Aggregator::ucsc_ensgene -- UCSC ensGene aggregator
   4
   5 =head1 SYNOPSIS
   6
   7   use Bio::DB::GFF;
   8
   9   # Open the sequence database
  10   my $db      = Bio::DB::GFF->new( -adaptor => 'dbi:mysql',
  11                                    -dsn     => 'dbi:mysql:elegans42',
  12                                    -aggregator => ['transcript','clone'],
  13                                  );
  14
  15  -------------------------------------------------
  16  Aggregator method: ensgene
  17  Main method:       transcript
  18  Sub methods:       ensGene
  19  -------------------------------------------------
  20
  21 =head1 DESCRIPTION
  22
  23 L<Bio::DB::GFF::Aggregator::transcript>
  24
  25 =cut
  26
  27 package Bio::DB::GFF::Aggregator::ucsc_ensgene;
  28
  29 use strict;
  30
  31 use base qw(Bio::DB::GFF::Aggregator);
  32
  33
  34 =head2 method
  35
  36  Title   : method
  37  Usage   : $aggregator->method
  38  Function: return the method for the composite object
  39  Returns : the string "ensgene"
  40  Args    : none
  41  Status  : Public
  42
  43 =cut
  44
  45 sub method { 'ensgene' }
  46
  47 =head2 part_names
  48
  49  Title   : part_names
  50  Usage   : $aggregator->part_names
  51  Function: return the methods for the sub-parts
  52  Returns : empty list
  53  Args    : none
  54  Status  : Public
  55
  56 =cut
  57
  58 sub part_names {
  59   return ();
  60 }
  61
  62 =head2 main_name
  63
  64  Title   : main_name
  65  Usage   : $aggregator->main_name
  66  Function: return the method for the main component
  67  Returns : the string "transcript:ensGene"
  68  Args    : none
  69  Status  : Public
  70
  71 =cut
  72
  73 sub main_name {
  74   return 'transcript:ensGene';
  75 }
  76
  77 1;
  78 __END__
  79
  80 =head1 BUGS
  81
  82 None reported.
  83
  84
  85 =head1 SEE ALSO
  86
  87 L<Bio::DB::GFF>, L<Bio::DB::GFF::Aggregator>
  88
  89 =head1 AUTHOR
  90
  91 Allen Day E<lt>allenday@ucla.eduE<gt>.
  92
  93 Copyright (c) 2002 Allen Day, University of California, Los Angeles.
  94
  95 This library is free software; you can redistribute it and/or modify
  96 it under the same terms as Perl itself.
  97
  98 =cut
  99