Bio::Biblio Ref
SummaryIncluded librariesPackage variablesSynopsisDescriptionGeneral documentationMethods
Toolbar
WebCvs
Summary
Bio::Biblio::Ref - Representation of a bibliographic reference
Package variables
Privates (from "my" definitions)
%_allowed = ( _author_list_complete => undef, _authors => 'ARRAY', _cross_references => 'ARRAY', _cross_references_list_complete => undef, _abstract => undef, _abstract_language => undef, _abstract_type => undef, _codes => 'HASH', _contributors => 'ARRAY', _date => undef, _date_completed => undef, _date_created => undef, _date_revised => undef, _format => undef, _identifier => undef, _keywords => 'HASH', _language => undef, _last_modified_date => undef, _publisher => 'Bio::Biblio::Provider', _repository_subset => undef, _rights => undef, _spatial_location => undef, _subject_headings => 'HASH', _subject_headings_source => undef, _temporal_period => undef, _title => undef, _toc => undef, _toc_type => undef, _type => undef, )
Included modules
Bio::Annotation::DBLink
Inherit
Bio::Biblio::BiblioBase
Synopsis
    $obj = Bio::Biblio::Ref->new(-type  => 'Letter',
-title => 'Onegin to Tatiana');
#--- OR ---
$obj = Bio::Biblio::Ref->new(); $obj->type ('Letter');
Description
A storage object for a general bibliographic reference (a citation).
See its place in the class hierarchy in
http://www.ebi.ac.uk/~senger/openbqs/images/bibobjects_perl.gif The following attributes are specific to this class,
and they are inherited by all citation types.
  author_list_complete            values: 'Y'  (default) or 'N'
authors type: array ref of Bio::Biblio::Provider's
cross_references type: array ref of Bio::Annotation::DBLink's
cross_references_list_complete values: 'Y' (default) or 'N'
abstract
abstract_language
abstract_type
codes type: hash ref
contributors type: array ref of Bio::Biblio::Provider's
date
date_completed
date_created
date_revised
format
identifier
keywords
language
last_modified_date
publisher type: Bio::Biblio::Provider
repository_subset
rights
spatial_location
subject_headings type: hash ref
subject_headings_source
temporal_period
title
toc
toc_type
type
Methods
_accessible
No description
Code
_attr_type
No description
Code
add_cross_referenceDescriptionCode
add_authorDescriptionCode
add_contributorDescriptionCode
Methods description
add_cross_referencecode    nextTop
 Usage   : $self->add_cross_reference
(Bio::Annotation::DBLink->new(-database => 'EMBL',
-primary_id => 'V00808');
Function: adding a link to a database entry
Returns : new value of 'cross_references'
Args : an object of type Bio::Annotation::DBLink
add_authorcodeprevnextTop
 Usage   : $self->add_author (Bio::Biblio::Person->new(-lastname => 'Novak');
Function: adding an author to a list of authors
Returns : new value of 'authors' (a full list)
Args : an object of type Bio::Biblio::Provider
add_contributorcodeprevnextTop
 Usage   : $self->add_contributor (Bio::Biblio::Person->new(-lastname => 'Novak');
Function: adding a contributor to a list of contributors
Returns : new value of 'contributors' (a full list)
Args : an object of type Bio::Biblio::Provider
Methods code
_accessibledescriptionprevnextTop
sub _accessible {
	my ($self, $attr) = @_;
	exists $_allowed{$attr};
    }

    # return an expected type of given $attr
}
_attr_typedescriptionprevnextTop
sub _attr_type {
	my ($self, $attr) = @_;
	$_allowed{$attr};
    }
}
add_cross_referencedescriptionprevnextTop
sub add_cross_reference {
    my ($self, $value) = @_;
    $self->throw ($self->_wrong_type_msg (ref $value, 'Bio::Annotation::DBLink'))
	unless (UNIVERSAL::isa ($value, 'Bio::Annotation::DBLink'));
    (defined $self->cross_references) ?
	push (@{ $self->cross_references }, $value) :
	    return $self->cross_references ( [$value] );
    return $self->cross_references;
}
add_authordescriptionprevnextTop
sub add_author {
    my ($self, $value) = @_;
    $self->throw ($self->_wrong_type_msg (ref $value, 'Bio::Biblio::Provider'))
	unless (UNIVERSAL::isa ($value, 'Bio::Biblio::Provider'));
    (defined $self->authors) ?
	push (@{ $self->authors }, $value) :
	    return $self->authors ( [$value] );
    return $self->authors;
}
add_contributordescriptionprevnextTop
sub add_contributor {
    my ($self, $value) = @_;
    $self->throw ($self->_wrong_type_msg (ref $value, 'Bio::Biblio::Provider'))
	unless (UNIVERSAL::isa ($value, 'Bio::Biblio::Provider'));
    (defined $self->contributors) ?
	push (@{ $self->contributors }, $value) :
	    return $self->contributors ( [$value] );
    return $self->contributors;
}


1;
__END__
}
General documentation
SEE ALSOTop
    *(1)
    OpenBQS home page: http://www.ebi.ac.uk/~senger/openbqs/
    *(2)
    Comments to the Perl client: http://www.ebi.ac.uk/~senger/openbqs/Client_perl.html
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/wiki/Mailing_lists - About the mailing lists
Support Top
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 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 the
web:
  https://redmine.open-bio.org/projects/bioperl/
AUTHORSTop
Heikki Lehvaslaiho (heikki-at-bioperl-dot-org),
Martin Senger (senger@ebi.ac.uk)
COPYRIGHTTop
Copyright (c) 2002 European Bioinformatics Institute. All Rights Reserved.
This module is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
DISCLAIMERTop
This software is provided "as is" without warranty of any kind.
APPENDIXTop
The rest of the documentation details each of the object
methods. Internal methods are preceded with a _