Christopher Brown > ODG-Record-0.26 > ODG::Metadata

Download:
ODG-Record-0.26.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
Report a bug
Source   Latest Release: ODG-Record-0.28

NAME ^

ODG::Metadata - Extensible class for defining metadata fields

SYNOPSIS ^

    use ODG::Metadata

    my $first_name = ODG::Metadata->new( 
        { name => 'first_name' } 
    );

DESCRIPTION ^

The ODG::Metadata class is used to hold all of the metadata for a single field. It does not define the position of fields use ODG::Layout for that. ODG::Metadata simply describes the field metadata.

When used with ODG::Layout and ODG::Record, this class allows name based accessors to data and efficient processing of row based data.

METHODS ^

new

    my $metadata = ODG::Metadata->new( 
        {
           name    => 'field_1' ,
        } 
    );

Creates a new ODG::Metadata object. Takes a hashref of object attributes. There is only one required attributes:

    name:   a unqiue name for the field 

Extending ^

    package My::Class;
    use Moose;
    extends ODG::Metadata;

    ...

SEE ALSO ^

ODG::Metadta, ODG::Record, Moose

AUTHOR ^

Christopher BRown, <http://www.opendatagroup.com>

COPYRIGHT AND LICENSE ^

Copyright (C) 2008 by Open Data

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.10.0 or, at your option, any later version of Perl 5 you may have available.