Archive Ensembl HomeArchive Ensembl Home
Bio::EnsEMBL::Utils::IO::Serializer Class Reference
Inheritance diagram for Bio::EnsEMBL::Utils::IO::Serializer:

List of all members.


Class Summary

Synopsis

my $serializer = new Serializer( $filehandle );
$serializer-\>print_feature_list( \@list_of_features );

Description

Subclass this class to create a format-specific serializer.
Be sure to implement print_feature at the bare minimum
 

Definition at line 20 of file Serializer.pm.

Available Methods

public DESTROY ()
public void formatted_write ()
public
Bio::EnsEMBL::Utils::IO::Serializer 
new ()
public void print_main_header ()
public print_metadata ()
public print_sequence ()
public Boolean printed_something ()

Method Documentation

public Bio::EnsEMBL::Utils::IO::Serializer::DESTROY ( )
	Destructor
	Description: Restores default state of the STDOUT filehandle as it is a copy
	             and may not flush correctly.
 
Code:
click to view
public void Bio::EnsEMBL::Utils::IO::Serializer::formatted_write ( )
   Arg [1]    : Line format, see Perldoc of formline()
   Arg [2]    : Array of arguments to suit the line format in Arg [1]
   Description: Writes data to the filehandle and rigidly formats it.
                Refer to Perldoc on formline() to specify valid formats.
                Useful for fixed-width file formats.
                Suicides in the event of file system issues.
   Example    : my $FORMAT = '^<<<<<<<<<<<<<<<<<<<|<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<\n';
                $serializer->formatted_write($FORMAT,@text_fields);
   Returntype : None
 
Code:
click to view
public Bio::EnsEMBL::Utils::IO::Serializer Bio::EnsEMBL::Utils::IO::Serializer::new ( )
	Constructor
	Arg [1]    : Optional File handle
	Returntype : Bio::EnsEMBL::Utils::IO::Serializer
 
Code:
click to view

Reimplemented in Bio::EnsEMBL::Utils::IO::FASTASerializer, and Bio::EnsEMBL::Utils::IO::GFFSerializer.

public void Bio::EnsEMBL::Utils::IO::Serializer::print_main_header ( )
	Arg [1]    : Data for header, depends on serializer
	Description: Printing the header text or metadata required for this file format,
	             Re-implement in the serializer.
	Returntype : None
 
Code:
click to view

Reimplemented in Bio::EnsEMBL::Utils::IO::GFFSerializer, and Bio::EnsEMBL::Utils::IO::ReportSerializer.

public Bio::EnsEMBL::Utils::IO::Serializer::print_metadata ( )
	
	Arg [1]    : String
	Description: Pipes a custom string into the filehandle that the serializer is using
 
Code:
click to view

Reimplemented in Bio::EnsEMBL::Utils::IO::FASTASerializer, and Bio::EnsEMBL::Utils::IO::GFFSerializer.

public Bio::EnsEMBL::Utils::IO::Serializer::print_sequence ( )
	Arg [1]    : Bio::EnsEMBL::Slice
	Description: By default, prints a block of FASTA format sequence from the given slice

Deprecated:
Code:
click to view
public Boolean Bio::EnsEMBL::Utils::IO::Serializer::printed_something ( )
    Description: Check if serializer has printed any useful data. Not accurate with FASTA
                 due to non-reporting dumper.
    Returntype : Boolean
 
Code:
click to view

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