Toolbar

Summary

BioMart::Configuration::FilterCollection

Package variables

Inherit

BioMart::Root

Synopsis

Holds a List of BioMart::BaseFilter implementing objects.

Description

Object to further define the Filters available to the User Interface by
a Dataset. Holds a list of one or more BioMart::BaseFilter implementing
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      : usage
  Description: Description
  Returntype : string name
  Exceptions : none
  Caller     : caller

Methods code

sub _new {

  my ($self, @param) = @_;
  $self->SUPER::_new(@param);

  $self->addParams(TITLES, @param);
  $self->attr('filters', []);

}

sub addFilter {

  my ($self, $filter) = @_;

  $filter->filterCollection($self);
  my $filters = $self->get('filters');
  push @{$filters}, $filter;

}

sub description {

  # stores description
  my ($self, $value) = @_;
  if ($value){
    $self->setParam(DESCRIPTION, $value);
  }
  return $self->getParam(DESCRIPTION);

}

sub displayName {

  # stores display name
  my ($self, $value) = @_;
  if ($value){
    $self->setParam(DISPLAYNAME, $value);
  }
  return $self->getParam(DISPLAYNAME);

}

sub getAllFilters {

  my $self = shift;

  return $self->get('filters');

}

sub getFilterByName {

  my ($self, $name) = @_;

  my $retFilt;

  my $filtTs = $self->get('filters');
  foreach my $filtT (@{$filtTs}) {
    $retFilt = $filtT if ($filtT->name eq $name);
    last if ($retFilt);
  }

  return $retFilt;
}


1;

}

sub name {

  my ($self, $newName) = @_;

  if ($newName) {
    $self->setParam(NAMEKEY, $newName);
  }
  return $self->getParam(NAMEKEY);

}

General documentation

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