NAME

Spreadsheet::Reader::ExcelXML::WorkbookMetaInterface - Workbook meta file interface

SYNOPSIS

For a fully functioning example see examples/Spreadsheet/Reader/ExcelXML/workbook_meta_example.pl

        use MooseX::ShortCut::BuildInstance qw( build_instance );
        use Spreadsheet::Reader::ExcelXML::XMLReader;
        use Spreadsheet::Reader::ExcelXML::ZipReader::WorkbookMeta;
        use Spreadsheet::Reader::ExcelXML::WorkbookMetaInterface; # Optional
        $meta_instance = build_instance(
                superclasses    => ['Spreadsheet::Reader::ExcelXML::XMLReader'],
                add_roles_in_sequence =>[
                        'Spreadsheet::Reader::ExcelXML::ZipReader::WorkbookMeta',
                        'Spreadsheet::Reader::ExcelXML::WorkbookMetaInterface',
                ],
                file => $file_handle,# Should be a handle built with 'xl/workbook.xml' from a zip file
        );
        $meta_instance->get_epoch_year;

        ###########################
        # SYNOPSIS Screen Output
        # 01: 1904
        ###########################

DESCRIPTION

This documentation is written to explain ways to use this module when writing your own excel parser. To use the general package for excel parsing out of the box please review the documentation for Workbooks, Worksheets, and Cells

This module (role) is provided as a way to standardize access to or interface with base meta data files containing workbook level information accross zip and flat xml types. It doesn't provide any functionality itself it just provides requirements for any built classes so a consumer of this interface will be able to use a consistent interface. The base class will generally be;

Spreadsheet::Reader::ExcelXML::XMLReader

The unique functionality is generally provided by;

Spreadsheet::Reader::ExcelXML::ZipReader::WorkbookMeta

Spreadsheet::Reader::ExcelXML::XMLReader::WorkbookMeta

Required Methods

These are the methods required by the role. A link to the Zip implementation of these methods is provided. The XML versions are documented in ~::XMLReader::WorkbookMeta.

"get_epoch_year" in Spreadsheet::Reader::ExcelXML::ZipReader::WorkbookMeta

"get_sheet_list" in Spreadsheet::Reader::ExcelXML::ZipReader::WorkbookMeta

"get_sheet_lookup" in Spreadsheet::Reader::ExcelXML::ZipReader::WorkbookMeta

"get_rel_lookup" in Spreadsheet::Reader::ExcelXML::ZipReader::WorkbookMeta

"get_id_lookup" in Spreadsheet::Reader::ExcelXML::ZipReader::WorkbookMeta

"loaded_correctly" in Spreadsheet::Reader::ExcelXML::XMLReader