BioMart::Configuration
PushAction
Toolbar
Summary
BioMart::Configuration::PushAction
Package variables
No package variables defined.
Included modules
Inherit
Synopsis
Object responsible for PushActions
Description
PushActions represent the values (BioMart::Configuration::Options) that are
placed onto another filter when a particular value
(BioMart::Configuration::Option) is chosen for a particular filter. The
driving filter contains Options which in turn contain one or more PushAction
objects. These PushActions contain the Options to place on the other filter
when chosen. An example of this is the chromosome name and band filters for
the gene datasets in ensembl (www.ensembl.org/biomart/martview). When a
particular option is chosen for the chromosome drop down the options available
in the band menus. The javascript driving this is populated using the Options
and PushActions contained within the chromosome Filter.
Methods
Methods description
Usage : no arguments
Description: creates a new PushAction object which can contain a single
Attribue object
Returntype : BioMart::Configuration::PushAction
Exceptions : none
Caller : general |
Usage : usage
Description: Description
Returntype :
Exceptions : none
Caller : caller |
Usage : my $subName = $option->dataSetName;
$option->dataSetName->($newName);
Description: get/set for the name of the dataSet which hosts this attribute.
Returntype : scalar $name
Exceptions : none
Caller : general |
Usage : usage
Description: Description
Returntype :
Exceptions : none
Caller : caller |
Usage : my $optionName = $option->name; $option->name($optionName);
Description: get/set for internal name
Returntype : scalar $name
Exceptions : none
Caller : general |
Usage : my $ref = $option->ref; $option->ref($ref);
Description: get/set for ref
Returntype : scalar $ref
Exceptions : none
Caller : general |
Methods code
sub _hashCode
{ my $self = shift;
my $digest = Digest::MD5->new;
$digest->add($self->SUPER::_hashCode);
return $digest->hexdigest;
}
1; } | sub _init
{ my ($self, @param) = @_;
$self->SUPER::_init(@param);
my $proto = shift @param;
$self->attr('options', $proto->getAllPushActions);} | sub _new
{ my ($self, @param) = @_;
$self->SUPER::_new(@param);
$self->addParams(TITLES, @param);
$self->attr('options',[]);} | sub addOption
{ my ($self, $option) = @_;
my $options = $self->get('options');
push @{$options}, $option;} | sub dataSetName
{
my ($self, $value) = @_;
if ($value){
$self->setParam(DATASETNAME, $value);
}
return $self->getParam(DATASETNAME); } | sub getAllOptions
{ my $self = shift;
return $self->get('options');} | sub name
{
my ($self, $value) = @_;
if ($value){
$self->setParam(NAME, $value);
}
return $self->getParam(NAME); } | sub ref
{
my ($self, $value) = @_;
if ($value){
$self->setParam(REF, $value);
}
return $self->getParam(REF); } | General documentation
| AUTHOR - Arek Kasprzyk, Syed Haider, Damian Smedley | Top |