NAME

Data::TableReader::Decoder - Base class for table decoders

VERSION

version 0.001

DESCRIPTION

This is an abstract base class describing the API for decoders.

A decoder's job is to iterate table rows of a file containing tabular data. If a file provides multiple tables of data (such as worksheets, or <TABLE> tags) then the decode should also support the "next_dataset" method.

ATTRIBUTES

filename

Set by TableReader. Useful for logging.

file_handle

Set by TableReader. This is what the iterator should parse.

log

Set by TableReader. Unlike the attribute of the same name on TableReader, this is always a coderef, to be called as:

$log->($level, $message);

iterator

This lazy-builds the iterator from "_build_iterator"

METHODS

_build_iterator

This must be implemented by the subclass, to return an instance of Data::TableReader::Iterator. The iterator should return an arrayref each time it is called. The iterator may also accept a single argument of a list of columns to retrieve, rather than retrieving the full row.

AUTHOR

Michael Conrad <mike@nrdvana.net>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by Michael Conrad.

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