Lincoln D. Stein > Bio-Das-1.17 > Bio::Das::DSN

Download:
Bio-Das-1.17.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  3
Open  0
View/Report Bugs
Source  

NAME ^

Bio::Das::DSN - Object encapsulation of a DAS data source

SYNOPSIS ^

 my $base         = $dsn->base;
 my $id           = $dsn->id;
 my $host         = $dsn->host;
 my $url          = $dsn->url;
 my $name         = $dsn->name;
 my $description  = $dsn->description;
 my $mapmaster    = $dsn->master;

DESCRIPTION ^

The Bio::Das::DSN object contains information pertaining to a Das data source. A set of these objects are returned by a call to Bio::Das->dsn().

METHODS

Following is a complete list of methods implemented by Bio::Das::DSN.

$dsn = Bio::Das::DSN->new($base,$id,$name,$master,$description)

Create a new Bio::DAS::DSN object. Ordinarily this is called during the processing of a DAS dsn request and should not be invoked by application code.

$base = $dsn->base

Return the base of the DAS server, for example "http://www.wormbase.org/db/das."

$host = $dsn->host

Return the hostname of the DAS server, for example "www.wormbase.org."

$id = $dsn->id

Return the ID of the DAS data source, for example "elegans."

$url = $dsn->url

Return the URL for the request, which will consist of the basename plus the DSN ID. For example "http://www.wormbase.org/db/das/elegans."

The url() method is automatically invoked if the DSN is used in a string context. This makes it convenient to use as a hash key.

$name = $dsn->name

Return the human readable name for the DSN. This is usually, but not necessarily, identical to the ID. This field will only be set if the DSN was generated via a Bio::Das->dsn() request. Otherwise it will be undef.

$description = $dsn->description

Return the human readable description for the DSN. This field will only be set if the DSN was generated via a Bio::Das->dsn() request. Otherwise it will be undef.

$master = $dsn->master

Return the URL of the DAS reference server associated with this DSN. This field will only be set if the DSN was generated via a Bio::Das->dsn() request. Otherwise it will be undef.

$flag = $dsn->eq($other_dsn)

This method will return true if two DSN objects are equivalent, false otherwise. This method overloads the eq operator, allowing you to compare to DSNs this way:

  if ($dsn1 eq $dsn2) { .... }

AUTHOR ^

Lincoln Stein <lstein@cshl.org>.

Copyright (c) 2001 Cold Spring Harbor Laboratory

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See DISCLAIMER.txt for disclaimers of warranty.

SEE ALSO ^

Bio::Das::Request, Bio::Das::HTTP::Fetch, Bio::Das::Segment, Bio::Das::Type, Bio::Das::Stylesheet, Bio::Das::Source, Bio::RangeI

syntax highlighting: