Peter Flanigan > File-DataClass-0.54.1 > File::DataClass



Annotate this POD



Open  0
View/Report Bugs
Module Version: v0.54.1   Source  

Name ^

File::DataClass - Structured data file IO with OO paradigm

Version ^

This document describes version v0.54.$Rev: 1 $ of File::DataClass

Synopsis ^

   use File::DataClass::Schema;

   $schema = File::DataClass::Schema->new
      ( path    => [ qw(path to a file) ],
        result_source_attributes => { source_name => {}, },
        tempdir => [ qw(path to a directory) ] );

   $schema->source( q(source_name) )->attributes( [ qw(list of attr names) ] );
   $rs = $schema->resultset( q(source_name) );
   $result = $rs->find( { name => q(id of field element to find) } );
   $result->$attr_name( $some_new_value );
   @result = $rs->search( { 'attr name' => q(some value) } );

Description ^

Provides methods for manipulating structured data stored in files of different formats

The documentation for this distribution starts in the class File::DataClass::Schema

File::DataClass::IO is a Moo based implementation of IO::Alls API. It implements the file and directory methods only

Configuration and Environment ^

Defines no attributes

Subroutines/Methods ^


   $hash_ref_of_CHI_objects = File::DataClass->F_DC_Cache;

A class method which returns a hash ref of CHI objects which are used to cache the results of reading files

Diagnostics ^


Dependencies ^


Incompatibilities ^

On mswin32 and cygwin it is assumed that NTFS is being used and that it does not support mtime so caching on those platforms is disabled

Due to the absence of an mswin32 environment for testing purposes that platform is not supported

Bugs and Limitations ^

There are no known bugs in this module. Please report problems to Patches are welcome

Acknowledgements ^

Larry Wall - For the Perl programming language

The class structure and API where taken from DBIx::Class

The API for the file IO was taken from IO::All

Author ^

Peter Flanigan, <>

License and Copyright ^

Copyright (c) 2014 Peter Flanigan. All rights reserved

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic

This program is distributed in the hope that it will be useful, but WITHOUT WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE

syntax highlighting: