BioMart::Configuration
FilterGroup
Toolbar
Summary
BioMart::Configuration::FilterGroup
Package variables
No package variables defined.
Inherit
Synopsis
Holds a List of BioMart::FilterCollection objects.
Description
Object to further define the Filters available to the User Interface by
a Dataset. Holds a list of one or more BioMart::FilterCollection objects.
Methods
Methods description
Usage : usage Description: Description Returntype : Exceptions : none Caller : caller |
Usage : Arg [1] - (optional) string $description Description: get/set for description Returntype : string Exceptions : none Caller : general |
Usage : Arg [1] - (optional) string $display_name Description: get/set for display name Returntype : string Exceptions : none Caller : general |
Usage : usage Description: Description Returntype : Exceptions : none Caller : caller |
Usage : my $ac = $ag->getFilterCollectionByName($name); Description: Returns a BioMart::FilterCollection object from this BioMart::FilterGroup object, named by the given name. If no object exists in this tree named by the given name, this method returns undef. Returntype : BioMart::FilterCollection or undef if none found with given name. Exceptions : none Caller : caller |
Usage : my $name = $filt->name(); $filt->name($newname); Description: sets/gets the name of the FilterGroup Returntype : string name Exceptions : none Caller : caller |
Methods code
sub _new
{ my ($self, @param) = @_;
$self->SUPER::_new(@param);
$self->addParams(TITLES, @param);
$self->attr('Cols', []); } |
sub addCollection
{ my ($self, $col) = @_;
my $cols = $self->get('Cols');
push @{$cols}, $col; } |
sub description
{ my ($self, $value) = @_;
if ($value){
$self->setParam(DESCRIPTION, $value);
}
return $self->getParam(DESCRIPTION); } |
sub displayName
{ my ($self, $value) = @_;
if ($value){
$self->setParam(DISPLAYNAME, $value);
}
return $self->getParam(DISPLAYNAME); } |
sub getAllCollections
{ my $self = shift;
return $self->get('Cols'); } |
sub getFilterByName
{ my ($self, $name) = @_;
my $retFilt;
my $filtTs = $self->get('Cols');
foreach my $filtT (@{$filtTs}) {
$retFilt = $filtT->getFilterByName($name);
last if ($retFilt);
}
return $retFilt;
}
1; } |
sub getFilterCollectionByName
{ my ($self, $name) = @_;
my $retCollection;
my $attCs = $self->get('Cols');
foreach my $attC (@{$attCs}) {
if ($attC->name() eq $name) {
$retCollection = $attC;
last;
}
}
return $retCollection; } |
sub name
{ my ($self, $newName) = @_;
if ($newName) {
$self->setParam(NAMEKEY, $newName);
}
return $self->getParam(NAMEKEY); } |
General documentation
AUTHOR - Arek Kasprzyk, Syed Haider, Richard Holland, Darin London, Damian Smedley | Top |