Perl::Metrics::File - A local file to generate metrics for

This class provides objects that link files on the local filesystem to the main metrics table via their document hex_id (see PPI::Document)

In addition to the general methods provided by Class::DBI, this class has the following additional methods.

The path accessor returns a string which contains the non-relative file path on the local system.

The checked accessor returns the Unix epoch time for when the hex_id was last checked for this file.

In the Perl::Metrics system all documents are identified by the hexidecimal MD5 value for their newline-localized contents.

The hex_id accessor returns this id for the file.

The metric accessor finds and returns all ::Metric object that match the hex_id of the ::File.

The Document method provides a convenient shortcut which will load the PPI::Document object for the file (while confirming the hex_id matches).

Returns a PPI::Object or dies on error.

Bugs should be reported via the CPAN bug tracker at

http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Perl-Metrics

For other issues, contact the author.

Adam Kennedy <adamk@cpan.org>

Perl::Metrics, PPI

Copyright 2005 - 2008 Adam Kennedy.

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

The full text of the license can be found in the LICENSE file included with this module.