Bio::Graphics ConfiguratorI
SummaryIncluded librariesPackage variablesSynopsisDescriptionGeneral documentationMethods
Summary
Bio::Graphics::ConfiguratorI - A sectioned map of configuration
options (a map of maps), with a default section. Intended to augment
existing tag->value semantics (ie. of Bio::AnnotationCollectionI) for
object-representation information (eg. foreground color), and for
general interface preferences (eg. image width in gbrowse).
Package variables
No package variables defined.
Included modules
Bio::Root::RootI
Carp
Inherit
Bio::Root::RootI
Synopsis
    # get a ConfiguratorI somehow
    my $fg_color = $configurator->get('fgcolor');
Description
This object contains various configuration parameters. It is divided
up into sections and tags. This is essentially a multi-level map
(section->tag->value). There is also the concept of a default
section which is referenced when no section is passed to the
ConfiguratorI methods.
Methods
get_sectionsDescriptionCode
get_tagsDescriptionCode
getDescriptionCode
setDescriptionCode
get_and_evalDescriptionCode
Methods description
get_sectionscode    nextTop
 Title   : get_sections
 Usage   : my @values = $configurator->get_sections();
 Function: Returns a list of the valid sections except
           the default or undef.
 Returns : A list of the sections which can be queried.
 Args    : (optional section as string, tag as string)
get_tagscodeprevnextTop
 Title   : get_tags
 Usage   : my @values = $configurator->get_tags();
           or
           my @values = $configurator->get_tags('dna');
 Function: Returns a list of tags for a given section
           or only the default tags section if no section
           is given.
 Returns : A scalar list of tags
 Args    :
getcodeprevnextTop
 Title   : get
 Usage   : my $value = $configurator->get('height');
           or
           my $value = $configurator->get('dna','height');
 Function: Returns a tag value from a configurator from the
           either the default "_general" section or from
           a specified section or undef.
 Returns : A scalar value for the tag
 Args    : (optional section as string, tag as string)
setcodeprevnextTop
 Title   : set
 Usage   : $configurator->set('fgcolor','chartreuse');
           or
           $configurator->set('EST','fgcolor','chartreuse');
 Function: Set a value for a tag
 Returns : The old value of the tag
 Args    : (optional section as string, tag as string, value as scalar)
get_and_evalcodeprevnextTop
 Title   : get_and_eval
 Usage   : my $value = $configurator->get_and_eval('height');
           or
           my $value = $configurator->get_and_eval('dna','height');
 Function: This works like get() except that it is
           also able to evaluate code references.  These are
           options whose values begin with the characters
           "sub {".  In this case the value will be passed to
           an eval() and the resulting codereference returned.
 Returns : A value of the tag or undef.
 Args    : (optional section as string, tag as string)
Methods code
get_sectionsdescriptionprevnextTop
sub get_sections {
   my ($self) = @_;
   $self->throw_not_implemented();
}
get_tagsdescriptionprevnextTop
sub get_tags {
   my ($self) = @_;
   $self->throw_not_implemented();
}
getdescriptionprevnextTop
sub get {
   my ($self) = @_;
   $self->throw_not_implemented();
}
setdescriptionprevnextTop
sub set {
   my ($self) = @_;
   $self->throw_not_implemented();
}
get_and_evaldescriptionprevnextTop
sub get_and_eval {
   my ($self) = @_;
   $self->throw_not_implemented();
}
General documentation
FEEDBACKTop
Mailing ListsTop
User feedback is an integral part of the evolution of this and other
Bioperl modules. Send your comments and suggestions preferably to
the Bioperl mailing list. Your participation is much appreciated.
  bioperl-l@bioperl.org            - General discussion
http://bioperl.org/MailList.shtml  - About the mailing lists
Reporting BugsTop
Report bugs to the Bioperl bug tracking system to help us keep track
of the bugs and their resolution. Bug reports can be submitted via
email or the web:
  bioperl-bugs@bioperl.org
  http://bugzilla.bioperl.org/
AUTHOR - Robert HubleyTop
Email rhubley@systemsbiology.org
CONTRIBUTORSTop
Paul Edlefsen, pedlefsen@systemsbiology.org
Lincoln Stein, lstein@cshl.org
Heikki Lehvaslaiho, heikki@ebi.ac.uk
APPENDIXTop
The rest of the documentation details each of the object methods.
Internal methods are usually preceded with a _