Registry.pm 72.2 KB
Newer Older
1
=head1 LICENSE
Ian Longden's avatar
Ian Longden committed
2

3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
  Copyright (c) 1999-2009 The European Bioinformatics Institute and
  Genome Research Limited.  All rights reserved.

  This software is distributed under a modified Apache license.
  For license details, please see

    http://www.ensembl.org/info/about/code_licence.html

=head1 CONTACT

  Please email comments or questions to the public Ensembl
  developers list at <ensembl-dev@ebi.ac.uk>.

  Questions may also be sent to the Ensembl help desk at
  <helpdesk@ensembl.org>.

=cut
Ian Longden's avatar
Ian Longden committed
20 21 22 23 24 25 26

=head1 NAME

Bio::EnsEMBL::Registry

=head1 SYNOPSIS

27
  use Bio::EnsEMBL::Registry;
28

29 30 31 32 33
  my $registry = 'Bio::EnsEMBL::Registry';

  $registry->load_all("configuration_file");

  $gene_adaptor = $registry->get_adaptor( 'Human', 'Core', 'Gene' );
Ian Longden's avatar
Ian Longden committed
34 35 36 37


=head1 DESCRIPTION

38 39
All Adaptors are stored/registered using this module. This module should
then be used to get the adaptors needed.
Ian Longden's avatar
Ian Longden committed
40

41 42
The registry can be loaded from a configuration file using the load_all
method.
Ian Longden's avatar
Ian Longden committed
43

44 45 46 47
If a filename is passed to load_all then this is used.  Else if the
enviroment variable ENSEMBL_REGISTRY is set to the name on an existing
configuration file, then this is used.  Else if the file .ensembl_init
in your home directory exist, it is used.
Ian Longden's avatar
Ian Longden committed
48

49 50
For the Web server ENSEMBL_REGISTRY should be set in SiteDefs.pm.  This
will then be passed on to load_all.
51 52


53 54 55 56
The registry can also be loaded via the method load_registry_from_db
which given a database host will load the latest versions of the Ensembl
databases from it.

57 58
The four types of registries are for db adaptors, dba adaptors, dna
adaptors and the standard type.
Ian Longden's avatar
Ian Longden committed
59 60 61

=head2 db

62 63
These are registries for backwards compatibility and enable the
subroutines to add other adaptors to connections.
Ian Longden's avatar
Ian Longden committed
64

65 66 67
e.g. get_all_db_adaptors, get_db_adaptor, add_db_adaptor,
remove_db_adaptor are the old DBAdaptor subroutines which are now
redirected to the Registry.
Ian Longden's avatar
Ian Longden committed
68 69

So if before we had
70

71
  my $sfa = $self->adaptor()->db()->get_db_adaptor('blast');
Ian Longden's avatar
Ian Longden committed
72 73

We now want to change this to
74

75 76
  my $sfa =
    Bio::EnsEMBL::Registry->get_adaptor( "human", "core", "blast" );
Ian Longden's avatar
Ian Longden committed
77 78 79 80 81 82


=head2 DBA

These are the stores for the DBAdaptors

83 84
The Registry will create all the DBConnections needed now if you set up
the configuration correctly. So instead of the old commands like
Ian Longden's avatar
Ian Longden committed
85

86 87
  my $db           = Bio::EnsEMBL::DBSQL::DBAdaptor->new(...);
  my $exon_adaptor = $db->get_ExonAdaptor;
Ian Longden's avatar
Ian Longden committed
88 89 90

we should now have just

91 92
  my $exon_adaptor =
    Bio::EnsEMBL::Registry->get_adaptor( "human", "core", "exon" );
Ian Longden's avatar
Ian Longden committed
93 94 95 96


=head2 DNA

97 98 99
This is an internal Registry and allows the configuration of a dnadb.
An example here is to set the est database to get its dna data from the
core database.
Ian Longden's avatar
Ian Longden committed
100

101 102 103
  ## set the est db to use the core for getting dna data.
  # Bio::EnsEMBL::Utils::ConfigRegistry->dnadb_add( "Homo Sapiens",
  #   "core", "Homo Sapiens", "est" );
Ian Longden's avatar
Ian Longden committed
104 105 106 107


=head2 adaptors

108 109
This is the registry for all the general types of adaptors like
GeneAdaptor, ExonAdaptor, Slice Adaptor etc.
Ian Longden's avatar
Ian Longden committed
110 111 112

These are accessed by the get_adaptor subroutine i.e.

113 114
  my $exon_adaptor =
    Bio::EnsEMBL::Registry->get_adaptor( "human", "core", "exon" );
Ian Longden's avatar
Ian Longden committed
115 116 117 118 119 120 121 122 123

=head1 METHODS

=cut

package Bio::EnsEMBL::Registry;

use strict;

124
use Bio::EnsEMBL::DBSQL::DBAdaptor;
Ian Longden's avatar
Ian Longden committed
125 126
use Bio::EnsEMBL::Utils::Exception qw( deprecate throw warning );
use Bio::EnsEMBL::Utils::Argument qw(rearrange);
127
use Bio::EnsEMBL::Utils::ConfigRegistry;
128
use DBI;
Ian Longden's avatar
Ian Longden committed
129 130 131

use vars qw(%registry_register);

Glenn Proctor's avatar
Glenn Proctor committed
132
my $API_VERSION = 54;
Ian Longden's avatar
Ian Longden committed
133

134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
# This is a map from group names to Ensembl DB adaptors.
#Used by load_all and reset_DBAdaptor
my %group2adaptor = 
  (
   'blast'         => 'Bio::EnsEMBL::External::BlastAdaptor',
   'compara'       => 'Bio::EnsEMBL::Compara::DBSQL::DBAdaptor',
   'core'          => 'Bio::EnsEMBL::DBSQL::DBAdaptor',
   'estgene'       => 'Bio::EnsEMBL::DBSQL::DBAdaptor',
   'funcgen'       => 'Bio::EnsEMBL::Funcgen::DBSQL::DBAdaptor',
   'haplotype'     => 'Bio::EnsEMBL::ExternalData::Haplotype::DBAdaptor',
   'hive'          => 'Bio::EnsEMBL::Hive::DBSQL::DBAdaptor',
   'lite'          => 'Bio::EnsEMBL::Lite::DBAdaptor',
   'otherfeatures' => 'Bio::EnsEMBL::DBSQL::DBAdaptor',
   'pipeline'      => 'Bio::EnsEMBL::Pipeline::DBSQL::DBAdaptor',
   'snp'           => 'Bio::EnsEMBL::ExternalData::SNPSQL::DBAdaptor',
   'variation'     => 'Bio::EnsEMBL::Variation::DBSQL::DBAdaptor',
   'vega'          => 'Bio::EnsEMBL::DBSQL::DBAdaptor',
  );



Ian Longden's avatar
Ian Longden committed
155
=head2 load_all
156

157 158
 Will load the registry with the configuration file which is
 obtained from the first in the following and in that order.
159

160 161
  1) If an argument is passed to this method, this is used as the
     name of the configuration file to read.
162

163 164
  2) If the enviroment variable ENSEMBL_REGISTRY is set, this is
     used as the name of the configuration file to read.
Ian Longden's avatar
Ian Longden committed
165

166 167
  3) If the file .ensembl_init exist in the home directory, it is
     used as the configuration file.
Ian Longden's avatar
Ian Longden committed
168

169 170
  Arg [1]    : (optional) string
               Name of file to load the registry from.
171

172 173
  Arg [2]    : (optional) integer
               If not 0, will print out all information.
174

175
  Arg [3]    : (optional) integer
176 177 178 179 180 181 182 183 184 185 186 187 188 189
               If not 0, the database connection will not be
               cleared, if 0 or if not set the database connections
               will be cleared (this is the default).

  Arg [4]:     (optional) boolean
               This option will turn off caching for slice features,
               so, every time a set of features is retrieved,
               they will come from the database instead of the
               cache.  This option is only recommended for advanced
               users, specially if you need to store and retrieve
               features.  It might reduce performance when querying
               the database if not used properly.  If in doubt, do
               not use it or ask in ensembl-dev.

Ian Longden's avatar
Ian Longden committed
190 191 192
  Example    : Bio::EnsEMBL::Registry->load_all();
  Returntype : none
  Exceptions : none
193
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
194 195

=cut
196

197 198
sub load_all {
    my $class = shift;
199
    my ( $config_file, $verbose, $no_clear, $no_cache ) = @_;
200 201 202 203 204 205

    $config_file ||= $ENV{ENSEMBL_REGISTRY}
      || $ENV{HOME} . "/.ensembl_init";

    $verbose  ||= 0;
    $no_clear ||= 0;
206
    $no_cache ||= 0;
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236

    if ( !defined($config_file) ) {
        if ($verbose) {
            print( STDERR
                   "No default registry configuration to load.\n" );
        }
    } elsif ( !-e $config_file ) {
        if ($verbose) {
            printf( STDERR "Configuration file '%s' does not exist. "
                      . "Registry configuration not loaded.\n",
                    $config_file );
        }
    } else {
        if ( defined( $registry_register{'seen'} ) ) {
            if ( !$no_clear ) {
                if ($verbose) {
                    print( STDERR "Clearing previously loaded "
                           . "registry configuration\n" );
                }
                $class->clear();
            }
        }
        $registry_register{'seen'} = 1;

        if ($verbose) {
            printf( STDERR
                      "Loading registry configuration from '%s'.\n",
                    $config_file );
        }

237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
        my $cfg;

        eval { require Config::IniFiles };
        if ($@) {
          # The user does not have the 'Config::IniFiles' module.
          if ($verbose) {
            print( STDERR "No Config::IniFiles module found, "
                   . "assuming this is not an ini-file\n" );
          }
          # If the configuration file *is* an ini-file, we can expect a
          # load of compilation errors from the next eval...
        } else {
          # The user has the 'Config::IniFiles' module installed.  See
          # if this is an ini-file or not...
          $cfg = Config::IniFiles->new( -file => $config_file );
        }
253

254
        if ( defined $cfg ) {
255
		  my %default_adaptor_args = ();
256 257 258 259

            if ( $cfg->SectionExists('default') ) {
                # The 'default' section is special.  It contain default
                # values that should be implicit to all other section in
260 261 262 263 264 265 266 267 268 269 270 271 272
                # this configuration file.  Aliases are added if there
                # is also a 'species' setting.

                my $alias = $cfg->val( 'default', 'alias' );
                $cfg->delval( 'default', 'alias' );

                my $species = $cfg->val( 'default', 'species' );

                if ( defined($alias) && defined($species) ) {
                    Bio::EnsEMBL::Utils::ConfigRegistry->add_alias(
                                     -species => $species,
                                     -alias => [ split( /\n/, $alias ) ]
                    );
273
                }
274

275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
                %default_adaptor_args =
                  map { '-' . $_ => $cfg->val( 'default', $_ ) }
                  $cfg->Parameters('default');
            }

            foreach my $section ( $cfg->Sections() ) {
                if ( $section eq 'default' )
                {    # We have already done the 'default' section.
                    next;
                }

                my $group = $cfg->val( $section, 'group' )
                  || $cfg->val( 'default', 'group' );

                if ( !defined($group) ) {
                    printf( STDERR "Key 'group' is undefined "
                              . "for configuration section '%s', "
                              . "skipping this section.\n",
                            $section );
                    next;
                }

                my $adaptor = $group2adaptor{ lc($group) };
                if ( !defined($adaptor) ) {
                    printf( STDERR "Unknown group '%s' "
                              . "for configuration section '%s', "
                              . "skipping this section.\n",
                            $group, $section );
                    next;
                }

306 307 308 309 310
                # Handle aliases.  A section must have both an 'alias'
                # setting and a 'species' setting for aliases to be
                # added.  The 'species' setting might be inherited from
                # the 'default' section.

311 312 313
                my $alias = $cfg->val( $section, 'alias' );
                $cfg->delval( $section, 'alias' );

314 315 316 317 318 319 320 321 322 323 324
                my $species = $cfg->val( $section, 'species' )
                  || $cfg->val( 'default', 'species' );

                if ( defined($alias) && defined($species) ) {
                    Bio::EnsEMBL::Utils::ConfigRegistry->add_alias(
                                     -species => $species,
                                     -alias => [ split( /\n/, $alias ) ]
                    );
                }

                # Fill in the adaptor initialization arguments.
325 326 327
                # We trust the user to provide sensible key-value pairs.
                my %adaptor_args = %default_adaptor_args;
                foreach my $parameter ( $cfg->Parameters($section) ) {
328 329 330 331 332 333 334 335
                  $adaptor_args{ '-' . $parameter } =
                    $cfg->val( $section, $parameter );

                  # when set, do not use the feature cache in the
                  # different adaptors
                  if ($no_cache) {
                    $adaptor_args{'-no_cache'} = 1;
                  }
336 337 338 339 340 341 342 343
                }

                if ($verbose) {
                    printf( "Configuring adaptor '%s' "
                              . "for configuration section '%s'...\n",
                            $adaptor, $section );
                }

344 345 346
                eval "require $adaptor";
                if ($@) { die($@) }

347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
                $adaptor->new(%adaptor_args);

            } ## end foreach my $section ( $cfg->Sections...
        } else {
            # This is probably no ini-file but an old style piece
            # of configuration written in Perl.  We need to try to
            # require() it.

            eval { require($config_file) };
            if ($@) { die($@) }

            # To make the web code avoid doing this again:
            delete $INC{$config_file};
        }
    } ## end else [ if ( !defined($config_file...
362
} ## end sub load_all
363 364

=head2 clear
365

366 367 368 369 370
 Will clear the registry and disconnect from all databases.

  Example    : Bio::EnsEMBL::Registry->clear();
  Returntype : none
  Exceptions : none
371
  Status     : Stable
372 373 374 375 376 377 378 379 380 381 382

=cut

sub clear{
  my ($self);
  
  foreach my $dba (@{$registry_register{'_DBA'}}){
    if($dba->dbc->connected){
      $dba->dbc->db_handle->disconnect();
    }
  }
Ian Longden's avatar
Ian Longden committed
383
  %registry_register = ();
Ian Longden's avatar
Ian Longden committed
384 385 386
}

#
387
# db adaptors. (for backwards compatibility)
Ian Longden's avatar
Ian Longden committed
388 389 390 391
#

=head2 add_db

392
  Arg [1]    : db (DBAdaptor) to add adaptor to.
Ian Longden's avatar
Ian Longden committed
393 394 395 396 397
  Arg [2]    : name of the name to add the adaptor to in the registry.
  Arg [3]    : The adaptor to be added to the registry.
  Example    : Bio::EnsEMBL::Registry->add_db($db, "lite", $dba);
  Returntype : none
  Exceptions : none
398
  Status     : At Risk.
399 400 401 402
             : This is here for backwards compatibility only and may
             : be removed eventually.  Solution is to make sure the
             : db and the adaptor have the same species and the call
             : is then no longer needed.
Ian Longden's avatar
Ian Longden committed
403

404
=cut
Ian Longden's avatar
Ian Longden committed
405

406 407
sub add_db {
  my ( $class, $db, $name, $adap ) = @_;
Ian Longden's avatar
Ian Longden committed
408

409 410 411
  if ( lc( $db->species() ) ne lc( $adap->species ) ) {
    $registry_register{ lc( $db->species() ) }{ lc( $db->group() ) }
      {'_special'}{ lc($name) } = $adap;
412
  }
Ian Longden's avatar
Ian Longden committed
413 414 415 416
}

=head2 remove_db

417
  Arg [1]    : db (DBAdaptor) to remove adaptor from.
Ian Longden's avatar
Ian Longden committed
418 419 420 421
  Arg [2]    : name to remove the adaptor from in the registry.
  Example    : my $db = Bio::EnsEMBL::Registry->remove_db($db, "lite");
  Returntype : adaptor
  Exceptions : none
422
  Status     : At Risk.
423 424 425 426
             : This is here for backwards compatibility only and may
             : be removed eventually.  Solution is to make sure the
             : db and the adaptor have the same species and the call
             : is then no longer needed.
Ian Longden's avatar
Ian Longden committed
427 428 429

=cut

430 431 432 433 434 435
sub remove_db {
  my ( $class, $db, $name ) = @_;

  my $ret =
    $registry_register{ lc( $db->species() ) }{ lc( $db->group() ) }
    {'_special'}{ lc($name) };
Ian Longden's avatar
Ian Longden committed
436

437 438
  $registry_register{ lc( $db->species() ) }{ lc( $db->group() ) }
    {'_special'}{ lc($name) } = undef;
Ian Longden's avatar
Ian Longden committed
439 440 441 442 443 444

  return $ret;
}

=head2 get_db

445
  Arg [1]    : db (DBAdaptor) to get adaptor from.
Ian Longden's avatar
Ian Longden committed
446 447 448 449
  Arg [2]    : name to get the adaptor for in the registry.
  Example    : my $db = Bio::EnsEMBL::Registry->get_db("Human", "core", "lite");
  Returntype : adaptor
  Exceptions : none
450
  Status     : At Risk.
451 452 453 454
             : This is here for backwards compatibility only and may
             : be removed eventually.  Solution is to make sure the
             : db and the adaptor have the same species then call
             : get_DBAdaptor instead.
Ian Longden's avatar
Ian Longden committed
455 456 457

=cut

458 459
sub get_db {
  my ( $class, $db, $name ) = @_;
Ian Longden's avatar
Ian Longden committed
460

461 462
  my $ret = Bio::EnsEMBL::Registry->get_DBAdaptor( lc( $db->species ),
    lc($name) );
463

464 465 466 467
  if ( defined($ret) ) { return $ret }

  return $registry_register{ lc( $db->species() ) }
    { lc( $db->group() ) }{'_special'}{ lc($name) };
Ian Longden's avatar
Ian Longden committed
468 469 470 471
}

=head2 get_all_db_adaptors

472
  Arg [1]    : db (DBAdaptor) to get all the adaptors from.
Ian Longden's avatar
Ian Longden committed
473 474 475
  Example    : my $db = Bio::EnsEMBL::Registry->get_all_db_adaptors($db);
  Returntype : adaptor
  Exceptions : none
476
  Status     : At Risk.
477 478 479 480
             : This is here for backwards compatibility only and
             : may be removed eventually.  Solution is to make
             : sure the dbs all have the same species then call
             : get_all_DBAdaptors(-species => "human");
481

Ian Longden's avatar
Ian Longden committed
482 483 484

=cut

485 486 487
sub get_all_db_adaptors {
  my ( $class, $db ) = @_;
  my %ret = ();
Ian Longden's avatar
Ian Longden committed
488

489 490
  # we now also want to add all the DBAdaptors for the same species.
  # as add_db_adaptor does not add if it is from the same species.
Ian Longden's avatar
Ian Longden committed
491

492 493 494 495
  foreach my $dba ( @{ $registry_register{'_DBA'} } ) {
    if ( lc( $dba->species() ) eq lc( $db->species() ) ) {
      $ret{ $dba->group() } = $dba;
    }
Ian Longden's avatar
Ian Longden committed
496 497
  }

498
  foreach my $key (
499 500 501
    keys %{
      $registry_register{ $class->get_alias( $db->species() ) }
        { lc( $db->group() ) }{'_special'} } )
502 503 504 505 506
  {
    $ret{$key} =
      $registry_register{ $class->get_alias( $db->species() ) }
      { lc( $db->group() ) }{'_special'}{$key};
  }
Ian Longden's avatar
Ian Longden committed
507 508

  return \%ret;
509
} ## end sub get_all_db_adaptors
Ian Longden's avatar
Ian Longden committed
510 511 512 513 514 515 516 517 518 519 520 521 522 523


#
# DBAdaptors
#

=head2 add_DBAdaptor

  Arg [1]    : name of the species to add the adaptor to in the registry.
  Arg [2]    : name of the group to add the adaptor to in the registry.
  Arg [3]    : The DBAaptor to be added to the registry.
  Example    : Bio::EnsEMBL::Registry->add_DBAdaptor("Human", "core", $dba);
  Returntype : none
  Exceptions : none
524 525
  caller     : internal
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
526 527 528

=cut

529 530
sub add_DBAdaptor {
  my ( $class, $species, $group, $adap ) = @_;
Ian Longden's avatar
Ian Longden committed
531

532 533
  if ( !( $class->alias_exists($species) ) ) {
    $class->add_alias( $species, $species );
534 535
  }

Ian Longden's avatar
Ian Longden committed
536 537
  $species = $class->get_alias($species);

538
  $registry_register{$species}{ lc($group) }{'_DB'} = $adap;
Ian Longden's avatar
Ian Longden committed
539

540 541 542 543 544 545
  if ( !defined( $registry_register{'_DBA'} ) ) {
    my @list = ();
    push( @list, $adap );
    $registry_register{'_DBA'} = \@list;
  } else {
    push( @{ $registry_register{'_DBA'} }, $adap );
Ian Longden's avatar
Ian Longden committed
546 547 548 549 550 551 552 553 554 555 556 557 558
  }

}



=head2 get_DBAdaptor

  Arg [1]    : name of the species to get the adaptor for in the registry.
  Arg [2]    : name of the group to get the adaptor for in the registry.
  Example    : $dba = Bio::EnsEMBL::Registry->get_DBAdaptor("Human", "core");
  Returntype : DBAdaptor
  Exceptions : none
559
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
560 561 562

=cut

563 564
sub get_DBAdaptor {
  my ( $class, $species, $group ) = @_;
Ian Longden's avatar
Ian Longden committed
565 566 567

  $species = $class->get_alias($species);

568
  return $registry_register{$species}{ lc($group) }{'_DB'};
Ian Longden's avatar
Ian Longden committed
569 570 571 572
}

=head2 get_all_DBAdaptors

573 574 575 576
  Arg [SPECIES]: (optional) string 
                  species name to get adaptors for
  Arg [GROUP]  : (optional) string 
                  group name to get adaptors for
577 578 579 580 581 582 583 584 585
  Example      : 
                @dba =
                  @{ Bio::EnsEMBL::Registry->get_all_DBAdaptors() };

                @human_dbas =
                  @{ Bio::EnsEMBL::Registry->get_all_DBAdaptors(
                    -species => 'human'
                  ) };

586 587
  Returntype   : list of DBAdaptors
  Exceptions   : none
588
  Status       : Stable
Ian Longden's avatar
Ian Longden committed
589 590 591

=cut

592 593 594 595
sub get_all_DBAdaptors {
  my ( $class, @args ) = @_;

  my ( $species, $group ) = rearrange( [qw(SPECIES GROUP)], @args );
Ian Longden's avatar
Ian Longden committed
596

597
  if ( defined($species) ) { $species = $class->get_alias($species) }
598

599
  my @ret;
600
  foreach my $dba ( @{ $registry_register{'_DBA'} } ) {
601 602 603 604
    if ( ( !defined($species) || lc($species) eq lc( $dba->species() ) )
      && ( !defined($group) || lc($group) eq lc( $dba->group() ) ) )
    {
      push( @ret, $dba );
605 606 607 608
    }
  }

  return \@ret;
Ian Longden's avatar
Ian Longden committed
609 610
}

611 612
=head2 get_all_DBAdaptors_by_connection

613
  Arg [1]    : DBConnection used to find DBAdaptors
614
  Returntype : reference to list of DBAdaptors
615 616 617
  Exceptions : none
  Example    : @dba = @{ Bio::EnsEMBL::Registry
                  ->get_all_DBAdaptors_by_connection($dbc) };
618
  Status     : Stable
619 620 621

=cut

622 623 624
sub get_all_DBAdaptors_by_connection {
  my ( $self, $dbc_orig ) = @_;

625 626
  my @return;

627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661
  foreach my $dba ( @{ $registry_register{'_DBA'} } ) {
    my $dbc = $dba->dbc();

    if (    defined($dbc)
         && $dbc->can('equals')
         && $dbc->equals($dbc_orig) )
    {
      push( @return, $dba );
    }
  }

  return \@return;
}

=head2 get_all_DBAdaptors_by_dbname

  Arg [1]    : string, name of database
  Returntype : reference to list of DBAdaptors
  Exceptions : none
  Example    : @dba = @{ Bio::EnsEMBL::Registry
                  ->get_all_DBAdaptors_by_dbname($dbname) };
  Status     : Stable

=cut

sub get_all_DBAdaptors_by_dbname {
  my ( $self, $dbname ) = @_;

  my @return;

  foreach my $dba ( @{ $registry_register{'_DBA'} } ) {
    my $dbc = $dba->dbc();

    if ( defined($dbc) && $dbc->dbname() eq $dbname ) {
      push( @return, $dba );
662 663
    }
  }
664

665 666 667
  return \@return;
}

668 669 670 671 672 673 674 675 676 677 678 679 680 681 682
=head2 remove_DBAdaptor

  Arg [1]    : name of the species to get the adaptor for in the registry.
  Arg [2]    : name of the group to get the adaptor for in the registry.
  Example    : $dba = Bio::EnsEMBL::Registry->remove_DBAdaptor("Human", "core");
  Returntype : none
  Exceptions : none
  Status     : At risk

=cut

sub remove_DBAdaptor{
  my ($class, $species, $group) = @_;

  $species = $class->get_alias($species);
Nathan Johnson's avatar
Nathan Johnson committed
683 684
  
 
685
  delete $registry_register{$species}{$group};
686
  # This will remove the DBAdaptor and all the other adaptors
687

688
  # Now remove if from the _DBA array
689 690
  my $index;

Nathan Johnson's avatar
Nathan Johnson committed
691

692 693
  foreach my $i(0..$#{$registry_register{'_DBA'}}){
    my $dba = $registry_register{'_DBA'}->[$i];
Nathan Johnson's avatar
Nathan Johnson committed
694

695 696 697
    if(($dba->species eq $species) &&
       $dba->group eq $group){
      $index = $i;
Nathan Johnson's avatar
Nathan Johnson committed
698

699 700 701 702
      last;
    }
  }
  
703
  
704
  # Now remove from _DBA cache
705
  splice(@{$registry_register{'_DBA'}}, $index, 1) if defined $index;
Nathan Johnson's avatar
Nathan Johnson committed
706

707 708 709
  return;
}

710

Nathan Johnson's avatar
Nathan Johnson committed
711 712 713 714 715 716 717

=head2 reset_DBAdaptor

  Arg [1]:     string - species e.g. homo_sapiens
  Arg [2]:     string - DB group e.g. core
  Arg [3]:     string - new dbname
  Args [4-7]:  string - optional DB parameters, defaults to current db params if omitted
718
  Arg [8]:     hashref - Hash ref of additional parameters e.g. eFG dnadb params for auto selecting dnadb
719 720
  Usage :      $reg->reset_registry_db( 'homo_sapiens', 'core',
                  'homo_sapiens_core_37_35j' );
Nathan Johnson's avatar
Nathan Johnson committed
721 722 723 724 725 726 727 728
  Description: Resets a DB within the registry.
  Exceptions:  Throws if mandatory params not supplied
               Throws if species name is not already seen by the registry
               Throws if no current DB for species/group available
  Status :     At risk

=cut

729 730 731 732 733
sub reset_DBAdaptor {
  my (
    $self, $species, $group, $dbname, $host,
    $port, $user,    $pass,  $params
  ) = @_;
Nathan Johnson's avatar
Nathan Johnson committed
734

735
  # Check mandatory params
736 737 738 739
  if ( !( defined $species && defined $group && defined $dbname ) ) {
    throw(
      'Must provide at least a species, group, and dbname parameter '
        . 'to redefine a DB in the registry' );
Nathan Johnson's avatar
Nathan Johnson committed
740
  }
741

742
  # Validate species here
Nathan Johnson's avatar
Nathan Johnson committed
743
  my $alias = $self->get_alias($species);
744 745 746
  throw("Could not find registry alias for species:\t$species")
    if ( !defined $alias );

747
  # Get all current defaults if not defined
Nathan Johnson's avatar
Nathan Johnson committed
748

749
  my $db = $self->get_DBAdaptor( $alias, $group );
750
  my $class;
Nathan Johnson's avatar
Nathan Johnson committed
751

752 753 754 755 756 757 758 759 760
  if ($db) {
    $class = ref($db);
    $host ||= $db->dbc->host;
    $port ||= $db->dbc->port;
    $user ||= $db->dbc->username;
    $pass ||= $db->dbc->password;
  } else {
    #Now we need to test mandatory params
    $class = $group2adaptor{ lc($group) };
761

762 763 764 765
    if ( !( $host && $user ) ) {
      throw("No comparable $alias $group DB present in Registry. "
          . "You must pass at least a dbhost and dbuser" );
    }
766
  }
Nathan Johnson's avatar
Nathan Johnson committed
767

768
  $self->remove_DBAdaptor( $alias, $group );
Nathan Johnson's avatar
Nathan Johnson committed
769

770 771 772 773
  #my @adaptors = @{$self->get_all_adaptors};
  #This is causing a loop as it was constantly trying to reset the db
  #and never getting there.
  #I think this was left over from testing
Nathan Johnson's avatar
Nathan Johnson committed
774

775
  # ConfigRegistry should automatically add this to the Registry
776 777

  $db = $class->new(
778 779 780 781 782 783 784 785
    -user    => $user,
    -host    => $host,
    -port    => $port,
    -pass    => $pass,
    -dbname  => $dbname,
    -species => $alias,
    -group   => $group,
    %{$params} );
Nathan Johnson's avatar
Nathan Johnson committed
786 787

  return $db;
788
} ## end sub reset_DBAdaptor
Nathan Johnson's avatar
Nathan Johnson committed
789 790


Ian Longden's avatar
Ian Longden committed
791 792 793 794 795 796 797 798
#
# DNA Adaptors
#

=head2 add_DNAAdaptor

  Arg [1]    : name of the species to add the adaptor to in the registry.
  Arg [2]    : name of the group to add the adaptor to in the registry.
799 800 801
  Arg [3]    : name of the species to get the dna from
  Arg [4]    : name of the group to get the dna from
  Example    : Bio::EnsEMBL::Registry->add_DNAAdaptor("Human", "estgene", "Human", "core");
Ian Longden's avatar
Ian Longden committed
802 803
  Returntype : none
  Exceptions : none
804
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
805 806 807

=cut

808 809
sub add_DNAAdaptor {
  my ( $class, $species, $group, $dnadb_species, $dnadb_group ) = @_;
Ian Longden's avatar
Ian Longden committed
810

811
  $species       = $class->get_alias($species);
812
  $dnadb_species = $class->get_alias($dnadb_species);
813
  if ( $dnadb_group->isa('Bio::EnsEMBL::DBSQL::DBAdaptor') ) {
Ian Longden's avatar
Ian Longden committed
814
    deprecated("");
815 816 817 818
  } else {
    $registry_register{$species}{ lc($group) }{'_DNA'} = $dnadb_group;
    $registry_register{$species}{ lc($group) }{'_DNA2'} =
      $dnadb_species;
819
  }
Ian Longden's avatar
Ian Longden committed
820 821 822 823 824 825 826 827 828
}

=head2 get_DNAAdaptor

  Arg [1]    : name of the species to get the adaptor for in the registry.
  Arg [2]    : name of the group to get the adaptor for in the registry.
  Example    : $dnaAdap = Bio::EnsEMBL::Registry->get_DNAAdaptor("Human", "core");
  Returntype : adaptor
  Exceptions : none
829
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
830 831 832

=cut

833 834
sub get_DNAAdaptor {
  my ( $class, $species, $group ) = @_;
Ian Longden's avatar
Ian Longden committed
835 836

  $species = $class->get_alias($species);
837 838 839 840 841
  my $new_group   = $registry_register{$species}{ lc($group) }{'_DNA'};
  my $new_species = $registry_register{$species}{ lc($group) }{'_DNA2'};

  if ( defined $new_group ) {
    return $class->get_DBAdaptor( $new_species, $new_group );
842
  }
843 844

  return undef;
Ian Longden's avatar
Ian Longden committed
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860
}

#
# General Adaptors
#

=head2 add_adaptor

  Arg [1]    : name of the species to add the adaptor to in the registry.
  Arg [2]    : name of the group to add the adaptor to in the registry.
  Arg [3]    : name of the type to add the adaptor to in the registry.
  Arg [4]    : The DBAaptor to be added to the registry.
  Arg [5]    : (optional) if set okay to overwrite.
  Example    : Bio::EnsEMBL::Registry->add_adaptor("Human", "core", "Gene", $adap);
  Returntype : none
  Exceptions : none
861 862
  Caller     : internal
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
863 864 865

=cut

866 867
sub add_adaptor {
  my ( $class, $species, $group, $type, $adap, $reset ) = @_;
Ian Longden's avatar
Ian Longden committed
868 869 870

  $species = $class->get_alias($species);

871 872 873 874 875
  # Since the adaptors are not stored initially, only their class paths
  # when the adaptors are obtained, we need to store these instead.  It
  # is not necessarily an error if the registry is overwritten without
  # the reset set but it is an indication that we are overwriting a
  # database which should be a warning for now
Ian Longden's avatar
Ian Longden committed
876

877 878 879
  if ( defined($reset) )
  {    # JUST REST THE HASH VALUE NO MORE PROCESSING NEEDED
    $registry_register{$species}{ lc($group) }{ lc($type) } = $adap;
Ian Longden's avatar
Ian Longden committed
880 881
    return;
  }
882 883 884 885 886 887 888
  if (
    defined( $registry_register{$species}{ lc($group) }{ lc($type) } ) )
  {
  # print STDERR (
  #      "Overwriting Adaptor in Registry for $species $group $type\n");
    $registry_register{$species}{ lc($group) }{ lc($type) } = $adap;
    return;
Ian Longden's avatar
Ian Longden committed
889
  }
890
  $registry_register{$species}{ lc($group) }{ lc($type) } = $adap;
Ian Longden's avatar
Ian Longden committed
891

892 893 894 895
  if ( !defined( $registry_register{$species}{'list'} ) ) {
    $registry_register{$species}{'list'} = [$type];
  } else {
    push( @{ $registry_register{$species}{'list'} }, $type );
Ian Longden's avatar
Ian Longden committed
896 897
  }

898 899 900 901
  if ( !defined( $registry_register{ lc($type) }{$species} ) ) {
    $registry_register{ lc($type) }{$species} = [$type];
  } else {
    push( @{ $registry_register{ lc($type) }{$species} }, $adap );
Ian Longden's avatar
Ian Longden committed
902 903
  }

904
} ## end sub add_adaptor
Ian Longden's avatar
Ian Longden committed
905 906 907 908 909 910 911 912 913 914


=head2 get_adaptor

  Arg [1]    : name of the species to add the adaptor to in the registry.
  Arg [2]    : name of the group to add the adaptor to in the registry.
  Arg [3]    : name of the type to add the adaptor to in the registry.
  Example    : $adap = Bio::EnsEMBL::Registry->get_adaptor("Human", "core", "Gene");
  Returntype : adaptor
  Exceptions : none
915
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
916 917 918

=cut

919 920
sub get_adaptor {
  my ( $class, $species, $group, $type ) = @_;
Glenn Proctor's avatar
Typos.  
Glenn Proctor committed
921

922
  $species = $class->get_alias($species);
Glenn Proctor's avatar
Typos.  
Glenn Proctor committed
923

924 925 926 927 928 929 930 931
  my %dnadb_adaptors = (
    'sequence'                 => 1,
    'assemblymapper'           => 1,
    'karyotypeband'            => 1,
    'repeatfeature'            => 1,
    'coordsystem'              => 1,
    'assemblyexceptionfeature' => 1
  );
932

933
  ## warn "$species, $group, $type";
934 935 936

  $type = lc($type);

937
  my $dnadb_group = $registry_register{$species}{ lc($group) }{'_DNA'};
938

939 940 941 942 943
  if ( defined($dnadb_group)
    && defined( $dnadb_adaptors{ lc($type) } ) )
  {
    $species = $registry_register{$species}{ lc($group) }{'_DNA2'};
    $group   = $dnadb_group;
Ian Longden's avatar
Ian Longden committed
944 945
  }

946
  my $ret = $registry_register{$species}{ lc($group) }{ lc($type) };
947 948
  if ( !defined($ret) ) { return undef }
  if ( ref($ret) )      { return $ret }
949

950
  # Not instantiated yet
Ian Longden's avatar
Ian Longden committed
951

952 953 954 955 956 957 958
  my $dba    = $registry_register{$species}{ lc($group) }{'_DB'};
  my $module = $ret;

  eval "require $module";
  if ($@) {
    warning("'$module' cannot be found.\nException $@\n");
    return undef;
Ian Longden's avatar
Ian Longden committed
959 960
  }

961 962 963 964 965 966 967 968 969 970 971 972
  if (
    !defined( $registry_register{$species}{ lc($group) }{'CHECKED'} ) )
  {
    $registry_register{$species}{ lc($group) }{'CHECKED'} = 1;
    $class->version_check($dba);
  }

  my $adap = "$module"->new($dba);
  Bio::EnsEMBL::Registry->add_adaptor( $species, $group, $type, $adap,
    'reset' );
  $ret = $adap;

Ian Longden's avatar
Ian Longden committed
973
  return $ret;
974
} ## end sub get_adaptor
Ian Longden's avatar
Ian Longden committed
975 976 977

=head2 get_all_adaptors

978 979 980 981 982 983
  Arg [SPECIES] : (optional) string 
                  species name to get adaptors for
  Arg [GROUP] : (optional) string 
                  group name to get adaptors for
  Arg [TYPE] : (optional) string 
                  type to get adaptors for
Ian Longden's avatar
Ian Longden committed
984
  Example    : @adaps = @{Bio::EnsEMBL::Registry->get_all_adaptors()};
985
  Returntype : ref to list of adaptors
Ian Longden's avatar
Ian Longden committed
986
  Exceptions : none
987
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
988 989 990 991

=cut

sub get_all_adaptors{
992 993 994 995
  my ($class,@args)= @_;
  my ($species, $group, $type);
  my @ret=();
  my (%species_hash, %group_hash, %type_hash);
Ian Longden's avatar
Ian Longden committed
996

997

998
  if(@args == 1){ # Old species only one parameter
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
    warn("-SPECIES argument should now be used to get species adaptors");
    $species = $args[0];
  }
  else{
    # new style -SPECIES, -GROUP, -TYPE
    ($species, $group, $type) =
      rearrange([qw(SPECIES GROUP TYPE)], @args);
  }

  if(defined($species)){
    $species_hash{$species} = 1;
  }
  else{
    # get list of species
    foreach my $dba (@{$registry_register{'_DBA'}}){
      $species_hash{lc($dba->species())} = 1;
    }
  }
  if(defined($group)){
    $group_hash{$group} = 1;
  }
  else{
    foreach my $dba (@{$registry_register{'_DBA'}}){
      $group_hash{lc($dba->group())} = 1;
    }
  }
  if(defined($type)){
    $type_hash{$type} =1;
  }
  else{
    foreach my $dba (@{$registry_register{'_DBA'}}){ 
1030
	foreach my $ty (@{$registry_register{lc($dba->species)}{'list'}}){
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
	  $type_hash{lc($ty)} = 1;
	}
      }
  }
  
  ### NOW NEED TO INSTANTIATE BY CALLING get_adaptor
  foreach my $sp (keys %species_hash){
    foreach my $gr (keys %group_hash){
      foreach my $ty (keys %type_hash){
	my $temp = $class->get_adaptor($sp,$gr,$ty);
	if(defined($temp)){
	  push @ret, $temp;
	}
      }
    }
  }
  return (\@ret);
Ian Longden's avatar
Ian Longden committed
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
}


=head2 add_alias

  Arg [1]    : name of the species to add alias for
  Arg [2]    : name of the alias
  Example    : Bio::EnsEMBL::Registry->add_alias("Homo Sapiens","Human");
  Description: add alternative name for the species.
  Returntype : none
  Exceptions : none
1059
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
1060 1061 1062 1063 1064 1065

=cut

sub add_alias{
  my ($class, $species,$key) = @_;

1066
  $registry_register{'_ALIAS'}{lc($key)} = lc($species);
Ian Longden's avatar
Ian Longden committed
1067 1068 1069 1070 1071 1072 1073 1074
}

=head2 get_alias

  Arg [1]    : name of the possible alias to get species for
  Example    : Bio::EnsEMBL::Registry->get_alias("Human");
  Description: get proper species name.
  Returntype : species name
1075
  Exceptions : none
1076
  Status     : Stable