[Bio] / WebApplication / DataHandler.pm Repository:
ViewVC logotype

View of /WebApplication/DataHandler.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1 - (download) (as text) (annotate)
Fri Oct 26 19:56:07 2007 UTC (12 years ago) by paarmann
Branch: MAIN
CVS Tags: mgrast_dev_08112011, rast_rel_2009_05_18, mgrast_dev_08022011, rast_rel_2014_0912, rast_rel_2008_06_18, mgrast_dev_03052011, mobedac_release_05302012, mgrast_dev_05262011, rast_rel_2008_12_18, mgrast_dev_04082011, rast_rel_2008_07_21, rast_rel_2010_0928, rast_2008_0924, mgrast_version_3_2, mgrast_dev_12152011, rast_rel_2008_04_23, rast_rel_2008_06_16, mgrast_dev_06072011, rast_rel_2008_09_30, rast_rel_2009_0925, rast_rel_2010_0526, rast_rel_2014_0729, mgrast_dev_02212011, rast_rel_2010_1206, mgrast_release_3_0, mgrast_dev_03252011, rast_rel_2010_0118, mgrast_rel_2008_0924, mgrast_rel_2008_1110_v2, rast_rel_2009_02_05, rast_rel_2011_0119, mgrast_rel_2008_0625, mgrast_release_3_0_4, mgrast_release_3_0_2, mgrast_release_3_0_3, mgrast_release_3_0_1, mgrast_dev_03312011, mgrast_release_3_1_2, mgrast_release_3_1_1, mgrast_release_3_1_0, mgrast_dev_04132011, rast_rel_2008_10_09, mgrast_dev_04012011, rast_release_2008_09_29, mgrast_rel_2008_0806, mgrast_rel_2008_0923, mgrast_rel_2008_0919, rast_rel_2009_07_09, rast_rel_2010_0827, mgrast_rel_2008_1110, myrast_33, rast_rel_2011_0928, rast_rel_2008_09_29, mgrast_rel_2008_0917, rast_rel_2008_10_29, mgrast_dev_04052011, mgrast_dev_02222011, rast_rel_2009_03_26, mgrast_dev_10262011, rast_rel_2008_11_24, rast_rel_2008_08_07, HEAD
initial version of DataHandler

package DataHandler;

# DataHandler - abstract data handler used by the web application

# $Id: DataHandler.pm,v 1.1 2007/10/26 19:56:07 paarmann Exp $

use strict;
use warnings;


=pod

=head1 NAME

DataHandler - abstract data handler

=head1 DESCRIPTION

This module is the abstract DataHandler class used by the web application
framework. A data handler is a wrapper to retrieve a certain data source. 

Using a data handler is done by requesting the handle from the application.
Depending on the type of data this may be a PPO database or a FIG/FIGV
object.

=head1 METHODS

=over 4

=item * B<new> (I<application>)

Creates a new instance of the DataHandler object. The constructor requires
a reference to the web application object.

=cut

sub new {
    my ($class, $application) = @_;

    # check application
    unless (ref $application and $application->isa("WebApplication")) {
      die "Invalid application in __PACKAGE__ new.";
    }
    
    my $self = { 'application' => $application, 
	       };
    bless $self, $class;

    return $self;
}


=pod

=item * B<application> ()

Returns the reference to the application object

=cut

sub application {
  return $_[0]->{'application'};
}


=pod

=item * B<handle> ()

Returns the enclosed data handle

=cut

sub handle {
  die "Abstract method 'handle' must be implemented in __PACKAGE__.\n";
}



1;

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3