BioMart::Configuration AttributeGroup
SummaryIncluded librariesPackage variablesSynopsisDescriptionGeneral documentationMethods
Toolbar
WebCvsRaw content
Summary
BioMart::Configuration::AttributeGroup
Package variables
No package variables defined.
Inherit
BioMart::Root
Synopsis
Holds a List of BioMart::AttributeCollection objects.
Description
Object to further define the Attributes available to the User Interface by
a Dataset. Holds a list of one or more BioMart::AttributeCollection objects.
Methods
_new
No description
Code
addCollectionDescriptionCode
descriptionDescriptionCode
displayNameDescriptionCode
getAllCollectionsDescriptionCode
getAttributeCollectionByNameDescriptionCode
maxSelectDescriptionCode
nameDescriptionCode
Methods description
addCollectioncode    nextTop
  Usage      : usage
  Description: Description
  Returntype : 
  Exceptions : none
  Caller     : caller
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
getAllCollectionscodeprevnextTop
  Usage      : usage
  Description: Description
  Returntype : 
  Exceptions : none
  Caller     : caller
getAttributeCollectionByNamecodeprevnextTop
  Usage      : my $ac = $ag->getAttributeCollectionByName($name);
  Description: Returns a BioMart::AttributeCollection object from this
               BioMart::AttributeGroup object, named by the given name.
               If no object exists in this tree named by the given name,
               this method returns undef.
  Returntype : BioMart::AttributeCollection or undef if none found with 
               given name.
  Exceptions : none
  Caller     : caller
maxSelectcodeprevnextTop
  Usage      : Arg [1] - (optional) string $max_select
  Description: get/set for max select
  Returntype : string
  Exceptions : none
  Caller     : general
namecodeprevnextTop
  Usage      : my $name = $att->name(); $att->name($newname);
  Description: sets/gets the name of the AttributeGroup
  Returntype : string name
  Exceptions : none
  Caller     : caller
Methods code
_newdescriptionprevnextTop
sub _new {
  my ($self, @param) = @_;
  $self->SUPER::_new(@param);

  $self->addParams(TITLES, @param);
  $self->attr('Cols', []);
}
addCollectiondescriptionprevnextTop
sub addCollection {
  my ($self, $col) = @_;

  my $cols = $self->get('Cols');
  push @{$cols}, $col;
}
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);
}
getAllCollectionsdescriptionprevnextTop
sub getAllCollections {
  my $self = shift;
  return $self->get('Cols');
}



1;
}
getAttributeCollectionByNamedescriptionprevnextTop
sub getAttributeCollectionByName {
  my ($self, $name) = @_;

  my $retCollection;

  my $attCs = $self->get('Cols');

  foreach my $attC (@{$attCs}) {
    if ($attC->name() eq $name) {
      $retCollection = $attC;
      last;
	}
  }

  return $retCollection;
}
maxSelectdescriptionprevnextTop
sub maxSelect {
  # stores max select
  my ($self, $value) = @_;
  if ($value){
    $self->setParam(MAXSELECT, $value);
  }
  return $self->getParam(MAXSELECT);
}
namedescriptionprevnextTop
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 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