view release on metacpan or  search on metacpan

lib/Bio/DB/BiblioI.pm  view on Meta::CPAN

package Bio::DB::BiblioI;
BEGIN {
  $Bio::DB::BiblioI::AUTHORITY = 'cpan:BIOPERLML';
}
{
  $Bio::DB::BiblioI::VERSION = '1.70';
}
use utf8;
use strict;
use warnings;

use parent qw(Bio::Root::RootI);

# ABSTRACT: an interface to a Bibliographic Query Service
# AUTHOR:   Martin Senger <martin.senger@gmail.com>
# OWNER:    2002 European Bioinformatics Institute
# LICENSE:  Perl_5



sub get_collection_id {
    my ($self,@args) = @_;
    $self->throw_not_implemented();
}


# -----------------------------------------------------------------------------


sub get_count { shift->throw_not_implemented(); }

# -----------------------------------------------------------------------------


sub find { shift->throw_not_implemented; }

# -----------------------------------------------------------------------------

# TBD: AFAIK this method is not implemented on the server side.
#      Let's comment it out for the time being...
#sub query { shift->throw_not_implemented(); }

# -----------------------------------------------------------------------------


sub reset_retrieval { shift->throw_not_implemented; }

# -----------------------------------------------------------------------------


sub get_next { shift->throw_not_implemented; }

# -----------------------------------------------------------------------------


sub get_more { shift->throw_not_implemented; }

# -----------------------------------------------------------------------------


sub has_next { shift->throw_not_implemented; }

# -----------------------------------------------------------------------------


sub get_all_ids { shift->throw_not_implemented; }

# -----------------------------------------------------------------------------


sub get_by_id { shift->throw_not_implemented; }

# -----------------------------------------------------------------------------


sub get_all { shift->throw_not_implemented; }

# -----------------------------------------------------------------------------


sub exists { shift->throw_not_implemented; }

# -----------------------------------------------------------------------------


sub destroy { shift->throw_not_implemented; }

# -----------------------------------------------------------------------------


sub get_vocabulary_names { shift->throw_not_implemented; }

# -----------------------------------------------------------------------------


sub contains { shift->throw_not_implemented; }

# -----------------------------------------------------------------------------


sub get_entry_description { shift->throw_not_implemented; }

# -----------------------------------------------------------------------------


sub get_all_values { shift->throw_not_implemented; }

# -----------------------------------------------------------------------------


sub get_all_entries { shift->throw_not_implemented; }

1;

__END__
=pod

=encoding utf-8

=head1 NAME

Bio::DB::BiblioI - an interface to a Bibliographic Query Service

=head1 VERSION

version 1.70

=head1 SYNOPSIS

This is an interface module - you do not instantiate it.
Use I<Bio::Biblio> module:

  use Bio::Biblio;
  my $biblio = Bio::Biblio->new(@args);

=head1 DESCRIPTION

This interface describes the methods for accessing a bibliographic
repository, for querying it and for retrieving citations from it. The
retrieved citations are in XML format and can be converted to perl
objects using I<Bio::Biblio::IO>.

The interface complies (with some simplifications) with the
specification described in the B<OpenBQS> project. Its home page is at
http://www.ebi.ac.uk/~senger/openbqs/.

=head1 ATTRIBUTES

=head2 has_next

 Usage   : my $is = $biblio->has_next;
 Returns : 1 or undef
 Args    : none

It returns 1 if there is a next citation available in the underlying
query collection. Otherwise it returns undef.

It throws an exception if this object does not represent any query
result - see explanation in method I<reset_retrieval> elsewhere in
this document.

=head2 exists

 Usage   : my $exists = $biblio->exists;
 Returns : 1 or undef
 Args    : none

It returns 1 if the underlying query collection represented by the
$biblio object still exists (on the server side).

If you have a collection ID (e.g. stored or printed in a previous