.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "Field 3pm"
.TH Field 3pm 2025-09-28 "Lire 2.1.1" "LogReport's Lire 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
Lire::Field \- Interface to Dlf field\*(Aqs specification.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&    my $field = $schema\->field( \*(Aqtime\*(Aq );
\&    print "Name: ", $field\->name(), "\en", "Type: ", $field\->type(), "\en";
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module represents Dlf field\*(Aqs specifications. You\*(Aqll get
reference to this kind of object when you call the \fBfield()\fR,
\&\fBtimestamp_field()\fR or \fBfields()\fR methods on a \fBLire::DlfSchema\fR\|(3pm)
object. You can obtain information about this field by querying its
methods.
.SH "OBJECT METHODS"
.IX Header "OBJECT METHODS"
.SS \fBname()\fP
.IX Subsection "name()"
Returns the name of the field.
.SS \fBlabel()\fP
.IX Subsection "label()"
Returns the default label that should be used for column containing
values from this field.
.SS \fBpos()\fP
.IX Subsection "pos()"
Returns the field\*(Aqs position in the record. Field\*(Aqs positions are
indexed from 0.
.SS \fBtype()\fP
.IX Subsection "type()"
Returns the field\*(Aqs type. This will be a string describing the type\*(Aqs
name as used in the XML specifications.
.SS \fBsql_type()\fP
.IX Subsection "sql_type()"
Returns the SQL type that should be used to hold this field\*(Aqs values.
.SS \fBdefault()\fP
.IX Subsection "default()"
This method is obsolete since field don\*(Aqt have default anymore.
.SS \fBdescription()\fP
.IX Subsection "description()"
This method will return the field\*(Aqs description. (This is the content
of the description element in the XML specification.) Be aware that
this will most likely contains DocBook markup.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBLire::DlfSchema\fR\|(3pm) \fBLire::DataTypes\fR\|(3pm)
.SH AUTHORS
.IX Header "AUTHORS"
.Vb 2
\&  Francis J. Lacoste <flacoste@logreport.org>
\&  Wolfgang Sourdeau <wolfgang@logreport.org>
.Ve
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR Field.pm,v 1.18 2006/07/23 13:16:29 vanbaal Exp $
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2001\-2004 Stichting LogReport Foundation LogReport@LogReport.org
.PP
This file is part of Lire.
.PP
Lire is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with this program (see COPYING); if not, check with
http://www.gnu.org/copyleft/gpl.html.