Carnë Draug > Bio-Biblio-1.70 > Bio::Biblio::BiblioBase

Download:
Bio-Biblio-1.70.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 1.70   Source  

NAME ^

Bio::Biblio::BiblioBase - an abstract base for other biblio classes

VERSION ^

version 1.70

SYNOPSIS ^

 # do not instantiate this class directly

DESCRIPTION ^

It is a base class where all other biblio data storage classes inherit from. It does not reflect any real-world object, it exists only for convenience, in order to have a place for shared code.

Accessors

All attribute names can be used as method names. When used without any parameter the method returns current value of the attribute (or undef), when used with a value the method sets the attribute to this value and also returns it back. The set method also checks if the type of the new value is correct.

Custom classes

If there is a need for new attributes, create your own class which usually inherits from Bio::Biblio::Ref. For new types of providers and journals, let your class inherit directly from this Bio::Biblio::BiblioBase class.

METHODS ^

new

The new() class method constructs a new biblio storage object. It accepts list of named arguments - the same names as attribute names prefixed with a minus sign. Available attribute names are listed in the documentation of the individual biblio storage objects.

INTERNAL METHODS ^

_accessible

This method should not be called here; it should be implemented by a subclass

_attr_type

This method should not be called here; it should be implemented by a subclass

AUTOLOAD

Deal with 'set_' and 'get_' methods

_wrong_type_msg

Set methods test whether incoming value is of a correct type; here we return message explaining it

print_me

Probably just for debugging TBD: to decide...

FEEDBACK ^

Mailing lists

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/wiki/Mailing_lists  - About the mailing lists

Support

Please direct usage questions or support issues to the mailing list: bioperl-l@bioperl.org

rather than to the module maintainer directly. Many experienced and reponsive experts will be able look at the problem and quickly address it. Please include a thorough description of the problem with code and data examples if at all possible.

Reporting bugs

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 the web:

  https://redmine.open-bio.org/projects/bioperl/

LEGAL ^

Authors

Martin Senger <senger@ebi.ac.uk>

Copyright and License

This software is Copyright (c) by 2002 European Bioinformatics Institute and released under the license of the same terms as the perl 5 programming language system itself

syntax highlighting: