From 97a51fd4417ad4ce580d986fe8ab49df2bae8815 Mon Sep 17 00:00:00 2001
From: Arne Stabenau <stabenau@sanger.ac.uk>
Date: Mon, 18 Oct 2004 14:35:36 +0000
Subject: [PATCH] updated pods
---
modules/Bio/EnsEMBL/DBSQL/AffyArrayAdaptor.pm | 46 +++++++++++++++++++
1 file changed, 46 insertions(+)
diff --git a/modules/Bio/EnsEMBL/DBSQL/AffyArrayAdaptor.pm b/modules/Bio/EnsEMBL/DBSQL/AffyArrayAdaptor.pm
index ffd3e93360..a7920d5ab0 100644
--- a/modules/Bio/EnsEMBL/DBSQL/AffyArrayAdaptor.pm
+++ b/modules/Bio/EnsEMBL/DBSQL/AffyArrayAdaptor.pm
@@ -14,8 +14,16 @@ Bio::EnsEMBL::DBSQL::AffyArrayAdaptor
=head1 SYNOPSIS
+my $arrayAdaptor = $db->get_AffyArrayAdaptor();
+
+my $array = $arrayAdaptor->fetch_by_name( 'some name' );
+my $arrays = $arrayAdaptor->fetch_all();
+
+
=head1 DESCRIPTION
+The AffyArrayAdaptor module stores and retrieves AffyArray objects in the database it is connected to.
+
=head1 METHODS
=cut
@@ -31,6 +39,18 @@ use Bio::EnsEMBL::Utils::Exception qw(throw warning);
@ISA = qw(Bio::EnsEMBL::DBSQL::BaseAdaptor);
+=head2 fetch_by_name
+
+ Arg [1] : string $name
+ Example : my $array = $arrayAdaptor->fetch_by_name( 'U133_X3P' );
+ Description: Retrieves an AffyArray object by name from the database. Its created
+ from the entries in affy_array table
+ Returntype : string
+ Exceptions : none
+ Caller : general
+
+=cut
+
sub fetch_by_name {
my $self = shift;
my $name = shift;
@@ -44,6 +64,18 @@ sub fetch_by_name {
}
+=head2 fetch_attributes
+
+ Arg [1] : Bio::EnsEMBL::AffyArray $array
+ Example : none
+ Description: This function is soley intended to lazy load attributes into empty
+ AffyArray objects. You should not need to call this.
+ Returntype : none
+ Exceptions : none
+ Caller : lazy load Array attributes into empty array from AffyArray object
+
+=cut
+
sub fetch_attributes {
my $self = shift;
my $array = shift;
@@ -131,6 +163,20 @@ sub _objs_from_sth {
}
+=head2 store
+
+ Arg [1..] : list of Bio::EnsEMBL::AffyArray @arrays
+ Example : $arrayAdaptor->store( $array1, $array2, $array3 )
+ Description: Stores te given AffyArray objects in the database. There is no check wether
+ they already exist, so only call once per Array. Sets dbID and adaptor on the
+ objects that it stores.
+ Returntype : none
+ Exceptions : none
+ Caller : affy feature calculating scripts
+
+=cut
+
+
sub store {
my $self = shift;
my @args = @_;
--
GitLab