Delete.pm

- NAME
- SYNOPSIS
- DESCRIPTION
- LICENSE
- FEEDBACK
- AUTHOR - Steve Mathias
- DETAILS
- Imported Packages
- Inheritance
- Public Methods

- deleteCluster
- deleteSubject
- deleteKindred
- deleteMarker
- deleteSNP
- deleteGenotype
- deleteStudyVariable
- deletePhenotype
- deleteFrequencySource
- deleteHtMarkerCollection
- deleteHaplotype
- deleteDNASample
- deleteTissueSample
- deleteMap

- Private methods

- _deleteObjectData

# NAME

Genetics::API::DB::Delete

# SYNOPSIS

      use Genetics::API ;

      $api = new Genetics::API(DSN => {driver => "mysql",
                                       host => $Host,
                                       database => $Database},
                               user => $UserName,
                               password => $Password) ;

      foreach $id (@badGenotypeIDs ) {
        $rv = $api->deleteGenotype($id) ;
        defined $rv or print "Error deleting Genotype w/ ID $id\n" ;
      }

# DESCRIPTION

The Genetics::API::DB packages provide an interface for the manipulation of GenPerl objects in a relational database. This package contains the methods for deleting objects from the database.

# LICENSE

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

# FEEDBACK

Currently, all feedback should be sent directly to the author.

# AUTHOR - Steve Mathias

Email: mathias@genomica.com

Phone: (720) 565-4029

Address: Genomica Corporation 1745 38th Street Boulder, CO 80301

# DETAILS

The rest of the documentation describes each of the object variables and methods. The names of internal variables and methods are preceded with an underscore (_).

# Imported Packages

     strict             Just to be anal
     vars               Global variables
     Carp               Error reporting

# Inheritance

     Exporter           Make methods available to importing packages

# Public Methods

## deleteCluster

      Function  : Delete a Genetics::Object::Cluster object from the database.
      Argument  : The id of the object to be deleted.
      Returns   : 1 on success, undef otherwise.
      Scope     : Public
      Comments  :

## deleteSubject

      Function  : Delete a Genetics::Object::Subject object from the database.
      Argument  : The id of the object to be deleted.
      Returns   : 1 on success, undef otherwise.
      Scope     : Public

## deleteKindred

      Function  : Delete a Genetics::Object::Kindred object from the database.
      Argument  : The id of the object to be deleted.
      Returns   : 1 on success, undef otherwise.
      Scope     : Public
      Comments  :

## deleteMarker

      Function  : Delete a Genetics::Object::Marker object from the database.
      Argument  : The id of the object to be deleted.
      Returns   : 1 on success, undef otherwise.
      Scope     : Public
      Comments  :

## deleteSNP

      Function  : Delete a Genetics::Object::SNP object from the database.
      Argument  : The id of the object to be deleted.
      Returns   : 1 on success, undef otherwise.
      Scope     : Public
      Comments  :

## deleteGenotype

      Function  : Delete a Genetics::Object::Genotype object from the database.
      Argument  : The id of the object to be deleted.
      Returns   : 1 on success, undef otherwise.
      Scope     : Public
      Comments  :

## deleteStudyVariable

      Function  : Delete a Genetics::Object::StudyVariable object from the database.
      Argument  : The id of the object to be deleted.
      Returns   : 1 on success, undef otherwise.
      Scope     : Public
      Comments  :

## deletePhenotype

      Function  : Delete a Genetics::Object::Phenotype object from the database.
      Argument  : The id of the object to be deleted.
      Returns   : 1 on success, undef otherwise.
      Scope     : Public
      Comments  :

## deleteFrequencySource

      Function  : Delete a Genetics::Object::FrequencySource object from the database.
      Argument  : The id of the object to be deleted.
      Returns   : 1 on success, undef otherwise.
      Scope     : Public
      Comments  :

## deleteHtMarkerCollection

      Function  : Delete a Genetics::Object::HtMarkerCollection object from the database.
      Argument  : The id of the object to be deleted.
      Returns   : 1 on success, undef otherwise.
      Scope     : Public
      Comments  :

## deleteHaplotype

      Function  : Delete a Genetics::Object::Haplotype object from the database.
      Argument  : The id of the object to be deleted.
      Returns   : 1 on success, undef otherwise.
      Scope     : Public
      Comments  :

## deleteDNASample

      Function  : Delete a Genetics::Object::DNASample object from the database.
      Argument  : The id of the object to be deleted.
      Returns   : 1 on success, undef otherwise.
      Scope     : Public
      Comments  :

## deleteTissueSample

      Function  : Delete a Genetics::Object::TissueSample object from the database.
      Argument  : The id of the object to be deleted.
      Returns   : 1 on success, undef otherwise.
      Scope     : Public
      Comments  :

## deleteMap

      Function  : Delete a Genetics::Object::Map object from the database.
      Argument  : The id of the object to be deleted.
      Returns   : 1 on success, undef otherwise.
      Scope     : Public
      Comments  :

# Private methods

## _deleteObjectData

      Function  : Delete data common to all Genetics::Object objects to the database.
      Argument  : A Genetics::Object ID.
      Returns   : 1 on success, undef otherwise.
      Scope     : Private
      Called by : The various deleteObjectSubClass methods.