.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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 turned on, 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
.\"
.\" 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 "Lucy::Plan::Schema 3pm"
.TH Lucy::Plan::Schema 3pm "2015-03-06" "perl v5.20.2" "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"
Lucy::Plan::Schema \- User\-created specification for an inverted index.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&    use Lucy::Plan::Schema;
\&    use Lucy::Plan::FullTextType;
\&    use Lucy::Analysis::PolyAnalyzer;
\&    
\&    my $schema = Lucy::Plan::Schema\->new;
\&    my $polyanalyzer = Lucy::Analysis::PolyAnalyzer\->new( 
\&        language => \*(Aqen\*(Aq,
\&    );
\&    my $type = Lucy::Plan::FullTextType\->new(
\&        analyzer => $polyanalyzer,
\&    );
\&    $schema\->spec_field( name => \*(Aqtitle\*(Aq,   type => $type );
\&    $schema\->spec_field( name => \*(Aqcontent\*(Aq, type => $type );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A Schema is a specification which indicates how other entities should
interpret the raw data in an inverted index and interact with it.
.PP
Once an actual index has been created using a particular Schema, existing
field definitions may not be changed.  However, it is possible to add new
fields during subsequent indexing sessions.
.SH "CONSTRUCTORS"
.IX Header "CONSTRUCTORS"
.SS "\fInew()\fP"
.IX Subsection "new()"
.Vb 1
\&    my $schema = Lucy::Plan::Schema\->new;
.Ve
.PP
Constructor.  Takes no arguments.
.SH "METHODS"
.IX Header "METHODS"
.SS "spec_field( \fI[labeled params]\fP )"
.IX Subsection "spec_field( [labeled params] )"
Define the behavior of a field by associating it with a FieldType.
.PP
If this method has already been called for the supplied
\&\f(CW\*(C`field\*(C'\fR, it will merely test to verify that the supplied
FieldType \fIequals()\fR the existing one.
.IP "\(bu" 4
\&\fBname\fR \- The name of the field.
.IP "\(bu" 4
\&\fBtype\fR \- A FieldType.
.SS "\fInum_fields()\fP"
.IX Subsection "num_fields()"
Return the number of fields currently defined.
.SS "\fIall_fields()\fP"
.IX Subsection "all_fields()"
Return all the Schema's field names as an array.
.SS "fetch_type(field)"
.IX Subsection "fetch_type(field)"
Return the FieldType for the specified field.  If the field can't be
found, return undef.
.SS "fetch_sim(field)"
.IX Subsection "fetch_sim(field)"
Return the Similarity for the specified field, or undef if either the
field can't be found or it isn't associated with a Similarity.
.SS "\fIarchitecture()\fP"
.IX Subsection "architecture()"
Factory method which creates an Architecture object for this index.
.SS "\fIget_architecture()\fP"
.IX Subsection "get_architecture()"
Return the Schema instance's internal Architecture object.
.SS "\fIget_similarity()\fP"
.IX Subsection "get_similarity()"
Return the Schema instance's internal Similarity object.
.SH "INHERITANCE"
.IX Header "INHERITANCE"
Lucy::Plan::Schema isa Lucy::Object::Obj.