.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Bio::Biblio::BiblioBase 3pm"
.TH Bio::Biblio::BiblioBase 3pm "2023-02-14" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Bio::Biblio::BiblioBase \- an abstract base for other biblio classes
.SH "VERSION"
.IX Header "VERSION"
version 1.70
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& # do not instantiate this class directly
.Ve
.SH "DESCRIPTION"
.IX Header "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.
.SS "Accessors"
.IX Subsection "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.
.SS "Custom classes"
.IX Subsection "Custom classes"
If there is a need for new attributes, create your own class which
usually inherits from \fIBio::Biblio::Ref\fR. For new types of providers
and journals, let your class inherit directly from this
\&\fIBio::Biblio::BiblioBase\fR class.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
The \fI\f(BInew()\fI\fR 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.
.SH "INTERNAL METHODS"
.IX Header "INTERNAL METHODS"
.SS "_accessible"
.IX Subsection "_accessible"
This method should not be called here; it should be implemented by a subclass
.SS "_attr_type"
.IX Subsection "_attr_type"
This method should not be called here; it should be implemented by a subclass
.SS "\s-1AUTOLOAD\s0"
.IX Subsection "AUTOLOAD"
Deal with 'set_' and 'get_' methods
.SS "_wrong_type_msg"
.IX Subsection "_wrong_type_msg"
Set methods test whether incoming value is of a correct type;
here we return message explaining it
.SS "print_me"
.IX Subsection "print_me"
Probably just for debugging
\&\s-1TBD:\s0 to decide...
.SH "FEEDBACK"
.IX Header "FEEDBACK"
.SS "Mailing lists"
.IX Subsection "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.
.PP
.Vb 2
\&  bioperl\-l@bioperl.org                  \- General discussion
\&  http://bioperl.org/wiki/Mailing_lists  \- About the mailing lists
.Ve
.SS "Support"
.IX Subsection "Support"
Please direct usage questions or support issues to the mailing list:
\&\fIbioperl\-l@bioperl.org\fR
.PP
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.
.SS "Reporting bugs"
.IX Subsection "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:
.PP
.Vb 1
\&  https://redmine.open\-bio.org/projects/bioperl/
.Ve
.SH "LEGAL"
.IX Header "LEGAL"
.SS "Authors"
.IX Subsection "Authors"
Martin Senger <senger@ebi.ac.uk>
.SS "Copyright and License"
.IX Subsection "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