annotate variant_effect_predictor/Bio/EnsEMBL/Utils/SeqRegionCache.pm @ 0:21066c0abaf5 draft

Uploaded
author willmclaren
date Fri, 03 Aug 2012 10:04:48 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
1 =head1 LICENSE
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
2
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
3 Copyright (c) 1999-2012 The European Bioinformatics Institute and
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
4 Genome Research Limited. All rights reserved.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
5
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
6 This software is distributed under a modified Apache license.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
7 For license details, please see
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
8
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
9 http://www.ensembl.org/info/about/code_licence.html
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
10
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
11 =head1 CONTACT
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
12
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
13 Please email comments or questions to the public Ensembl
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
14 developers list at <dev@ensembl.org>.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
15
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
16 Questions may also be sent to the Ensembl help desk at
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
17 <helpdesk@ensembl.org>.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
18
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
19 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
20
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
21 =head1 NAME
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
22
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
23 Bio::EnsEMBL::Utils::SeqRegionCache - A shared LRU cache of information about
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
24 seq_regions
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
25
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
26 =head1 SYNOPSIS
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
27
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
28 use Bio::EnsEMBL::DBSQL::DBAdaptor;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
29
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
30 $db = Bio::EnsEMBL::DBSQL::DBAdaptor->new(...);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
31
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
32 $seq_region_cache = $db->get_SeqRegionCache();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
33
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
34 $key = "$seq_region_name:$coord_system_id";
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
35
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
36 $array = $seq_region_cache->{$key};
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
37
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
38 if ($array) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
39 $name = $array->[1];
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
40 $length = $array->[3];
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
41 } else {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
42 # cache miss, get the info from the database
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
43 # ...
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
44
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
45 # cache the retrieved information
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
46 $seq_region_cache->{$key} = [
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
47 $seq_region_id, $seq_region_name,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
48 $coord_system_id, $seq_region_length
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
49 ];
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
50 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
51
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
52 =head1 DESCRIPTION
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
53
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
54 This module is simply a convenient place to put a cache of sequence
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
55 region information which is shared by several adaptors for a given
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
56 database.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
57
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
58 =head1 METHODS
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
59
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
60 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
61
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
62 use strict;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
63 use Bio::EnsEMBL::Utils::Cache;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
64
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
65 package Bio::EnsEMBL::Utils::SeqRegionCache;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
66
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
67 our $SEQ_REGION_CACHE_SIZE = 40000;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
68
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
69
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
70
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
71 sub new {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
72 my $class = shift;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
73
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
74 my %id_cache;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
75 my %name_cache;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
76
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
77 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
78 # the items to cache should be listrefs to
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
79 # [ sr_id, sr_name, cs_id, sr_length ]
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
80 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
81 # The name cache key is "sr_name:cs_id"
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
82 # The id cache is keyed on "sr_id"
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
83 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
84
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
85 tie(%name_cache, 'Bio::EnsEMBL::Utils::Cache', $SEQ_REGION_CACHE_SIZE);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
86 tie(%id_cache, 'Bio::EnsEMBL::Utils::Cache', $SEQ_REGION_CACHE_SIZE);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
87
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
88 return bless {'name_cache' => \%name_cache,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
89 'id_cache' => \%id_cache}, $class;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
90 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
91
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
92
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
93 1;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
94
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
95
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
96
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
97