NAME
Spreadsheet::Reader::ExcelXML::WorkbookFileInterface - XLSX and XML workbook file interface
SYNOPSIS
use MooseX::ShortCut::BuildInstance v1.8 qw( build_instance );
use Spreadsheet::Reader::ExcelXML::WorkbookFileInterface;
use Spreadsheet::Reader::ExcelXML::ZipReader;
my $test_file = 'TestBook.xlsx';
my $test_instance = build_instance(
package => 'ZipWorkbookFileInterface',
superclasses => ['Spreadsheet::Reader::ExcelXML::ZipReader'],
file => $test_file,
add_roles_in_sequence =>[
'Spreadsheet::Reader::ExcelXML::WorkbookFileInterface',
],
);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 workbook files 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 two most likely base classes for this interface are;
Spreadsheet::Reader::ExcelXML::ZipReader
Spreadsheet::Reader::ExcelXML::XMLReader
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 the ~::XMLReader.
"get_file_type" in Spreadsheet::Reader::ExcelXML::ZipReader
"loaded_correctly" in Spreadsheet::Reader::ExcelXML::ZipReader
"extract_file( $zip_sub_file )" in Spreadsheet::Reader::ExcelXML::ZipReader
SUPPORT
TODO
1. Nothing currently
AUTHOR
COPYRIGHT
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.
This software is copyrighted (c) 2016 by Jed Lund
DEPENDENCIES
Spreadsheet::Reader::ExcelXML - the package
SEE ALSO
Spreadsheet::Read - generic Spreadsheet reader
Spreadsheet::ParseExcel - Excel binary version 2003 and earlier (.xls files)
Spreadsheet::XLSX - Excel version 2007 and later
Spreadsheet::ParseXLSX - Excel version 2007 and later
All lines in this package that use Log::Shiras are commented out