.\" 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::FieldInfo 3pm"
.TH Bio::Tools::EUtilities::Info::FieldInfo 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::FieldInfo \- Class for storing einfo field 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 ####
\&
\&    my $info = Bio::Tools::EUtilities\->new(\-eutil => \*(Aqeinfo\*(Aq,
\&                                           \-file => \*(Aqeinfo.xml\*(Aq);
\&    # can also use \*(Aq\-response\*(Aq (for HTTP::Response objects) or \*(Aq\-fh\*(Aq (for filehandles)
\&
\&    # print available databases (if data is present)
\&    print join(\*(Aq, \*(Aq,$info\->get_available_databases),"\en";
\&
\&    # get database info
\&    my $db = $info\->get_database; # in case you forgot...
\&    my $desc = $info\->get_description;
\&    my $nm = $info\->get_menu_name;
\&    my $ct = $info\->get_record_count;
\&    my $dt = $info\->get_last_update;
\&    # EUtilDataI interface methods
\&    my $eutil = $info\->eutil;
\&    my $type = $info\->type;
\&
\&    # iterate through Field and Link objects
\&    while (my $field = $info\->next_Field) {
\&        print "Field code: ",$field\->get_field_code,"\en";
\&        print "Field name: ",$field\->get_field_name,"\en";
\&        print "Field desc: ",$field\->get_field_description,"\en";
\&        print "DB  : ",$field\->get_database,"\en";
\&        print "Term ct   : ",$field\->get_term_count,"\en";
\&        for my $att (qw(is_date is_singletoken is_hierarchy is_hidden is_numerical)) {
\&            print "\etField $att\en" if $field\->$att;
\&        }
\&    }
\&
\&    my @fields = $info\->get_Fields; # grab them all (useful for grep)
\&
\&    $info\->rewind(\*(Aqfields\*(Aq); # rewinds Field iterator
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class handles simple field data output (\s-1XML\s0) from einfo.
.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::FieldInfo;
\& Function : returns new FieldInfo instance
\& Returns  : Bio::Tools::EUtilities::Info::FieldInfo instance
\& Args     : none (all data added via _add_data, most methods are getters only)
.Ve
.SS "get_term_count"
.IX Subsection "get_term_count"
.Vb 5
\& Title    : get_term_count
\& Usage    : my $ct = $field\->get_term_count;
\& Function : returns number of terms for field
\& Returns  : integer
\& Args     : none
.Ve
.SS "get_field_name"
.IX Subsection "get_field_name"
.Vb 5
\& Title    : get_field_name
\& Usage    : my $nm = $field\->get_field_name;
\& Function : returns the full name of the field
\& Returns  : string
\& Args     : none
.Ve
.SS "get_full_name"
.IX Subsection "get_full_name"
.Vb 2
\& Title    : get_full_name
\& Note     : alias of get_field_name()
.Ve
.SS "get_field_code"
.IX Subsection "get_field_code"
.Vb 5
\& Title    : get_field_code
\& Usage    : $field\->get_field_code()
\& Function : returns field code (abbreviation) used for queries
\& Returns  : string
\& Args     : none
.Ve
.SS "get_field_description"
.IX Subsection "get_field_description"
.Vb 6
\& Title    : get_field_description
\& Usage    : $field\->get_field_description
\& Function : returns field description
\& Returns  : string
\& Args     : none
\& Note     : alias of get_description()
.Ve
.SS "is_date"
.IX Subsection "is_date"
.Vb 5
\& Title    : is_date
\& Usage    : if ($field\->is_date) {...}
\& Function : returns true if field contains date information
\& Returns  : Boolean
\& Args     : none
.Ve
.SS "is_singletoken"
.IX Subsection "is_singletoken"
.Vb 5
\& Title    : is_singletoken
\& Usage    : if ($field\->is_singletoken) {...}
\& Function : returns true if field has single value in docsums
\& Returns  : Boolean
\& Args     : none
.Ve
.SS "is_hierarchy"
.IX Subsection "is_hierarchy"
.Vb 5
\& Title    : is_hierarchy
\& Usage    : if ($field\->is_hierarchy) {...}
\& Function : returns true if field contains hierarchal values
\& Returns  : Boolean
\& Args     : none
.Ve
.SS "is_hidden"
.IX Subsection "is_hidden"
.Vb 5
\& Title    : is_hidden
\& Usage    : if ($field\->is_hidden) {...}
\& Function : returns true if field is hidden in docsums
\& Returns  : Boolean
\& Args     : none
.Ve
.SS "is_numerical"
.IX Subsection "is_numerical"
.Vb 5
\& Title    : is_numerical
\& Usage    : if ($field\->is_numerical) {...}
\& Function : returns true if field contains a numerical value
\& Returns  : Boolean
\& Args     : none
.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.