BioMart::Configuration Option
SummaryIncluded librariesPackage variablesSynopsisDescriptionGeneral documentationMethods
Toolbar
WebCvsRaw content
Summary
BioMart::Configuration::Option
Package variables
No package variables defined.
Included modules
Digest::MD5
Inherit
BioMart::Root
Synopsis
Object responsible for Options
Description
Object responsible for Options contained within a BioMart::BaseFilter
implementing object. These Options can represent just simple distinct values
for a filter so a drop-down/radio button can be generated. They can also
contain a BioMart::BaseFilter implementing object themselves, in which case
the root Filter object is an empty container for a drop down list of
Filters
Methods
_hashCode
No description
Code
_init
No description
Code
_newDescriptionCode
_toSQL
No description
Code
addOptionDescriptionCode
addPushActionDescriptionCode
dataSetNameDescriptionCode
descriptionDescriptionCode
displayNameDescriptionCode
filterDescriptionCode
getAllOptionsDescriptionCode
getAllPushActionsDescriptionCode
nameDescriptionCode
operation
No description
Code
valueDescriptionCode
Methods description
_newcode    nextTop
  
Usage : no arguments
Description: creates a new Option object which can contain a single
Attribue object
Returntype : BioMart::Configuration::Option
Exceptions : none
Caller : general
addOptioncodeprevnextTop
  Usage      : usage
Description: Description
Returntype :
Exceptions : none
Caller : caller
addPushActioncodeprevnextTop
  Usage      : usage
Description: Description
Returntype :
Exceptions : none
Caller : caller
dataSetNamecodeprevnextTop
  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
descriptioncodeprevnextTop
  Usage      : Arg [1] - (optional) string $description
Description: get/set for description
Returntype : string
Exceptions : none
Caller : general
displayNamecodeprevnextTop
  Usage      : Arg [1] - (optional) string $display_name
Description: get/set for display name
Returntype : string
Exceptions : none
Caller : general
filtercodeprevnextTop
  Usage      : Arg[1] - (optional) BioMart::Configuration::BooleanFilter
or ValueFilter object
Description: get/set method for the Filter object for this Option
Returntype : BioMart::Configuration::BooleanFilter or ValueFilter object
Exceptions : none
Caller : caller
getAllOptionscodeprevnextTop
  Usage      : usage
Description: Description
Returntype :
Exceptions : none
Caller : caller
getAllPushActionscodeprevnextTop
  Usage      : usage
Description: Description
Returntype :
Exceptions : none
Caller : caller
namecodeprevnextTop
  Usage      : my $optionName = $option->name; $option->name($optionName);
Description: get/set for internal name
Returntype : scalar $name
Exceptions : none
Caller : general
valuecodeprevnextTop
  Usage      : Arg [1] - (optional) string $display_name
Description: get/set for value
Returntype : string
Exceptions : none
Caller : general
Methods code
_hashCodedescriptionprevnextTop
sub _hashCode {
  my $self = shift;
  my $digest = Digest::MD5->new;
  $digest->add($self->SUPER::_hashCode);
  $digest->add($self->filter()->hashCode);
  return $digest->hexdigest;
}

1;
}
_initdescriptionprevnextTop
sub _init {
  my ($self, @param) = @_;
  $self->SUPER::_init(@param);
  my $proto = shift @param;
  $self->attr('filter', $proto->filter);
  $self->attr('options', $proto->getAllOptions);
  $self->attr('pushActions', $proto->getAllPushActions);
}
_newdescriptionprevnextTop
sub _new {
  my ($self, @param) = @_;
  $self->SUPER::_new(@param);
  $self->addParams(TITLES, @param);
  $self->attr('filter',undef);
  $self->attr('options',[]);
  $self->attr('pushActions',[]);
  $self->attr('operation','');
}
_toSQLdescriptionprevnextTop
sub _toSQL {
  my $self = shift;
  my $filter = $self->filter();
  return $filter->toSQL();
}
addOptiondescriptionprevnextTop
sub addOption {
  my ($self, $option) = @_;
  my $options = $self->get('options');
  push @{$options}, $option;
}
addPushActiondescriptionprevnextTop
sub addPushAction {
  my ($self, $pa) = @_;
  my $pas = $self->get('pushActions');
  push @{$pas}, $pa;
}
dataSetNamedescriptionprevnextTop
sub dataSetName {
  # stores dataset name?
my ($self, $value) = @_; if ($value){ $self->setParam(DATASETNAME, $value); } return $self->getParam(DATASETNAME);
}
descriptiondescriptionprevnextTop
sub description {
  # stores description
my ($self, $value) = @_; if ($value){ $self->setParam(DESCRIPTION, $value); } return $self->getParam(DESCRIPTION);
}
displayNamedescriptionprevnextTop
sub displayName {
  # stores display name
my ($self, $value) = @_; if ($value){ $self->setParam(DISPLAYNAME, $value); } return $self->getParam(DISPLAYNAME);
}
filterdescriptionprevnextTop
sub filter {
# stores filter
my ($self, $filter) = @_; if ($filter){ $self->set('filter', $filter); } return $self->get('filter');
}
getAllOptionsdescriptionprevnextTop
sub getAllOptions {
  my $self = shift;
  return $self->get('options');
}
getAllPushActionsdescriptionprevnextTop
sub getAllPushActions {
  my $self = shift;
  return $self->get('pushActions');
}
namedescriptionprevnextTop
sub name {
  # stores internal name
my ($self, $value) = @_; if ($value){ $self->setParam(NAME, $value); } return $self->getParam(NAME);
}
operationdescriptionprevnextTop
sub operation {
  my ($self,$operation) = @_;
  if ($operation) {
    $self->set('operation',$operation);
  }
  return $self->get('operation');
}
valuedescriptionprevnextTop
sub value {
  # stores display name
my ($self, $value) = @_; if ($value){ $self->setParam(VALUE, $value); } return $self->getParam(VALUE);
}
General documentation
AUTHOR - Arek Kasprzyk, Syed Haider, Richard Holland, Damian SmedleyTop
CONTACTTop
This module is part of the BioMart project http://www.biomart.org
Questions can be posted to the mart-dev mailing list: mart-dev@ebi.ac.uk