Bio::EnsEMBL::MetaData::DataReleaseInfo Class Reference

Inheritance diagram for Bio::EnsEMBL::MetaData::DataReleaseInfo:

List of all members.

---

Class Summary

Synopsis

      my $release_info =
        Bio::EnsEMBL::MetaData::GenomeDataReleaseInfo->new(
                                   -ENSEMBL_VERSION=>83,
                                   -EG_VERSION=>30,
                                   -DATE=>'2015-12-07');

Description

Object encapsulating information about a particular release of Ensembl or Ensembl Genomes

See-also

Bio::EnsEMBL::MetaData::BaseInfo Bio::EnsEMBL::MetaData::DBSQLDataReleaseInfoAdaptor

Definition at line 28 of file DataReleaseInfo.pm.

Available Methods
protected void	_load_child ()
protected void	_preload ()
protected	_unload ()
public Bio::EnsEMBL::MetaData::DBSQL::GenomeInfoAdaptor	adaptor ()
public	add_database ()
public Int	count_hash_lengths ()
public	count_hash_values ()
public void	databases ()
public DbID	dbID ()
public String	ensembl_genomes_version ()
public	ensembl_version ()
public Int	is_current ()
public	new ()
public String	release_date ()
public Hashref	to_hash ()
public	to_string ()

---

Method Documentation

protected void Bio::EnsEMBL::MetaData::BaseInfo::_load_child

(

)

[inherited]

  Description: Lazy load method for loading children from database if not initialised
  Arg        : Key to find child data in object hash
  Arg        : Method for loading child data from adaptor()
  Returntype : none
  Exceptions : none
  Caller     : Internal
  Status     : Stable
 

Code:

protected void Bio::EnsEMBL::MetaData::BaseInfo::_preload

(

)

[inherited]

  Description: Ensure all children are loaded (used for hash transformation)
  Returntype : none
  Exceptions : none
  Caller     : Internal
  Status     : Stable
 

Code:

  Description: Remove all children (used after hash transformation to ensure object is minimised)
  Returntype : none
  Exceptions : none
  Caller     : dump_metadata.pl
  Status     : Stable
 

/**

Reimplemented in Bio::EnsEMBL::MetaData::GenomeAssemblyInfo, and Bio::EnsEMBL::MetaData::GenomeInfo.

protected Bio::EnsEMBL::MetaData::BaseInfo::_unload

(

)

[inherited]

Undocumented method

Code:

Reimplemented in Bio::EnsEMBL::MetaData::GenomeAssemblyInfo, and Bio::EnsEMBL::MetaData::GenomeInfo.

public Bio::EnsEMBL::MetaData::DBSQL::GenomeInfoAdaptor Bio::EnsEMBL::MetaData::BaseInfo::adaptor

(

)

[inherited]

  Arg        : (optional) adaptor to set set
  Description: Gets/sets GenomeInfoAdaptor
  Returntype : Bio::EnsEMBL::MetaData::DBSQL::GenomeInfoAdaptor
  Exceptions : none
  Caller     : Internal
  Status     : Stable
 

Code:

Reimplemented in Bio::EnsEMBL::MetaData::GenomeInfo.

public Bio::EnsEMBL::MetaData::DataReleaseInfo::add_database

(

)

Undocumented method

Code:

public Int Bio::EnsEMBL::MetaData::BaseInfo::count_hash_lengths

(

)

[inherited]

  Description: Sums sizes of arrays found in hash as values
  Arg		 : hashref
  Returntype : integer
  Exceptions : none
  Caller     : internal
  Status     : Stable
 

Code:

Reimplemented in Bio::EnsEMBL::MetaData::GenomeInfo.

public Bio::EnsEMBL::MetaData::BaseInfo::count_hash_values

(

)

[inherited]

Undocumented method

Code:

Reimplemented in Bio::EnsEMBL::MetaData::GenomeInfo.

public void Bio::EnsEMBL::MetaData::DataReleaseInfo::databases

(

)

  Arg        : (optional) Arrayref of DatabaseInfo objects
  Description: Databases associated with this release
  Returntype : None
  Exceptions : none
  Caller     : general
  Status     : Stable
 

Code:

public DbID Bio::EnsEMBL::MetaData::BaseInfo::dbID

(

)

[inherited]

  Arg        : (optional) dbID to set set
  Description: Gets/sets internal genome_id used as database primary key
  Returntype : dbID string
  Exceptions : none
  Caller     : Bio::EnsEMBL::MetaData::DBSQL::GenomeInfoAdaptor
  Status     : Stable
 

Code:

Reimplemented in Bio::EnsEMBL::MetaData::GenomeInfo.

public String Bio::EnsEMBL::MetaData::DataReleaseInfo::ensembl_genomes_version

(

)

  Arg        : (optional) version to set
  Description: Gets/sets name Ensembl version
  Returntype : string
  Exceptions : none
  Caller     : general
  Status     : Stable
 

Code:

public Bio::EnsEMBL::MetaData::DataReleaseInfo::ensembl_version

(

)

Undocumented method

Code:

public Int Bio::EnsEMBL::MetaData::DataReleaseInfo::is_current

(

)

  Arg        : (optional) Integer to set if current
  Description: Gets/sets if release is current
  Returntype : Integer (1 if current)
  Exceptions : none
  Caller     : general
  Status     : Stable
 

Code:

public Bio::EnsEMBL::MetaData::DataReleaseInfo::new

(

)

Undocumented method

Code:

Reimplemented from Bio::EnsEMBL::MetaData::BaseInfo.

public String Bio::EnsEMBL::MetaData::DataReleaseInfo::release_date

(

)

  Arg        : (optional) version to set
  Description: Gets/sets name Ensembl version
  Returntype : string
  Exceptions : none
  Caller     : general
  Status     : Stable
 

Code:

public String Bio::EnsEMBL::MetaData::DataReleaseInfo::to_hash

(

)

  Description: Render as plain hash suitable for export as JSON/XML
  Returntype : Hashref
  Exceptions : none
  Caller     : general
  Status     : Stable
 

Code:

  Description: Render as string for display
  Returntype : String
  Exceptions : none
  Caller     : general
  Status     : Stable
 

/**

Reimplemented from Bio::EnsEMBL::MetaData::BaseInfo.

public Bio::EnsEMBL::MetaData::DataReleaseInfo::to_string

(

)

Undocumented method

Code:

---

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

• Bio/EnsEMBL/MetaData/DataReleaseInfo.pm