/ 
bioperl-1.0.2
/ Bio::Annotation::DBLink

NAME

Bio::Annotation::DBLink - DESCRIPTION of Object

SYNOPSIS

   $link1 = new Bio::Annotation::DBLink(-database => 'TSC',
                                        -primary_id => 'TSC0000030'
					);

   #or 

   $link2 = new Bio::Annotation::DBLink();
   $link2->database('dbSNP');
   $link2->primary_id('2367');

   # $feat is Bio::Annotation object, Bio::SeqFeature::Generic inherits it
   $feat->add_DBLink($link2);

DESCRIPTION

Provides an object which represents a link from one onbject to something in another database without proscribing what is in the other database

AUTHOR - Ewan Birney

Ewan Birney - birney@ebi.ac.uk

APPENDIX

The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _

AnnotationI implementing functions

as_text

Title   : as_text
Usage   :
Function:
Example :
Returns : 
Args    :

hash_tree

Title   : hash_tree
Usage   :
Function:
Example :
Returns : 
Args    :

database

Title   : database
Usage   : $self->database($newval)
Function: set/get on the database string. Databases are just
          a string here which can then be interpretted elsewhere
Example : 
Returns : value of database
Args    : newvalue (optional)

primary_id

Title   : primary_id
Usage   : $self->primary_id($newval)
Function: set/get on the primary id (a string)
          The primary id is the main identifier used for this object in 
          the database. Good examples would be accession numbers. The id
          is meant to be the main, stable identifier for this object
Example : 
Returns : value of primary_id
Args    : newvalue (optional)

optional_id

Title   : optional_id
Usage   : $self->optional_id($newval)
Function: get/set for the optional_id (a string)
          optional id is a slot for people to use as they wish. The main
          issue is that some databases do not have a clean single string
          identifier scheme. It is hoped that the primary_id can behave like
          a reasonably sane "single string identifier" of objects, and people
          can use/abuse optional ids to their heart's content to provide
          precise mappings. 
Example : 
Returns : value of optional_id
Args    : newvalue (optional)

comment

Title   : comment
Usage   : $self->comment($newval)
Function: get/set of comments (comment object)
          Sets or gets comments of this dblink, which is sometimes relevant
Example : 
Returns : value of comment (Bio::Annotation::Comment)
Args    : newvalue (optional)