← Back to branch summary

~ubuntu-branches/ubuntu/lucid/bioperl/lucid

« back to all changes in this revision

Viewing changes to Bio/Search/Result/WABAResult.pm

  • Committer: Bazaar Package Importer
  • Author(s): Matt Hope
  • Date: 2004-04-18 14:24:11 UTC
  • mfrom: (1.2.1 upstream) (2.1.1 warty)
  • Revision ID: james.westby@ubuntu.com-20040418142411-gr92uexquw4w8liq
Tags: 1.4-1
* New upstream release
* Examples and working code are installed by default to usr/bin,
  this has been moved to usr/share/doc/bioperl/bin

Show diffs side-by-side

added added

removed removed

Lines of Context:
Bio/Search/Result/WABAResult.pm
 
1
# $Id: WABAResult.pm,v 1.2 2002/10/22 07:45:18 lapp Exp $
 
2
#
 
3
# BioPerl module for Bio::Search::Result::WABAResult
 
4
#
 
5
# Cared for by Jason Stajich <jason@bioperl.org>
 
6
#
 
7
# Copyright Jason Stajich
 
8
#
 
9
# You may distribute this module under the same terms as perl itself
 
10
 
 
11
# POD documentation - main docs before the code
 
12
 
 
13
=head1 NAME
 
14
 
 
15
Bio::Search::Result::WABAResult - Result object for WABA alignment output
 
16
 
 
17
=head1 SYNOPSIS
 
18
 
 
19
# use this object exactly as you would a GenericResult
 
20
# the only extra method is query_database which is the 
 
21
# name of the file where the query sequence came from
 
22
 
 
23
=head1 DESCRIPTION
 
24
 
 
25
This object is for WABA result output, there is little difference
 
26
between this object and a GenericResult save the addition of one
 
27
method query_database.  Expect many of the fields for GenericResult to
 
28
be empty however as WABA was not intended to provide a lot of extra
 
29
information other than the alignment.
 
30
 
 
31
=head1 FEEDBACK
 
32
 
 
33
=head2 Mailing Lists
 
34
 
 
35
User feedback is an integral part of the evolution of this and other
 
36
Bioperl modules. Send your comments and suggestions preferably to
 
37
the Bioperl mailing list.  Your participation is much appreciated.
 
38
 
 
39
  bioperl-l@bioperl.org              - General discussion
 
40
  http://bioperl.org/MailList.shtml  - About the mailing lists
 
41
 
 
42
=head2 Reporting Bugs
 
43
 
 
44
Report bugs to the Bioperl bug tracking system to help us keep track
 
45
of the bugs and their resolution. Bug reports can be submitted via
 
46
email or the web:
 
47
 
 
48
  bioperl-bugs@bioperl.org
 
49
  http://bugzilla.bioperl.org/
 
50
 
 
51
=head1 AUTHOR - Jason Stajich
 
52
 
 
53
Email jason@bioperl.org
 
54
 
 
55
Describe contact details here
 
56
 
 
57
=head1 CONTRIBUTORS
 
58
 
 
59
Additional contributors names and emails here
 
60
 
 
61
=head1 APPENDIX
 
62
 
 
63
The rest of the documentation details each of the object methods.
 
64
Internal methods are usually preceded with a _
 
65
 
 
66
=cut
 
67
 
 
68
 
 
69
# Let the code begin...
 
70
 
 
71
 
 
72
package Bio::Search::Result::WABAResult;
 
73
use vars qw(@ISA);
 
74
use strict;
 
75
 
 
76
use Bio::Search::Result::GenericResult;
 
77
 
 
78
@ISA = qw( Bio::Search::Result::GenericResult );
 
79
 
 
80
=head2 new
 
81
 
 
82
 Title   : new
 
83
 Usage   : my $obj = new Bio::Search::Result::WABAResult();
 
84
 Function: Builds a new Bio::Search::Result::WABAResult object 
 
85
 Returns : Bio::Search::Result::WABAResult
 
86
 Args    : -query_database => "name of the database where the query came from"
 
87
 
 
88
 
 
89
=cut
 
90
 
 
91
sub new {
 
92
  my($class,@args) = @_;
 
93
 
 
94
  my $self = $class->SUPER::new(@args);
 
95
  my ($db) = $self->_rearrange([qw(QUERY_DATABASE)], @args);
 
96
  defined $db && $self->query_database($db);
 
97
  return $self;
 
98
}
 
99
 
 
100
=head2 query_database
 
101
 
 
102
 Title   : query_database
 
103
 Usage   : $obj->query_database($newval)
 
104
 Function: Data field for the database filename where the 
 
105
           query sequence came from
 
106
 Returns : value of query_database
 
107
 Args    : newvalue (optional)
 
108
 
 
109
 
 
110
=cut
 
111
 
 
112
sub query_database{
 
113
    my ($self,$value) = @_;
 
114
    if( defined $value) {
 
115
        $self->{'query_database'} = $value;
 
116
    }
 
117
    return $self->{'query_database'};
 
118
}
 
119
 
 
120
 
 
121
=head2 All other methods are inherited from Bio::Search::Result::GenericResult
 
122
 
 
123
See the L<Bio::Search::Result::GenericResult> for complete
 
124
documentation of the rest of the methods that are available for this
 
125
module.
 
126
 
 
127
=cut
 
128
 
 
129
1;