Bio::EnsEMBL::MetaData::DBSQL::DataReleaseInfoAdaptor Class Reference
Inheritance diagram for Bio::EnsEMBL::MetaData::DBSQL::DataReleaseInfoAdaptor:

List of all members.


Class Summary

Synopsis

# metadata_db is an instance of MetaDataDBAdaptor
my $adaptor = $metadata_db->get_DataReleaseInfoAdaptor();
# find the latest e! release
my $release = $adaptor->fetch_current_ensembl_release();
# find associated databases
$adaptor->fetch_databases($release);

Description

Adaptor for storing and retrieving DataRelease objects from MySQL genome_info database

See-also

Bio::EnsEMBL::MetaData::DataReleaseInfo Bio::EnsEMBL::MetaData::DatabaseInfo Bio::EnsEMBL::MetaData::GenomeInfo

Definition at line 30 of file DataReleaseInfoAdaptor.pm.

Available Methods

protected String _args_to_sql ()
protected void _cache ()
protected void _clear_cache ()
protected _fetch_children ()
protected void _fetch_databases ()
protected Arrayref _fetch_generic ()
protected Arrayref _fetch_generic_with_args ()
protected Arrayref _first_element ()
protected _get_base_sql ()
protected Object _get_cached_obj ()
protected void _get_division_id ()
protected _get_id_field ()
protected _get_obj_class ()
protected void _store_cached_obj ()
protected void _store_databases ()
public fetch_all ()
public
Bio::EnsEMBL::MetaData::GenomeInfo 
fetch_by_dbID ()
public
Bio::EnsEMBL::MetaData::GenomeInfo 
fetch_by_dbIDs ()
public
Bio::EnsEMBL::MetaData::DataReleaseInfo 
fetch_by_ensembl_genomes_release ()
public
Bio::EnsEMBL::MetaData::DataReleaseInfo 
fetch_by_ensembl_release ()
public
Bio::EnsEMBL::MetaData::DataReleaseInfo 
fetch_current_ensembl_genomes_release ()
public
Bio::EnsEMBL::MetaData::DataReleaseInfo 
fetch_current_ensembl_release ()
public fetch_databases ()
public store ()
public void update ()

Method Documentation

protected String Bio::EnsEMBL::MetaData::DBSQL::BaseInfoAdaptor::_args_to_sql ( ) [inherited]
  Description: Add where clauses to SQL given arguments
  Arg        : String - Base SQL
  Arg        : Hashref - arguments
  Returntype : String
  Exceptions : none
  Caller     : internal
  Status     : Stable
 
Code:
click to view

Reimplemented in Bio::EnsEMBL::MetaData::DBSQL::GenomeComparaInfoAdaptor, and Bio::EnsEMBL::MetaData::DBSQL::GenomeInfoAdaptor.

protected void Bio::EnsEMBL::MetaData::DBSQL::BaseInfoAdaptor::_cache ( ) [inherited]
  Arg	     : type of object for cache
  Description: Return internal cache for given type
  Returntype : none
  Exceptions : none
  Caller     : internal
  Status     : Stable
 
Code:
click to view
protected void Bio::EnsEMBL::MetaData::DBSQL::BaseInfoAdaptor::_clear_cache ( ) [inherited]
  Arg	     : (optional) type of object to clear
  Description: Clear internal cache (optionally just one type)
  Returntype : none
  Exceptions : none
  Caller     : internal
  Status     : Stable
 
Code:
click to view
protected Bio::EnsEMBL::MetaData::DBSQL::DataReleaseInfoAdaptor::_fetch_children ( )

Undocumented method

Code:
click to view

Reimplemented from Bio::EnsEMBL::MetaData::DBSQL::BaseInfoAdaptor.

protected void Bio::EnsEMBL::MetaData::DBSQL::DataReleaseInfoAdaptor::_fetch_databases ( )
  Arg	     : Bio::EnsEMBL::MetaData::DataReleaseInfo 
  Description: Add databases to supplied object
  Returntype : none
  Exceptions : none
  Caller     : internal
  Status     : Stable
 
Code:
click to view
protected Arrayref Bio::EnsEMBL::MetaData::DBSQL::BaseInfoAdaptor::_fetch_generic ( ) [inherited]
  Arg	     : SQL to use to fetch object
  Arg	     : arrayref of bind parameters
  Arg        : (optional) if set to 1, all children will be fetched
  Description: Instantiate a GenomeInfo from the database using the specified SQL
  Returntype : Arrayref of Bio::EnsEMBL::MetaData::GenomeInfo
  Exceptions : none
  Caller     : internal
  Status     : Stable
 
Code:
click to view
protected Arrayref Bio::EnsEMBL::MetaData::DBSQL::BaseInfoAdaptor::_fetch_generic_with_args ( ) [inherited]
  Arg	     : hashref of arguments by column
  Arg        : (optional) if set to 1, all children will be fetched
  Description: Instantiate a GenomeInfo from the database using a 
               generic method, with the supplied arguments
  Returntype : Arrayref of Bio::EnsEMBL::MetaData::GenomeInfo
  Exceptions : none
  Caller     : internal
  Status     : Stable
 
Code:
click to view
protected Arrayref Bio::EnsEMBL::MetaData::DBSQL::BaseInfoAdaptor::_first_element ( ) [inherited]
  Arg	     : arrayref
  Description: Utility method to return the first element in a list, undef if empty
  Returntype : arrayref element
  Exceptions : none
  Caller     : internal
  Status     : Stable
 
Code:
click to view
protected Bio::EnsEMBL::MetaData::DBSQL::DataReleaseInfoAdaptor::_get_base_sql ( )

Undocumented method

Code:
click to view

Reimplemented from Bio::EnsEMBL::MetaData::DBSQL::BaseInfoAdaptor.

protected Object Bio::EnsEMBL::MetaData::DBSQL::BaseInfoAdaptor::_get_cached_obj ( ) [inherited]
  Arg	     : type of object to retrieve
  Arg	     : ID of object to retrieve
  Description: Retrieve object from internal cache
  Returntype : object
  Exceptions : none
  Caller     : internal
  Status     : Stable
 
Code:
click to view
protected void Bio::EnsEMBL::MetaData::DBSQL::BaseInfoAdaptor::_get_division_id ( ) [inherited]
  Arg	     : division name
  Description: Return ID for division, storing if required
  Returntype : none
  Exceptions : none
  Caller     : internal
  Status     : Stable
 
Code:
click to view
protected Bio::EnsEMBL::MetaData::DBSQL::DataReleaseInfoAdaptor::_get_id_field ( )

Undocumented method

Code:
click to view

Reimplemented from Bio::EnsEMBL::MetaData::DBSQL::BaseInfoAdaptor.

protected Bio::EnsEMBL::MetaData::DBSQL::DataReleaseInfoAdaptor::_get_obj_class ( )

Undocumented method

Code:
click to view

Reimplemented from Bio::EnsEMBL::MetaData::DBSQL::BaseInfoAdaptor.

protected void Bio::EnsEMBL::MetaData::DBSQL::BaseInfoAdaptor::_store_cached_obj ( ) [inherited]
  Arg	     : type of object to store
  Arg	     : object to store
  Description: Store object in internal cache
  Returntype : none
  Exceptions : none
  Caller     : internal
  Status     : Stable
 
Code:
click to view
protected void Bio::EnsEMBL::MetaData::DBSQL::DataReleaseInfoAdaptor::_store_databases ( )
  Arg	     : Bio::EnsEMBL::MetaData::DataReleaseInfo 
  Description: Store databases from supplied object
  Returntype : none
  Exceptions : none
  Caller     : internal
  Status     : Stable
 
Code:
click to view
public Bio::EnsEMBL::MetaData::DBSQL::BaseInfoAdaptor::fetch_all ( ) [inherited]

Undocumented method

Code:
click to view
public Bio::EnsEMBL::MetaData::GenomeInfo Bio::EnsEMBL::MetaData::DBSQL::BaseInfoAdaptor::fetch_by_dbID ( ) [inherited]
  Arg	     : ID of genome info
  Arg        : (optional) if 1, expand children of genome info
  Description: Fetch genome info for specified ID
  Returntype : Bio::EnsEMBL::MetaData::GenomeInfo
  Exceptions : none
  Caller     : internal
  Status     : Stable
 
Code:
click to view
public Bio::EnsEMBL::MetaData::GenomeInfo Bio::EnsEMBL::MetaData::DBSQL::BaseInfoAdaptor::fetch_by_dbIDs ( ) [inherited]
  Arg	     : IDs of genome info
  Arg        : (optional) if 1, expand children of genome info
  Description: Fetch genome info for specified ID
  Returntype : Bio::EnsEMBL::MetaData::GenomeInfo
  Exceptions : none
  Caller     : internal
  Status     : Stable
 
Code:
click to view
public Bio::EnsEMBL::MetaData::DataReleaseInfo Bio::EnsEMBL::MetaData::DBSQL::DataReleaseInfoAdaptor::fetch_by_ensembl_genomes_release ( )
  Arg        : String - Ensembl Genomes Release
  Description: Retrieve details for the specified Ensembl Genomes release
  Returntype : Bio::EnsEMBL::MetaData::DataReleaseInfo
  Exceptions : none
  Caller     : general
  Status     : Stable
 
Code:
click to view
public Bio::EnsEMBL::MetaData::DataReleaseInfo Bio::EnsEMBL::MetaData::DBSQL::DataReleaseInfoAdaptor::fetch_by_ensembl_release ( )
  Arg        : String - Ensembl Release
  Description: Retrieve details for the specified Ensembl release
  Returntype : Bio::EnsEMBL::MetaData::DataReleaseInfo
  Exceptions : none
  Caller     : general
  Status     : Stable
 
Code:
click to view
public Bio::EnsEMBL::MetaData::DataReleaseInfo Bio::EnsEMBL::MetaData::DBSQL::DataReleaseInfoAdaptor::fetch_current_ensembl_genomes_release ( )
  Description: Retrieve details for the current Ensembl Genomes release
  Returntype : Bio::EnsEMBL::MetaData::DataReleaseInfo
  Exceptions : none
  Caller     : general
  Status     : Stable
 
Code:
click to view
public Bio::EnsEMBL::MetaData::DataReleaseInfo Bio::EnsEMBL::MetaData::DBSQL::DataReleaseInfoAdaptor::fetch_current_ensembl_release ( )
  Description: Retrieve details for the current Ensembl release
  Returntype : Bio::EnsEMBL::MetaData::DataReleaseInfo
  Exceptions : none
  Caller     : general
  Status     : Stable
 
Code:
click to view
public Bio::EnsEMBL::MetaData::DBSQL::DataReleaseInfoAdaptor::fetch_databases ( )

Undocumented method

Code:
click to view
public Bio::EnsEMBL::MetaData::DBSQL::DataReleaseInfoAdaptor::store ( )

Undocumented method

Code:
click to view
public void Bio::EnsEMBL::MetaData::DBSQL::DataReleaseInfoAdaptor::update ( )
  Arg        : Bio::EnsEMBL::MetaData::DatabaseInfo
  Description: Update the supplied object (must be previously stored)
  Returntype : none
  Exceptions : none
  Caller     : general
  Status     : Stable
 
Code:
click to view

The documentation for this class was generated from the following file: