Bio::EnsEMBL::MetaData::MetaDataDumper::TT2MetaDataDumper Class Reference
Inheritance diagram for Bio::EnsEMBL::MetaData::MetaDataDumper::TT2MetaDataDumper:

List of all members.


Class Summary

Synopsis

Description

Implementation to dump metadata details to a TemplateToolKit file.
See Bio::EnsEMBL::MetaData::MetaDataDumper for method details.

See-also

Bio::EnsEMBL::MetaData::MetaDataDumper

Definition at line 21 of file TT2MetaDataDumper.pm.

Available Methods

protected void _write_metadata_to_file ()
public do_dump ()
public void dump_metadata ()
public void end ()
public logger ()
public Hashref metadata_to_hash ()
public new ()
public void start ()
public void write_metadata ()
public String yesno ()

Method Documentation

protected void Bio::EnsEMBL::MetaData::MetaDataDumper::_write_metadata_to_file ( ) [inherited]
  Arg        : Arrayref of Bio::EnsEMBL::MetaData::GenomeInfo
  Arg        : File handle to write to
  Description: Stub for writing to a file - implement in subclasses
  Returntype : none
  Exceptions : none
  Caller     : internal
  Status     : Stable
 
Code:
click to view

Reimplemented in Bio::EnsEMBL::MetaData::MetaDataDumper::JsonMetaDataDumper, Bio::EnsEMBL::MetaData::MetaDataDumper::TextMetaDataDumper, Bio::EnsEMBL::MetaData::MetaDataDumper::UniProtReportDumper, and Bio::EnsEMBL::MetaData::MetaDataDumper::XMLMetaDataDumper.

public Bio::EnsEMBL::MetaData::MetaDataDumper::TT2MetaDataDumper::do_dump ( )

Undocumented method

Code:
click to view
public void Bio::EnsEMBL::MetaData::MetaDataDumper::dump_metadata ( ) [inherited]
  Description: Write supplied metadata to file
  Arg        : Arrayref of Bio::EnsEMBL::MetaData::GenomeInfo
  Arg        : File to write to
  Arg        : Arrayref of divisions
  Arg        : Whether to dump to "all" file
  Returntype : none
  Exceptions : none
  Caller     : general
  Status     : Stable
 
Code:
click to view
public void Bio::EnsEMBL::MetaData::MetaDataDumper::end ( ) [inherited]
  Description: Stop writing to output file(s) and close handles
  Returntype : none
  Exceptions : none
  Caller     : internal
  Status     : Stable
 
Code:
click to view

Reimplemented in Bio::EnsEMBL::MetaData::MetaDataDumper::JsonMetaDataDumper, and Bio::EnsEMBL::MetaData::MetaDataDumper::XMLMetaDataDumper.

public Bio::EnsEMBL::MetaData::MetaDataDumper::logger ( ) [inherited]

Undocumented method

Code:
click to view
public Hashref Bio::EnsEMBL::MetaData::MetaDataDumper::metadata_to_hash ( ) [inherited]
  Description: Turn metadata into hash
  Arg        : Arrayref of Bio::EnsEMBL::MetaData::GenomeInfo
  Returntype : Hashref
  Exceptions : none
  Caller     : internal
  Status     : Stable
 
Code:
click to view
public Bio::EnsEMBL::MetaData::MetaDataDumper::TT2MetaDataDumper::new ( )

Undocumented method

Code:
click to view

Reimplemented from Bio::EnsEMBL::MetaData::MetaDataDumper.

public void Bio::EnsEMBL::MetaData::MetaDataDumper::start ( ) [inherited]
  Description: Start writing to output file(s)
  Arg        : Arrayref of strings representing divisions to dump
  Arg        : Basename of file to write to
  Arg        : Whether to dump to "all" file
  Returntype : none
  Exceptions : none
  Caller     : internal
  Status     : Stable
 
Code:
click to view

Reimplemented in Bio::EnsEMBL::MetaData::MetaDataDumper::JsonMetaDataDumper, Bio::EnsEMBL::MetaData::MetaDataDumper::TextMetaDataDumper, Bio::EnsEMBL::MetaData::MetaDataDumper::UniProtReportDumper, and Bio::EnsEMBL::MetaData::MetaDataDumper::XMLMetaDataDumper.

public void Bio::EnsEMBL::MetaData::MetaDataDumper::write_metadata ( ) [inherited]
  Arg        : Arrayref of Bio::EnsEMBL::MetaData::GenomeInfo
  Arg        : Division to write to
  Description: Write metadata to division files
  Returntype : none
  Exceptions : none
  Caller     : general
  Status     : Stable
 
Code:
click to view
public String Bio::EnsEMBL::MetaData::MetaDataDumper::yesno ( ) [inherited]
  Description: Turn defined/integer into Y/N
  Arg        : Integer 1/0
  Returntype : String
  Exceptions : none
  Caller     : internal
  Status     : Stable
 
Code:
click to view

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