David Burdick > Bio-ConnectDots > Bio::ConnectDots::Connector

Download:
ConnectDots/Bio-ConnectDots-1.0.2.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Source  

NAME ^

Bio::ConnectDots::Connector -- one connection entry for 'connect-the-dots'

SYNOPSIS ^

  use Bio::ConnectDots::Connector;
  my $locuslink = ...;          # set to LocusLink connector somehow
  my $connector = new Bio::ConnectDots::Connector;
  $connector->dots({LocusID=>$locus_dot,UniGeneID=>$unigene_dot,...});  
  $locuslink->put($connector);  # add to LocusLink connector object

DESCRIPTION ^

This class connects multiple objects (called 'Dots') based on information in a data source.

KNOWN BUGS AND CAVEATS ^

This is still a work in progress. This documentation is out of date. In any case, this class is no longer used in normal processing

Bugs, Caveats, and ToDos

  TBD

AUTHOR - David Burdick, Nat Goodman ^

Email dburdick@systemsbiology.org, natg@shore.net

COPYRIGHT ^

Copyright (c) 2005 Institute for Systems Biology (ISB). All Rights Reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

APPENDIX ^

The rest of the documentation describes the methods.

Constructors

 Title   : new
 Usage   : my $connector = new Bio::ConnectDots::Connector;
 Function: Create empty connector object
 Returns : Bio::ConnectDots::Connector object

Simple attributes

These are methods for getting and setting the values of simple attributes. Each of these can be set in the argument list to new, if desired. Some of these should be read-only (more precisely, should only be written by code internal to the obkect), but this is not enforced. We assume, Perl-style, that programmers will behave nicely and not complain too loudly if the software lets them do something stupid.

Methods have the same name as the attribute. To get the value of attribute xxx, just say $xxx=$object->xxx; To set it, say $object->xxx($new_value); To clear it, say $object->xxx(undef);

 Attr    : dots
 Function: Hash ref of connected objects. The keys are the Dot names
 Access  : read-write

Retrieving Dots (ie, objects connected by the connector)

 Title   : get_dot
 Usage   : my $connector=$locuslink->get_next;
           my $locusid=$connector->get_dot('LocusID');
           my @locusid=$connector->get_dot('LocusID');
 Args    : Name of Dot (ie, connected object) to retrieve
 Returns : In a scalar context: 
             Returns the connected dot, if there's only one of the given type
             If there are multiple connected dots, returns an arbitray one
           In a list context, returns a list of the connected dots of the 
           given type.

 Title   : get_dots
 Usage   : my $connector=$locuslink->get_next;
           my $aliases=$connector->get_dots('Alias');
           my @aliases=$connector->get_dots('Alias');
 Args    : Type of Dot (ie, connected object) to retrieve
           These can be names or objects
 Returns : In a scalar context, returns a list ref of the connected dots 
           of the given type.
           In a list context, returns a list of the connected dots of the 
           given type.
syntax highlighting: