/ 
bioperl-1.2
/ Bio::Ontology::Relationship

NAME

Relationship - a relationship for an ontology

SYNOPSIS

$rel = Bio::Ontology::Relationship->new( -identifier        => "16847",
                                         -parent_term       => $parent,
                                         -child_term        => $child,
                                         -relationship_type => $type );

DESCRIPTION

This is a basic implementation of Bio::Ontology::RelationshipI.

FEEDBACK

Mailing Lists

User feedback is an integral part of the evolution of this and other Bioperl modules. Send your comments and suggestions preferably to the Bioperl mailing lists Your participation is much appreciated.

bioperl-l@bioperl.org                         - General discussion
http://bio.perl.org/MailList.html             - About the mailing lists

Reporting Bugs

report bugs to the Bioperl bug tracking system to help us keep track the bugs and their resolution. Bug reports can be submitted via email or the web:

bioperl-bugs@bio.perl.org
http://bio.perl.org/bioperl-bugs/

AUTHOR

Christian M. Zmasek

Email: czmasek@gnf.org or cmzmasek@yahoo.com

WWW: http://www.genetics.wustl.edu/eddy/people/zmasek/

Address:

Genomics Institute of the Novartis Research Foundation
10675 John Jay Hopkins Drive
San Diego, CA 92121

APPENDIX

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

new

Title   : new
Usage   : $rel = Bio::Ontology::Relationship->new( -identifier        => "16847",
                                                   -parent_term       => $parent,
                                                   -child_term        => $child,
                                                   -relationship_type => $type );                   
Function: Creates a new Bio::Ontology::Relationship.
Returns : A new Bio::Ontology::Relationship object.
Args    : -identifier            => the identifier of this relationship [scalar]
          -parent_term           => the parent term [Bio::Ontology::TermI]
          -child_term            => the child term [Bio::Ontology::TermI]  
          -relationship_type     => the relationship type [Bio::Ontology::TermI]

init

Title   : init()
Usage   : $rel->init();   
Function: Initializes this Relationship to all undef.
Returns : 
Args    :

identifier

Title   : identifier
Usage   : $rel->identifier( "100050" );
          or
          print $rel->identifier();
Function: Set/get for the identifier of this Relationship.
Returns : The identifier [scalar].
Args    : The identifier [scalar] (optional).

parent_term

Title   : parent_term
Usage   : $rel->parent_term( $parent );
          or
          $parent = $rel->parent_term();
Function: Set/get for the parent term of this Relationship.
Returns : The parent term [Bio::Ontology::TermI].
Args    : The parent term [Bio::Ontology::TermI] (optional).

child_term

Title   : child_term
Usage   : $rel->child_term( $child );
          or
          $child = $rel->child_term();
Function: Set/get for the child term of this Relationship.
Returns : The child term [Bio::Ontology::TermI].
Args    : The child term [Bio::Ontology::TermI] (optional).

relationship_type

Title   : relationship_type
Usage   : $rel->relationship_type( $type );
          or
          $type = $rel->relationship_type();
Function: Set/get for the relationship type of this relationship.
Returns : The relationship type [Bio::Ontology::TermI].
Args    : The relationship type [Bio::Ontology::TermI] (optional).

to_string

Title   : to_string()
Usage   : print $rel->to_string();
Function: to_string method for Relationship.
Returns : A string representation of this Relationship.
Args    :