#!/usr/bin/perl
package Coll_locus;

#####################################################################
# Author : Shuai Weng
# Date   : July 2001
# 
# See documentation for the usage details. 
#    
# http:///usr/local/dicty/www_dictybase/db/lib/html/dictyBase/programmer/Coll_locus.html
#
#####################################################################

use strict;
use DBI;
use Carp;
use vars qw (@ISA %allowedConstructors);
use dictyBase_Table;
@ISA = qw (dictyBase_Table); # base class

# Class Globals

# put column names in the hash below, that are able to uniquely
# specify a row in the table

%allowedConstructors = ('locus_no:colleague_no'=>undef);
       


####################################################################
sub DESTROY{
####################################################################
# nothing needs to be done 

}


####################################################################
1; #################################################################
####################################################################

=pod

=head1 Name

Coll_locus.pm

=head1 Description

This perl object (Coll_locus.pm) acts as container for Coll_locus info in oracle database. Once an object has been instantiated, several methods are available to retrieve the attributes of the object. 


=head1 Instantiating a New Coll_locus Object

To instantiate a new Coll_locus object, you may use following syntax: 

my $Obj = Coll_locus->new(dbh=>$dbh,
			  locus_no=>$locusNo,
			  colleague_no=>$collNo);


where $dbh is a valid database handle to either dictyBase or SDEV. All passed in values must be valid values for the columns that were provided, otherwise the script will die, with an appropriate error message.
 

=head1 getRow method

Usage:

my $row = $obj->getRow;

This method returns a tab-delimited row from coll_locus table.

=head1 Insert and delete Methods

You can also use 'Insert' class method and 'delete' instance method for inserting new row into database or deleting info for a specified row. 

See dictyBase_Table documentation for usage details :

Insert : http:///usr/local/dicty/www_dictybase/db/lib/staff/dictyBase/programmer/dictyBase_Table.html#Insert_Method

Delete : http:///usr/local/dicty/www_dictybase/db/lib/staff/dictyBase/programmer/dictyBase_Table.html#Delete_Method


=head1 Author

Shuai Weng

shuai@genome.stanford.edu

=cut