line |
bran |
sub |
pod |
code |
1
|
|
|
|
package Sanger::CGP::Vagrent::Data::AbstractVariation; |
2
|
|
|
|
|
3
|
|
|
|
##########LICENCE########## |
4
|
|
|
|
# Copyright (c) 2014 Genome Research Ltd. |
5
|
|
|
|
# |
6
|
|
|
|
# Author: Cancer Genome Project cgpit@sanger.ac.uk |
7
|
|
|
|
# |
8
|
|
|
|
# This file is part of VAGrENT. |
9
|
|
|
|
# |
10
|
|
|
|
# VAGrENT is free software: you can redistribute it and/or modify it under |
11
|
|
|
|
# the terms of the GNU Affero General Public License as published by the Free |
12
|
|
|
|
# Software Foundation; either version 3 of the License, or (at your option) any |
13
|
|
|
|
# later version. |
14
|
|
|
|
# |
15
|
|
|
|
# This program is distributed in the hope that it will be useful, but WITHOUT |
16
|
|
|
|
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS |
17
|
|
|
|
# FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more |
18
|
|
|
|
# details. |
19
|
|
|
|
# |
20
|
|
|
|
# You should have received a copy of the GNU Affero General Public License |
21
|
|
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>. |
22
|
|
|
|
##########LICENCE########## |
23
|
|
|
|
|
24
|
|
|
|
|
25
|
|
4
|
|
use strict; |
26
|
|
|
|
|
27
|
|
4
|
|
use Sanger::CGP::Vagrent qw($VERSION); |
28
|
|
4
|
|
use base qw(Bio::Root::Root); |
29
|
|
|
|
|
30
|
|
|
|
1; |
31
|
|
|
|
|
32
|
|
|
|
sub isValid { |
33
|
|
0
|
1
|
shift->throw_not_implemented; |
34
|
|
|
|
} |
35
|
|
|
|
|
36
|
|
|
|
__END__ |
37
|
|
|
|
|
38
|
|
|
|
=head1 NAME |
39
|
|
|
|
|
40
|
|
|
|
Sanger::CGP::Vagrent::Data::AbstractVariation - Abstract Data object representing |
41
|
|
|
|
a variation |
42
|
|
|
|
|
43
|
|
|
|
=head1 DESCRIPTION |
44
|
|
|
|
|
45
|
|
|
|
This is an abstract data class designed to be extended, it provides a common base class for all |
46
|
|
|
|
variations. Its also privides a placeholder function isValid that must me implemented in child |
47
|
|
|
|
classes |
48
|
|
|
|
|
49
|
|
|
|
=head1 METHODS |
50
|
|
|
|
|
51
|
|
|
|
=head2 Functions |
52
|
|
|
|
|
53
|
|
|
|
=head3 isValid |
54
|
|
|
|
|
55
|
|
|
|
=over |
56
|
|
|
|
|
57
|
|
|
|
=item Usage : |
58
|
|
|
|
|
59
|
|
|
|
if($var->isValid()){ ....... } |
60
|
|
|
|
|
61
|
|
|
|
=item Function : |
62
|
|
|
|
|
63
|
|
|
|
Abstract validation function, checks internal data, must be implemented by subclasses |
64
|
|
|
|
|
65
|
|
|
|
=item Returns : |
66
|
|
|
|
|
67
|
|
|
|
1 for pass, 0 for fail |
68
|
|
|
|
|
69
|
|
|
|
=back |