.\" Automatically generated by Pod::Man 4.09 (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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Plucene::Index::FieldInfos 3pm"
.TH Plucene::Index::FieldInfos 3pm "2018-04-02" "perl v5.26.1" "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"
Plucene::Index::FieldInfos \- a collection of FieldInfo objects
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&        my $fis = Plucene::Index::FieldInfos\->new($dir_name);
\&        my $fis = Plucene::Index::FieldInfos\->new($dir_name, $file);
\&
\&        $fis\->add(Plucene::Document $doc, $indexed);
\&        $fis\->add(Plucene::Index::FieldInfos $other_fis, $indexed);
\&        $fis\->add($name, $indexed);
\&
\&        $fis\->write($path);
\&
\&        my @fields = $fis\->fields;
\&
\&        my $field_number = $fis\->field_number($name);
\&        my   $field_info = $fis\->field_info($name);
\&        my   $field_name = $fis\->field_name($number);
\&        my   $num_fields = $fis\->size;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a collection of field info objects, which happen to live in 
the field infos file.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
.Vb 2
\&        my $fis = Plucene::Index::FieldInfos\->new($dir_name);
\&        my $fis = Plucene::Index::FieldInfos\->new($dir_name, $file);
.Ve
.PP
This will create a new Plucene::Index::FieldInfos object with the passed
directory and optional filename.
.SS "add"
.IX Subsection "add"
.Vb 3
\&        $fis\->add(Plucene::Document $doc, $indexed);
\&        $fis\->add(Plucene::Index::FieldInfos $other_fis, $indexed);
\&        $fis\->add($name, $indexed);
.Ve
.PP
This will add the fields from a Plucene::Document or a 
Plucene::Index::FieldsInfos to the field infos file.
.PP
It is also possible to pass the name of a field and have it added
to the file.
.SS "field_number"
.IX Subsection "field_number"
.Vb 1
\&        my $field_number = $fis\->field_number($name);
.Ve
.PP
This will return the field number of the field with \f(CW$name\fR. If there is 
no match, then \-1 is returned.
.SS "fields"
.IX Subsection "fields"
.Vb 1
\&        my @fields = $fis\->fields;
.Ve
.PP
This will return all the fields.
.SS "field_info"
.IX Subsection "field_info"
.Vb 1
\&        my $field_info = $fis\->field_info($name);
.Ve
.PP
This will return the field info for the field called \f(CW$name\fR.
.SS "field_name"
.IX Subsection "field_name"
.Vb 1
\&        my $field_name = $fis\->field_name($number);
.Ve
.PP
This will return the field name for the field whose number is \f(CW$number\fR.
.SS "size"
.IX Subsection "size"
.Vb 1
\&        my $num_fields = $fis\->size;
.Ve
.PP
This returns the number of field info objects.
.SS "write"
.IX Subsection "write"
.Vb 1
\&        $fis\->write($path);
.Ve
.PP
This will write the field info objects to \f(CW$path\fR.