lib/Bio/DB/SeqFeature/NormalizedTableFeatureI.pm

   1 package Bio::DB::SeqFeature::NormalizedTableFeatureI;
   2
   3
   4 =head1 NAME
   5
   6 Bio::DB::SeqFeature::NormalizedTableFeatureI -- Interface for normalized features whose hierarchy is stored in a table
   7
   8 =head1 SYNOPSIS
   9
  10 none
  11
  12 =head1 DESCRIPTION
  13
  14 This is an extremely simple interface that contains a single method,
  15 subfeatures_are_stored_in_a_table(). This method returns a true value.
  16
  17 Bio::DB::SeqFeature::Store feature classes will inherit this interface
  18 to flag that in addition to being able to store features in a
  19 normalized way, they will use the Bio::DB::SeqFeature::Store database
  20 to record their parent/child relationships. A class that inherits from
  21 NormalizedTableFeatureI will also inherit from NormalizedFeatureI, as
  22 the first is a subclass of the second.
  23
  24 =head1 BUGS
  25
  26 None, but the whole class design might be flawed.
  27
  28 =head1 SEE ALSO
  29
  30 L<bioperl>,
  31 L<Bio::DB::SeqFeature>,
  32 L<Bio::DB::SeqFeature::Store>,
  33 L<Bio::DB::SeqFeature::Segment>,
  34 L<Bio::DB::SeqFeature::GFF3Loader>,
  35 L<Bio::DB::SeqFeature::Store::DBI::mysql>,
  36 L<Bio::DB::SeqFeature::Store::bdb>
  37
  38 =head1 AUTHOR
  39
  40 Lincoln Stein E<lt>lstein@cshl.orgE<gt>.
  41
  42 Copyright (c) 2006 Cold Spring Harbor Laboratory.
  43
  44 This library is free software; you can redistribute it and/or modify
  45 it under the same terms as Perl itself.
  46
  47 =cut
  48
  49 use base 'Bio::DB::SeqFeature::NormalizedFeatureI';
  50
  51 sub subfeatures_are_stored_in_a_table { 1 }
  52
  53 1;