Class: Excel2003XML

Inherits:
GenericSpreadsheet show all
Defined in:
lib/roo/excel2003xml.rb

Defined Under Namespace

Classes: Font

Constant Summary

@@nr =
0

Instance Attribute Summary

Attributes inherited from GenericSpreadsheet

#default_sheet, #header_line

Instance Method Summary (collapse)

Methods inherited from GenericSpreadsheet

#column, #empty?, #find, #first_column, #first_column_as_letter, #first_row, #info, #last_column, #last_column_as_letter, #last_row, #reload, #remove_tmp, #row, #to_csv, #to_xml, #to_yaml

Constructor Details

- (Excel2003XML) initialize(filename, packed = nil, file_warning = :error)

initialization and opening of a spreadsheet file values for packed: :zip



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# File 'lib/roo/excel2003xml.rb', line 14

def initialize(filename, packed=nil, file_warning=:error) 
  @file_warning = file_warning
  super()
  @tmpdir = "oo_"+$$.to_s
  @tmpdir = File.join(ENV['ROO_TMP'], @tmpdir) if ENV['ROO_TMP'] 
  unless File.exists?(@tmpdir)
    FileUtils::mkdir(@tmpdir)
  end
  filename = open_from_uri(filename) if filename[0,7] == "http://"
  filename = unzip(filename) if packed and packed == :zip
  begin
    file_type_check(filename,'.xml','an Excel 2003 XML')
    @cells_read = Hash.new
    @filename = filename
    unless File.file?(@filename)
      raise IOError, "file #{@filename} does not exist"
    end
    @doc = XML::Parser.file(@filename).parse
  ensure
    FileUtils::rm_r(@tmpdir)
  end
  @default_sheet = self.sheets.first
  @cell = Hash.new
  @cell_type = Hash.new
  @formula = Hash.new
  @first_row = Hash.new
  @last_row = Hash.new
  @first_column = Hash.new
  @last_column = Hash.new
  @header_line = 1
  @style = Hash.new
  @style_defaults = Hash.new { |h,k| h[k] = [] }
  @style_definitions = Hash.new 
  read_styles
end

Instance Method Details

- (Object) cell(row, col, sheet = nil)

Returns the content of a spreadsheet-cell. (1,1) is the upper left corner. (1,1), (1,'A'), ('A',1), ('a',1) all refers to the cell at the first line and first row.



54
55
56
57
58
59
60
61
62
63
# File 'lib/roo/excel2003xml.rb', line 54

def cell(row, col, sheet=nil)
  sheet = @default_sheet unless sheet
  read_cells(sheet) unless @cells_read[sheet]
  row,col = normalize(row,col)
  if celltype(row,col,sheet) == :date
    yyyy,mm,dd = @cell[sheet][[row,col]].split('-')
    return Date.new(yyyy.to_i,mm.to_i,dd.to_i)
  end
  @cell[sheet][[row,col]]
end

- (Object) celltype(row, col, sheet = nil)

returns the type of a cell:

  • :float

  • :string

  • :date

  • :percentage

  • :formula

  • :time

  • :datetime



138
139
140
141
142
143
144
145
146
147
# File 'lib/roo/excel2003xml.rb', line 138

def celltype(row,col,sheet=nil)
  sheet = @default_sheet unless sheet
  read_cells(sheet) unless @cells_read[sheet]
  row,col = normalize(row,col)
  if @formula[sheet][[row,col]]
    return :formula
  else
    @cell_type[sheet][[row,col]]
  end
end

- (Object) font(row, col, sheet = nil)

Given a cell, return the cell's style



104
105
106
107
108
109
110
# File 'lib/roo/excel2003xml.rb', line 104

def font(row, col, sheet=nil)
  sheet = @default_sheet unless sheet
  read_cells(sheet) unless @cells_read[sheet]
  row,col = normalize(row,col)
  style_name = @style[sheet][[row,col]] || @style_defaults[sheet][col - 1] || 'Default'
  @style_definitions[style_name]
end

- (Object) formula(row, col, sheet = nil)

Returns the formula at (row,col). Returns nil if there is no formula. The method #formula? checks if there is a formula.



68
69
70
71
72
73
74
75
76
77
# File 'lib/roo/excel2003xml.rb', line 68

def formula(row,col,sheet=nil)
  sheet = @default_sheet unless sheet
  read_cells(sheet) unless @cells_read[sheet]
  row,col = normalize(row,col)
  if @formula[sheet][[row,col]] == nil
    return nil
  else
    return @formula[sheet][[row,col]]["oooc:".length..-1]
  end
end

- (Boolean) formula?(row, col, sheet = nil)

true, if there is a formula



80
81
82
83
84
85
# File 'lib/roo/excel2003xml.rb', line 80

def formula?(row,col,sheet=nil)
  sheet = @default_sheet unless sheet
  read_cells(sheet) unless @cells_read[sheet]
  row,col = normalize(row,col)
  formula(row,col) != nil
end

- (Object) formulas(sheet = nil)

returns each formula in the selected sheet as an array of elements

row, col, formula


179
180
181
182
183
184
185
186
187
188
189
190
191
192
# File 'lib/roo/excel2003xml.rb', line 179

def formulas(sheet=nil)
  theformulas = Array.new
  sheet = @default_sheet unless sheet
  read_cells(sheet) unless @cells_read[sheet]
  first_row(sheet).upto(last_row(sheet)) {|row|
    first_column(sheet).upto(last_column(sheet)) {|col|
      if formula?(row,col,sheet)
        f = [row, col, formula(row,col,sheet)]
        theformulas << f
      end
    }
  }
  theformulas
end

- (Object) officeversion

version of the openoffice document at 2007 this is always “1.0”



159
160
161
162
# File 'lib/roo/excel2003xml.rb', line 159

def officeversion
  oo_version
  @officeversion
end

- (Object) save

save spreadsheet



173
174
175
# File 'lib/roo/excel2003xml.rb', line 173

def save #:nodoc:
  42
end

- (Object) set(row, col, value, sheet = nil)

set a cell to a certain value (this will not be saved back to the spreadsheet file!)



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
# File 'lib/roo/excel2003xml.rb', line 114

def set(row,col,value,sheet=nil) #:nodoc:
  sheet = @default_sheet unless sheet
  read_cells(sheet) unless @cells_read[sheet]
  row,col = normalize(row,col)
  set_value(row,col,value,sheet)
  if value.class == Fixnum
    set_type(row,col,:float,sheet)
  elsif value.class == String
    set_type(row,col,:string,sheet)
  elsif value.class == Float
    set_type(row,col,:string,sheet)
  else
    raise ArgumentError, "Type for "+value.to_s+" not set"
  end
end

- (Object) sheets



149
150
151
152
153
154
155
# File 'lib/roo/excel2003xml.rb', line 149

def sheets
  return_sheets = []
  @doc.find("//ss:Worksheet").each do |sheet|
    return_sheets << sheet.attributes['Name']
  end
  return_sheets
end

- (Object) to_s(sheet = nil)

shows the internal representation of all cells mainly for debugging purposes



166
167
168
169
170
# File 'lib/roo/excel2003xml.rb', line 166

def to_s(sheet=nil)
  sheet = @default_sheet unless sheet
  read_cells(sheet) unless @cells_read[sheet]
  @cell[sheet].inspect
end