BioMart::Configuration
FilterTree
Toolbar
Summary
BioMart::Configuration::FilterTree
Package variables
No package variables defined.
Inherit
Synopsis
Holds a List of BioMart::FilterGroup objects.
Description
Object to further define the Filters available to the User Interface by
a Dataset. Holds a list of one or more BioMart::FilterGroup objects.
Methods
Methods description
Usage : $filt->addFilterGroup($fg); Description: adds a FilterGroup to this FilterTree. The order of addition of each FilterGroup is maintained. Returntype : na 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 : my $groups = $filt->getAllFilterGroups; foreach my $group (@{$groups}) { ... } Description : Returns a list_ref of all FilterGroups held in this FilterTree. Returntype : list_ref of BioMart::FilterGroup objects Exceptions : none Caller : caller |
Usage : my $filt = $filt->getFilterByName($name); Description : Get a specific BioMart::Filter object named by $name. May return undef if no object is contained within this FilterTree with the given name. Returntype : BioMart::Filter or undef if none found with given name Exceptions : none Caller : caller |
Usage : my $fg = $filt->getFilterGroupByName($name); Description: Returns a BioMart::FilterGroup object from this BioMart::FilterTree object, named by the given name. If no object exists in this tree named by the given name, this method returns undef. Returntype : BioMart::FilterGroup or undef if none found with given name. Exceptions : none Caller : caller |
Usage : my $option = $filtT->getOptionByName($name); Description : Get a specific BioMart::Option object named by $name. May return undef if no object is contained within this FilterTree with the given name. Returntype : BioMart::Option or undef if none found with given name Exceptions : none Caller : caller |
Usage : Arg [1] - (optional) string $hideDisplay Description: get/set for hideDisplay toggle Returntype : string Exceptions : none Caller : general |
Usage : my $name = $filt->name(); $filt->name($newname); Description: sets/gets the name of the FilterTree Returntype : string name Exceptions : none Caller : caller |
Methods code
sub _new
{ my ($self, @param) = @_;
$self->SUPER::_new(@param);
$self->addParams(TITLES, @param);
$self->attr('filtGs', []); } |
sub addFilterGroup
{ my ($self, $filtGroup) = @_;
my $filtGs = $self->get('filtGs');
push @{$filtGs}, $filtGroup; } |
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 getAllFilterGroups
{ my $self = shift;
return $self->get('filtGs'); } |
sub getFilterByName
{ my ($self, $name) = @_;
my $retFilt;
my $filtGs = $self->get('filtGs');
GROUP: foreach my $filtG (@{$filtGs}) {
my $filtColls = $filtG->getAllCollections;
foreach my $filtCol (@{$filtColls}) {
my $filts = $filtCol->getAllFilters;
foreach my $filt (@{$filts}) {
if ($filt->name eq $name) {
$retFilt = $filt;
last GROUP;
}
}
}
}
return $retFilt; } |
sub getFilterGroupByName
{ my ($self, $name) = @_;
my $retGroup;
my $filtGs = $self->get('filtGs');
foreach my $filtG (@{$filtGs}) {
if ($filtG->name() eq $name) {
$retGroup = $filtG;
last;
}
}
return $retGroup; } |
sub getOptionByName
{ my ($self, $name) = @_;
my $retOption;
my $filtGs = $self->get('filtGs');
GROUP: foreach my $filtG (@{$filtGs}) {
my $filtColls = $filtG->getAllCollections;
foreach my $filtCol (@{$filtColls}) {
my $filts = $filtCol->getAllFilters;
foreach my $filt (@{$filts}) {
my $ops = $filt->getAllOptions;
foreach my $op (@{$ops}) {
if ($op->name eq $name) {
$retOption = $op;
last GROUP;
}
}
}
}
}
return $retOption;
}
1; } |
sub hideDisplay
{ my ($self, $value) = @_;
if ($value){
$self->setParam(HIDEDISPLAY, $value);
}
return $self->getParam(HIDEDISPLAY); } |
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 |