.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" 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::Tools::EUtilities::Info::LinkInfo 3pm"
.TH Bio::Tools::EUtilities::Info::LinkInfo 3pm "2020-03-13" "perl v5.30.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::Tools::EUtilities::Info::LinkInfo \- Class for storing einfo link data.
.SH "VERSION"
.IX Header "VERSION"
version 1.77
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    ## should not create instance directly; Bio::Tools::EUtilities does this ##
\&
\&    # get a LinkInfo object using Bio:Tools::EUtilities
\&    print "Link name: ",$link\->get_link_name,"\en";
\&    print "Link name: ",$link\->get_link_menu_name,"\en";
\&    print "Link desc: ",$link\->get_link_description,"\en";
\&    print "DBFrom: ",$link\->get_dbfrom,"\en"; # database linked from
\&    print "DBTo: ",$link\->get_dbto,"\en"; # database linked to
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class handles data output (\s-1XML\s0) from both einfo and elink, and centers on
describing data that either describes how \s-1NCBI\s0 databases are linked together
via link names, or how databases are linked to outside databases (LinkOut).
.PP
Further documentation for Link and Field subclass methods is included below.
.PP
For more information on einfo see:
.PP
.Vb 1
\&   http://eutils.ncbi.nlm.nih.gov/entrez/query/static/einfo_help.html
.Ve
.SS "new"
.IX Subsection "new"
.Vb 6
\& Title    : new
\& Note     : *** should not be called by end\-users ***
\& Usage    : my $ct = Bio::Tools::EUtilities::Info::LinkInfo;
\& Function : returns new LinkInfo instance
\& Returns  : Bio::Tools::EUtilities::Info::LinkInfo instance
\& Args     : none (all data added via _add_data, most methods are getters only)
.Ve
.SS "get_database"
.IX Subsection "get_database"
.Vb 7
\& Title    : get_database
\& Usage    : my $db = $info\->get_database;
\& Function : returns single database name (eutil\-compatible).  This is the
\&            queried database. For elinks (which have \*(Aqdb\*(Aq and \*(Aqdbfrom\*(Aq)
\&            this is equivalent to db/dbto (use get_dbfrom() to for the latter)
\& Returns  : string
\& Args     : none
.Ve
.SS "get_db (alias for get_database)"
.IX Subsection "get_db (alias for get_database)"
.SS "get_dbto (alias for get_database)"
.IX Subsection "get_dbto (alias for get_database)"
.SS "get_dbfrom"
.IX Subsection "get_dbfrom"
.Vb 6
\& Title    : get_dbfrom
\& Usage    : my $origdb = $link\->get_dbfrom;
\& Function : returns referring database
\& Returns  : string
\& Args     : none
\& Note     :
.Ve
.SS "get_link_name"
.IX Subsection "get_link_name"
.Vb 5
\& Title    : get_link_name
\& Usage    : $ln = $link\->get_link_name;
\& Function : returns raw link name (eutil\-compatible)
\& Returns  : string
\& Args     : none
.Ve
.SS "get_link_description"
.IX Subsection "get_link_description"
.Vb 5
\& Title    : get_link_description
\& Usage    : $desc = $link\->get_link_description;
\& Function : returns the (more detailed) link description
\& Returns  : string
\& Args     : none
.Ve
.SS "get_link_menu_name"
.IX Subsection "get_link_menu_name"
.Vb 5
\& Title    : get_link_menu_name
\& Usage    : my $mn = $link\->get_link_menu_name;
\& Function : returns formal menu name
\& Returns  : string
\& Args     : none
.Ve
.SS "get_priority"
.IX Subsection "get_priority"
.Vb 6
\& Title    : get_priority
\& Usage    : my $mn = $link\->get_priority;
\& Function : returns priority ranking
\& Returns  : integer
\& Args     : none
\& Note     : only set when using elink and cmd set to \*(Aqacheck\*(Aq
.Ve
.SS "get_html_tag"
.IX Subsection "get_html_tag"
.Vb 6
\& Title    : get_html_tag
\& Usage    : my $tag = $link\->get_html_tag;
\& Function : returns HTML tag
\& Returns  : string
\& Args     : none
\& Note     : only set when using elink and cmd set to \*(Aqacheck\*(Aq
.Ve
.SS "get_url"
.IX Subsection "get_url"
.Vb 7
\& Title    : get_url
\& Usage    : my $url = $link\->get_url;
\& Function : returns URL string; note that the string isn\*(Aqt usable directly but
\&            has the ID replaced with the tag <@UID@>
\& Returns  : string
\& Args     : none
\& Note     : only set when using elink and cmd set to \*(Aqacheck\*(Aq
.Ve
.SS "to_string"
.IX Subsection "to_string"
.Vb 6
\& Title    : to_string
\& Usage    : $foo\->to_string()
\& Function : converts current object to string
\& Returns  : none
\& Args     : (optional) simple data for text formatting
\& Note     : Used generally for debugging and for various print methods
.Ve
.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
\&  https://bioperl.org/Support.html    \- 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
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://github.com/bioperl/bio\-eutilities/issues
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Chris Fields <cjfields@bioperl.org>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
This software is copyright (c) 2006\-2013 by Chris Fields.
.PP
This software is available under the same terms as the perl 5 programming language system itself.