/ 
BioPerl-DB-1.006900
River stage zero No dependents
/ Bio::DB::Persistent::BioNamespace

NAME

Bio::DB::Persistent::BioNamespace - DESCRIPTION of Object

SYNOPSIS

Give standard usage here

DESCRIPTION

Describe the object here

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:

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

AUTHOR - Hilmar Lapp

Email hlapp at gmx.net

Describe contact details here

CONTRIBUTORS

Additional contributors names and emails here

APPENDIX

The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _

new

Title   : new
Usage   : my $obj = Bio::DB::Persistent::BioNamespace->new();
Function: Builds a new Bio::DB::Persistent::BioNamespace object 
Returns : an instance of Bio::DB::Persistent::BioNamespace
Args    :

obj

Title   : obj
Usage   : $obj->obj()
Function: Get the object that is made persistent through this adaptor.

          Note that this implementation does not allow setting the object.
Example : 
Returns : The object made persistent through this adaptor
Args    : None (set not supported)

identifiable

Title   : identifiable
Usage   : $obj->identifiable($newval)
Function: Get/set the Bio::IdentifiableI compliant object from which to obtain
          namespace and authority, and to which to forward all IdentifiableI
          calls.
Example : 
Returns : a Bio::IdentifiableI compliant object
Args    : Optionally on set, a Bio::IdentifiableI compliant object

Methods for Bio::IdentifiableI compliance

object_id

Title   : object_id
Usage   : $string    = $obj->object_id()
Function: a string which represents the stable primary identifier
          in this namespace of this object. For DNA sequences this
          is its accession_number, similarly for protein sequences

Returns : A scalar

version

Title   : version
Usage   : $version    = $obj->version()
Function: a number which differentiates between versions of
          the same object. Higher numbers are considered to be
          later and more relevant, but a single object described
          the same identifier should represent the same concept

Returns : A number

authority

Title   : authority
Usage   : $authority    = $obj->authority()
Function: a string which represents the organisation which
          granted the namespace, written as the DNS name for  
          organisation (eg, wormbase.org)

Returns : A scalar

namespace

Title   : namespace
Usage   : $string    = $obj->namespace()
Function: A string representing the name space this identifier
          is valid in, often the database name or the name
          describing the collection 

Returns : A scalar