NAME

Spreadsheet::Reader::ExcelXML::WorkbookRelsInterface - Workbook rels file interface

SYNOPSIS

        #!/usr/bin/env perl
        use Data::Dumper;
        use MooseX::ShortCut::BuildInstance qw( build_instance );
        use Types::Standard qw( HashRef );
        use Spreadsheet::Reader::ExcelXML::XMLReader;
        use Spreadsheet::Reader::ExcelXML::ZipReader::WorkbookRels;
        use Spreadsheet::Reader::ExcelXML::WorkbookRelsInterface;
        my      $test_file = 't/test_files/xl/_rels/workbook.xml.rels';
        my      $workbook_instance = build_instance(
                        package => 'Spreadsheet::Reader::ExcelXML::Workbook',
                        add_attributes =>{
                                _rel_lookup =>{
                                        isa             => HashRef,
                                        traits  => ['Hash'],
                                        handles =>{ get_rel_info => 'get', },
                                        default => sub{ {
                                                'rId2' => 'Sheet5',
                                                'rId3' => 'Sheet1',
                                                'rId1' => 'Sheet2'
                                        } },
                                },
                                _sheet_lookup =>{
                                        isa             => HashRef,
                                        traits  => ['Hash'],
                                        handles =>{ get_sheet_info => 'get', },
                                        default => sub{ {
                                                'Sheet1' => {
                                                        'sheet_id' => '1',
                                                        'sheet_position' => 2,
                                                        'sheet_name' => 'Sheet1',
                                                        'is_hidden' => 0,
                                                        'sheet_rel_id' => 'rId3'
                                                },
                                                'Sheet2' => {
                                                        'sheet_position' => 0,
                                                        'sheet_name' => 'Sheet2',
                                                        'sheet_id' => '2',
                                                        'sheet_rel_id' => 'rId1',
                                                        'is_hidden' => 0
                                                },
                                                'Sheet5' => {
                                                        'sheet_position' => 1,
                                                        'sheet_name' => 'Sheet5',
                                                        'sheet_id' => '3',
                                                        'sheet_rel_id' => 'rId2',
                                                        'is_hidden' => 1
                                                }
                                        } },
                                },
                        },
                        add_methods =>{
                                get_sheet_names => sub{ [
                                        'Sheet2',
                                        'Sheet5',
                                        'Sheet1'
                                ] },
                        }
                );
        my      $test_instance =  build_instance(
                        package => 'WorkbookRelsInterface',
                        superclasses => ['Spreadsheet::Reader::ExcelXML::XMLReader'],
                        add_roles_in_sequence =>[
                                'Spreadsheet::Reader::ExcelXML::ZipReader::WorkbookRels',
                                'Spreadsheet::Reader::ExcelXML::WorkbookRelsInterface',
                        ],
                        file => $test_file,
                        workbook_inst => $workbook_instance,
                );
        print Dumper( $rels_instance->get_worksheet_list );

        ###########################
        # SYNOPSIS Screen Output
        # 01: $VAR1 = [
        # 01:   'Sheet2',
        # 01:   'Sheet5',
        # 01:   'Sheet1'
        # 01: ]
        ###########################

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 rels data files containing workbook level relationships between zip sub file 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::WorkbookRels

Spreadsheet::Reader::ExcelXML::XMLReader::WorkbookRels

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::WorkbookRels.

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

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

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

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

SUPPORT

github Spreadsheet::Reader::ExcelXML/issues

TODO

1. Nothing currently

AUTHOR

Jed Lund

jandrew@cpan.org

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

Log::Shiras

All lines in this package that use Log::Shiras are commented out

cpanm Spreadsheet::Reader::ExcelXML

perl -MCPAN -e shell
install Spreadsheet::Reader::ExcelXML