LICENSE

Copyright [1999-2015] Wellcome Trust Sanger Institute and the EMBL-European Bioinformatics Institute Copyright [2016-2024] EMBL-European Bioinformatics Institute

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

CONTACT

Please email comments or questions to the public Ensembl
developers list at <http://lists.ensembl.org/mailman/listinfo/dev>.

Questions may also be sent to the Ensembl help desk at
<http://www.ensembl.org/Help/Contact>.

NAME

Bio::EnsEMBL::DBSQL::MetaContainer - Encapsulates all access to core database meta information

SYNOPSIS

my $meta_container =
  $registry->get_adaptor( 'Human', 'Core', 'MetaContainer' );

my @mapping_info =
  @{ $meta_container->list_value_by_key('assembly.mapping') };

my $scientific_name = $meta_container->get_scientific_name();

DESCRIPTION

An object that encapsulates specific access to core db meta data

METHODS

get_production_name

Args          : none
Example       : $species = $meta_container->get_production_name();
Description   : Obtains the name of the species in a form usable as, for
                example, a table name, file name etc.
Returntype    : string
Exceptions    : none
Status        : Stable

get_display_name

Args          : none
Example       : $species = $meta_container->get_display_name();
Description   : Obtains the name of the species in a form usable as, for
                example, a short label in a GUI.
Returntype    : string
Exceptions    : none
Status        : Stable

get_common_name

Args          : none
Example       : $species = $meta_container->get_common_name();
Description   : Obtains the common name of the species.
Returntype    : string
Exceptions    : none
Status        : Stable

get_scientific_name

Args          : none
Example       : $species = $meta_container->get_scientific_name();
Description   : Obtains the full scientific name of the species.
Returntype    : string
Exceptions    : none
Status        : Stable

get_division

Args          : none
Example       : $div = $meta_container->get_division();
Description   : Obtains the Ensembl Genomes division to which the species belongs.
Returntype    : string
Exceptions    : none
Status        : Stable

get_taxonomy_id

Arg [1]    : none
Example    : $tax_id = $meta_container->get_taxonomy_id();
Description: Retrieves the taxonomy id from the database meta table
Returntype : string
Exceptions : none
Caller     : ?
Status     : Stable

get_genebuild

Arg [1]    : none
Example    : $tax_id = $meta_container->get_genebuild();
Description: Retrieves the genebuild from the database meta table
Returntype : string
Exceptions : none
Caller     : ?
Status     : Stable

get_genebuild

Example    : $classification = $meta_container->get_classification();
Description: Retrieves the classification held in the backing database minus
             any species specific levels. This means that the first element
             in the array will be subfamily/family level ascending to
             superkingdom
Returntype : ArrayRef[String]
Exceptions : none
Caller     : ?
Status     : Stable