File Coverage

blib/lib/Spreadsheet/WriteExcel/FromXML/Worksheet.pm

Criterion	Covered	Total	%
statement	12	91	13.1
branch	0	48	0.0
condition	0	8	0.0
subroutine	4	16	25.0
pod	1	11	9.0
total	17	174	9.7

package Spreadsheet::WriteExcel::FromXML::Worksheet;
use strict;
use warnings;

our $VERSION = '1.1';

use Carp qw(confess cluck);
use Data::Dumper;
=head1 NAME

Spreadsheet::WriteExcel::FromXML::Worksheet

=head1 SYNOPSIS

  # inner class for use by FromXML

=head1 DESCRIPTION

Workbook object for FromXML.

=head1 API REFERENCE

=cut

sub new
{
  my $this  = shift;
  my $class = ref($this) || $this;
  my $self  = {};
  $self->{ranges} = [];
  bless $self,$class;
  $self->_init( @_ );
  return $self;
}

sub _init
{
  my($self,$excelWorksheet) = @_;
  unless( $excelWorksheet && UNIVERSAL::isa($excelWorksheet,'Spreadsheet::WriteExcel::Worksheet') ) {
    confess "Must pass a Spreadsheet::WriteExcel::Worksheet to constructor\n";
  }
  $self->{'_excelWorksheet'} = $excelWorksheet;
  $self->cells( [[]] );
  $self->dataTypeMethods( [] );
  $self->formats( [] );
}

=head2 addDataType

Supported data types from Speadsheet::WriteExcel:

  write()
  write_number()
  write_string()
  write_blank()
  write_row()
  write_col()
  write_url()
  write_url_range()
  write_formula()

=cut
sub addDataType
{
  my($self,$datatype,$x,$y) = @_;
  if( 'string' eq $datatype )
  {
    $self->dataTypeMethods->[$x][$y] = 'write_string';
  }
  elsif( 'number' eq $datatype )
  {
    $self->dataTypeMethods->[$x][$y] = 'write_number';
  }
  elsif( 'url' eq $datatype )
  {
    $self->dataTypeMethods->[$x][$y] = 'write_url';
  }
  elsif( 'formula' eq $datatype )
  {
    $self->dataTypeMethods->[$x][$y] = 'write_formula';
  }
  elsif( 'blank' eq $datatype )
  {
    $self->dataTypeMethods->[$x][$y] = 'write_blank';
  }
  else
  {
    cluck "unknown data type '$datatype' defaulting to write.\n";
    $self->dataTypeMethods->[$x][$y] = 'write_string';
  }
}

sub addFormat
{
  my($self,$format,$x,$y) = @_;
  $self->formats->[$x][$y] = undef;
  $self->formats->[$x][$y] = $format if ( $format );
}

sub addCell
{
  my($self,$data,$datatype,$x,$y,$format) = @_;
  # print STDERR "Adding '",($data||''),"' to cell $$x $$y\n";
  $self->cells->[$$x][$$y] = $data||'';
  $self->addDataType( $datatype,$$x,$$y );
  $self->addFormat( $format,$$x,$$y );
}

sub addRange
{
  my ($self, $first_col, $last_col, $width, $format, $hidden, $level) = @_;
  my $args = {'first_col' => $first_col, 'last_col' => $last_col, 'width' => $width,
           'format' => $format, 'hidden' => $hidden, 'level' => $level};
  push(@{$self->{ranges}}, $args);
}

sub setMargins
{
  my ($self, $margin, $lr, $tb, $left, $right, $top, $bottom) = @_;
  $self->excelWorksheet->set_margins($margin) if defined($margin);
  $self->excelWorksheet->set_margins_LR($lr) if defined($lr);
  $self->excelWorksheet->set_margins_TB($tb) if defined($tb);
  $self->excelWorksheet->set_margin_left($left) if defined($left);
  $self->excelWorksheet->set_margin_right($right) if defined($right);
  $self->excelWorksheet->set_margin_top($top) if defined($top);
  $self->excelWorksheet->set_margin_bottom($bottom) if defined($bottom);
}


sub buildWorksheet
{
  my($self,$excelFormats) = @_;

  for ( my $x = 0; $x < @{$self->{ranges}}; $x++) {
    if (${$self->{ranges}}[$x]) {
      my $range = ${$self->{ranges}}[$x];
      my $format = $range->{format};
      my $first_col = $range->{first_col};
      my $last_col = $range->{last_col};
      my $width  = $range->{width};
      my $hidden = $range->{hidden};
      my $level = $range->{level};
      my $formatName = $format;
      if( $formatName ) {
        unless( exists $excelFormats->{ $formatName } )
        {
          cluck "format '$formatName' does not exist!  Ignoring.\n";
        } else
        {
          $format = $excelFormats->{ $formatName };
        }
      }
      $self->excelWorksheet->set_column($first_col, $last_col, $width, $hidden, $level, $format);
    }
  }

  for( my $i = 0; $i < @{ $self->cells }; ++$i ) {
    if( $self->cells->[$i] ) {
      for( my $j = 0; $j < @{ $self->cells->[$i] }; ++$j ) {
        my $formatName = $self->formats->[$i][$j];
        my $format = undef;
        if( $formatName ) {
        unless( exists $excelFormats->{ $formatName } )
	    {
          cluck "format '$formatName' does not exist!  Ignoring.\n";
	  } else
	  {
	    $format = $excelFormats->{ $formatName };
	  }
	}

        my $dataTypeMethod = $self->dataTypeMethods->[$i][$j];
        #print "$dataTypeMethod writing $i x  $j - '",$self->cells->[$i][$j],"' with format: " . Dumper($format) ."\n";

        # Hack as current write_blank code isn't working as expected.
		#  Hack disabled for external use [we use it internally] but needs to be investigated
        #if ($dataTypeMethod eq 'write_blank') {
        #  $self->cells->[$i][$j] =  undef;
        #  $dataTypeMethod = 'write_string';
        #}
        $self->excelWorksheet->$dataTypeMethod( $i, $j, $self->cells->[$i][$j], $format );

      }
    # blank row
    } else {
      $self->excelWorksheet->write_string( $i, 0, '' );
    }
  }
}

sub excelWorksheet  { @_>1 ? $_[0]->{'_excelWorksheet'} = $_[1] : $_[0]->{'_excelWorksheet'}; }
sub cells           { @_>1 ? $_[0]->{'_cells'} = $_[1] : $_[0]->{'_cells'}; }
sub dataTypeMethods { @_>1 ? $_[0]->{'_dataTypeMethods'} = $_[1] : $_[0]->{'_dataTypeMethods'}; }
sub formats         { @_>1 ? $_[0]->{'_formats'} = $_[1] : $_[0]->{'_formats'}; }

1;

=head1 SEE ALSO

SpreadSheet::WriteExcel::FromXML

=head1 AUTHORS

W. Justin Bedard [e-mail]

Kyle R. Burton [e-mail], [e-mail]

=cut