GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  BIO::SEARCHIO::SEARCHWRITERI (3)

.ds Aq ’

NAME

Bio::SearchIO::SearchWriterI - Interface for outputting parsed Search results

CONTENTS

SYNOPSIS

Bio::SearchIO::SearchWriterI objects cannot be instantiated since this module defines a pure interface.

Given an object that implements the Bio::SearchIO::SearchWriterI interface, you can do the following things with it:



    print $writer->to_string( $result_obj, @args );



DESCRIPTION

This module defines abstract methods that all subclasses must implement to be used for outputting results from Bio::Search::Result::ResultI objects.

AUTHOR

Steve Chervitz <sac-at-bioperl.org>

DISCLAIMER

This software is provided as is without warranty of any kind.

APPENDIX

The rest of the documentation details each of the object methods.

    to_string



 Purpose   : Produces data for each Search::Result::ResultI in a string.
           : This is an abstract method. For some useful implementations,
           : see ResultTableWriter.pm, HitTableWriter.pm,
           : and HSPTableWriter.pm.
 Usage     : print $writer->to_string( $result_obj, @args );
 Argument  : $result_obj = A Bio::Search::Result::ResultI object
           : @args = any additional arguments used by your implementation.
 Returns   : String containing data for each search Result or any of its
           : sub-objects (Hits and HSPs).
 Throws    : n/a



    start_report



 Title   : start_report
 Usage   : $self->start_report()
 Function: The method to call when starting a report. You can override it
           to make a custom header
 Returns : string
 Args    : none



    end_report



 Title   : end_report
 Usage   : $self->end_report()
 Function: The method to call when ending a report, this is
           mostly for cleanup for formats which require you to
           have something at the end of the document (</BODY></HTML>)
           for HTML
 Returns : string
 Args    : none



    filter



 Title   : filter
 Usage   : $writer->filter(hsp, \&hsp_filter);
 Function: Filter out either at HSP,Hit,or Result level
 Returns : none
 Args    : string => data type,
           CODE reference



Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 BIO::SEARCHIO::SEARCHWRITERI (3) 2016-04-05

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.