NAME

Spreadsheet::XLSX::Reader::LibXML::XMLReader::CalcChain - A LibXML::Reader calcChain base class

SYNOPSIS

See General SYNOPSIS

DESCRIPTION

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

This class is used to access the sub file calcChain.xml from an unzipped .xlsx file. The file to be read is generally found in the xl/ sub folder after the master file is unzipped. The calcChain.xml file contains the calculation sequence and data source(s) used when building the value for cells with formulas. (The formula presented in the Cell instance is collected from somewhere else.)

This particular class uses the XML::LibXML::Reader to parse the file. The intent with that reader is to maintain the minimum amount of the file in working memory. As a consequence two things are sacrificed. First this implementation will read the file serially. This means that to read a previous element the file must start over at the beginning. Second, the connection between the XMLReader and the file is broken to rewind the file pointer. In an effort to minimize this pain the system file 'open' function is handled in a separate file handle variable so that a new system open is not required on each rewind. For information regarding necessary steps to replace this package review the general documentation

This is a child class that both inherits from a parent and collates a role for full functional implementation. Read the documentation for each of them as well as this documentation to gain a complete picture of this class.

extends

This is the parent class of this class

Spreadsheet::XLSX::Reader::LibXML::XMLReader

with

These are attached roles for additional (re-used) functionality

Spreadsheet::XLSX::Reader::LibXML::XMLReader::XMLToPerlData

Primary Functions

These are the primary way(s) to use this class.

get_calc_chain_position( $integer )

Definition: This will return the calcChain information from the identified $integer position. (Counting from zero). The information is returned as a perl hash ref.

Accepts: an $integer for the calcChain position

Returns: a hash ref of data