Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

lire::field(3pm) [debian man page]

Field(3pm)						  LogReport's Lire Documentation						Field(3pm)

NAME

       Lire::Field - Interface to Dlf field's specification.

SYNOPSIS

	   my $field = $schema->field( 'time' );
	   print "Name: ", $field->name(), "
", "Type: ", $field->type(), "
";

DESCRIPTION

       This module represents Dlf field's specifications. You'll get reference to this kind of object when you call the field(), timestamp_field()
       or fields() methods on a Lire::DlfSchema(3pm) object. You can obtain information about this field by querying its methods.

OBJECT METHODS

   name()
       Returns the name of the field.

   label()
       Returns the default label that should be used for column containing values from this field.

   pos()
       Returns the field's position in the record. Field's positions are indexed from 0.

   type()
       Returns the field's type. This will be a string describing the type's name as used in the XML specifications.

   sql_type()
       Returns the SQL type that should be used to hold this field's values.

   default()
       This method is obsolete since field don't have default anymore.

   description()
       This method will return the field's description. (This is the content of the description element in the XML specification.) Be aware that
       this will most likely contains DocBook markup.

SEE ALSO

       Lire::DlfSchema(3pm) Lire::DataTypes(3pm)

AUTHORS

	 Francis J. Lacoste <flacoste@logreport.org>
	 Wolfgang Sourdeau <wolfgang@logreport.org>

VERSION

       $Id: Field.pm,v 1.18 2006/07/23 13:16:29 vanbaal Exp $

COPYRIGHT

       Copyright (C) 2001-2004 Stichting LogReport Foundation LogReport@LogReport.org

       This file is part of Lire.

       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.

       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.

       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.

Lire 2.1.1							    2006-07-23								Field(3pm)

Check Out this Related Man Page

DerivedSchema(3pm)					  LogReport's Lire Documentation					DerivedSchema(3pm)

NAME

       Lire::DerivedSchema - Defines a schema for which the records are derived from another schema

SYNOPSIS

	 my $schema = Lire::DlfSchema::load_schema( 'www-user_session' );
	 my $fields = $schema->fields();

DESCRIPTION

       A Lire::DerivedSchema defines a schema for which the records are computed by an analyser using the records of a base schema. An example of
       a derived schema is the www-user_session schema which computes session information from the records in the www schema.

   base()
       Returns the Lire::DlfSchema object from which this schema's records are derived.

   can_join_schema( $schema )
       Returns true if $schema can be joined with this schema. For a DerivedSchema, this will be true only when $schema is an ExtendedSchema of
       this schema or this schema's base. It is also possible to join the DerivedSchema with its base.

AUTHOR

       Francis J. Lacoste <flacoste@logreport.org>

VERSION

       $Id: DerivedSchema.pm,v 1.19 2006/07/23 13:16:28 vanbaal Exp $

COPYRIGHT

       Copyright (C) 2001, 2004 Stichting LogReport Foundation LogReport@LogReport.org

       This file is part of Lire.

       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.

       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.

       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.

Lire 2.1.1							    2006-07-23							DerivedSchema(3pm)
Man Page