Lire::Field(3pm)

Lire::Field3pm

Interface to dlf field's specification.

Usage

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

Overview

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.

Version

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

Releases

7 releases since Debian 3.0 (Woody); the text changed 6 times.

  1. 3.0
  2. 3.1
  3. 4.0
  4. 5.0
  5. 6.0
  6. 7
  7. Arch

Authors

  Francis J. Lacoste <[email protected]>
  Wolfgang Sourdeau <[email protected]>

From lire 2.1.1-8 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.