Implemented Xlsxir.get_mda/0

taxjar · May 19, 2016 · 133331c · 133331c
1 parent cd98fc6
commit 133331c
Show file tree

Hide file tree

Showing 24 changed files with 183 additions and 83 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Change Log
 
+## 1.2.0
+
+- Added `Xlsxir` access function `Xlsxir.get_mda/0` that accesses `:worksheet` ETS table and returns an indexed map which functions like a multi-dimensional array in other languages.
+
 ## 1.1.0
 
 - Modified the way rows are saved to the `:worksheet` ETS table. Replaced the generic index with the actual row number to allow for performance imporovement of supporting  `Xlsxir` access functions.

diff --git a/OVERVIEW.md b/OVERVIEW.md
@@ -8,7 +8,7 @@ You can add Xlsxir as a dependancy to your Elixir project via the Hex package ma
 
 ```elixir
 def deps do
-  [ {:xlsxir, "~> 1.1.0"} ]
+  [ {:xlsxir, "~> 1.2"} ]
 end
 ```
 
@@ -42,13 +42,15 @@ The extracted worksheet data can be accessed using any of the following function
 ```elixir
 Xlsxir.get_list
 Xlsxir.get_map
+Xlsxir.get_mda
 Xlsxir.get_cell(cell_ref)
 Xlsxir.get_row(row_num)
 Xlsxir.get_col(col_ltr)
 Xlsxir.get_info(num_type)
 ```
 `Xlsxir.get_list/0` returns entire worksheet in a list of row lists (i.e. `[[row 1 values], ...]`)<br/>
 `Xlsxir.get_map/0` returns entire worksheet in a map of cell names and values (i.e. `%{"A1" => value, ...}`)<br/>
+`Xlsxir.get_mda/0` returns entire worksheet in an indexed map which can be accessed like a multi-dimensional array (i.e. `some_var[0][0]` for cell "A1")<br/>
 `Xlsxir.get_cell/1` returns value of specified cell (i.e. `"A1"` returns value contained in cell A1)<br/>
 `Xlsxir.get_row/1` returns values of specified row (i.e. `1` returns the first row of data)<br/>
 `Xlsxir.get_col/1` returns values of specified column (i.e. `"A"` returns the first column of data)<br/>

diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ You can add Xlsxir as a dependancy to your Elixir project via the Hex package ma
 
 ```elixir
 def deps do
-  [ {:xlsxir, "~> 1.1.0"} ]
+  [ {:xlsxir, "~> 1.2"} ]
 end
 ```
 
@@ -42,13 +42,15 @@ The extracted worksheet data can be accessed using any of the following function
 ```elixir
 Xlsxir.get_list
 Xlsxir.get_map
+Xlsxir.get_mda
 Xlsxir.get_cell(cell_ref)
 Xlsxir.get_row(row_num)
 Xlsxir.get_col(col_ltr)
 Xlsxir.get_info(num_type)
 ```
 `Xlsxir.get_list/0` returns entire worksheet in a list of row lists (i.e. `[[row 1 values], ...]`)<br/>
 `Xlsxir.get_map/0` returns entire worksheet in a map of cell names and values (i.e. `%{"A1" => value, ...}`)<br/>
+`Xlsxir.get_mda/0` returns entire worksheet in an indexed map which can be accessed like a multi-dimensional array (i.e. `some_var[0][0]` for cell "A1")<br/>
 `Xlsxir.get_cell/1` returns value of specified cell (i.e. `"A1"` returns value contained in cell A1)<br/>
 `Xlsxir.get_row/1` returns values of specified row (i.e. `1` returns the first row of data)<br/>
 `Xlsxir.get_col/1` returns values of specified column (i.e. `"A"` returns the first column of data)<br/>

diff --git a/doc/404.html b/doc/404.html
@@ -5,7 +5,7 @@
     <meta http-equiv="x-ua-compatible" content="ie=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="ExDoc v0.11.4">
-    <title>404 – Xlsxir v1.1.0</title>
+    <title>404 – Xlsxir v1.2.0</title>
     <link rel="stylesheet" href="dist/app-1e374caa3d.css" />
     <script src="dist/sidebar_items.js"></script>
   </head>
@@ -27,7 +27,7 @@ <h1 class="sidebar-projectName">
         Xlsxir
       </h1>
       <h2 class="sidebar-projectVersion">
-        v1.1.0
+        v1.2.0
       </h2>
     </div>
 

diff --git a/doc/Xlsxir.ConvertDate.html b/doc/Xlsxir.ConvertDate.html
@@ -5,7 +5,7 @@
     <meta http-equiv="x-ua-compatible" content="ie=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="ExDoc v0.11.4">
-    <title>Xlsxir.ConvertDate – Xlsxir v1.1.0</title>
+    <title>Xlsxir.ConvertDate – Xlsxir v1.2.0</title>
     <link rel="stylesheet" href="dist/app-1e374caa3d.css" />
     <script src="dist/sidebar_items.js"></script>
   </head>
@@ -27,7 +27,7 @@ <h1 class="sidebar-projectName">
         Xlsxir
       </h1>
       <h2 class="sidebar-projectVersion">
-        v1.1.0
+        v1.2.0
       </h2>
     </div>
 
@@ -59,7 +59,7 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">Xlsxir v1.1.0</small>
+        <small class="visible-xs">Xlsxir v1.2.0</small>
         Xlsxir.ConvertDate
 
 

diff --git a/doc/Xlsxir.Index.html b/doc/Xlsxir.Index.html
@@ -5,7 +5,7 @@
     <meta http-equiv="x-ua-compatible" content="ie=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="ExDoc v0.11.4">
-    <title>Xlsxir.Index – Xlsxir v1.1.0</title>
+    <title>Xlsxir.Index – Xlsxir v1.2.0</title>
     <link rel="stylesheet" href="dist/app-1e374caa3d.css" />
     <script src="dist/sidebar_items.js"></script>
   </head>
@@ -27,7 +27,7 @@ <h1 class="sidebar-projectName">
         Xlsxir
       </h1>
       <h2 class="sidebar-projectVersion">
-        v1.1.0
+        v1.2.0
       </h2>
     </div>
 
@@ -59,7 +59,7 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">Xlsxir v1.1.0</small>
+        <small class="visible-xs">Xlsxir v1.2.0</small>
         Xlsxir.Index
 
 

diff --git a/doc/Xlsxir.ParseString.html b/doc/Xlsxir.ParseString.html
@@ -5,7 +5,7 @@
     <meta http-equiv="x-ua-compatible" content="ie=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="ExDoc v0.11.4">
-    <title>Xlsxir.ParseString – Xlsxir v1.1.0</title>
+    <title>Xlsxir.ParseString – Xlsxir v1.2.0</title>
     <link rel="stylesheet" href="dist/app-1e374caa3d.css" />
     <script src="dist/sidebar_items.js"></script>
   </head>
@@ -27,7 +27,7 @@ <h1 class="sidebar-projectName">
         Xlsxir
       </h1>
       <h2 class="sidebar-projectVersion">
-        v1.1.0
+        v1.2.0
       </h2>
     </div>
 
@@ -59,7 +59,7 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">Xlsxir v1.1.0</small>
+        <small class="visible-xs">Xlsxir v1.2.0</small>
         Xlsxir.ParseString
 
 

diff --git a/doc/Xlsxir.ParseStyle.html b/doc/Xlsxir.ParseStyle.html
@@ -5,7 +5,7 @@
     <meta http-equiv="x-ua-compatible" content="ie=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="ExDoc v0.11.4">
-    <title>Xlsxir.ParseStyle – Xlsxir v1.1.0</title>
+    <title>Xlsxir.ParseStyle – Xlsxir v1.2.0</title>
     <link rel="stylesheet" href="dist/app-1e374caa3d.css" />
     <script src="dist/sidebar_items.js"></script>
   </head>
@@ -27,7 +27,7 @@ <h1 class="sidebar-projectName">
         Xlsxir
       </h1>
       <h2 class="sidebar-projectVersion">
-        v1.1.0
+        v1.2.0
       </h2>
     </div>
 
@@ -59,7 +59,7 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">Xlsxir v1.1.0</small>
+        <small class="visible-xs">Xlsxir v1.2.0</small>
         Xlsxir.ParseStyle
 
 

diff --git a/doc/Xlsxir.ParseWorksheet.html b/doc/Xlsxir.ParseWorksheet.html
@@ -5,7 +5,7 @@
     <meta http-equiv="x-ua-compatible" content="ie=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="ExDoc v0.11.4">
-    <title>Xlsxir.ParseWorksheet – Xlsxir v1.1.0</title>
+    <title>Xlsxir.ParseWorksheet – Xlsxir v1.2.0</title>
     <link rel="stylesheet" href="dist/app-1e374caa3d.css" />
     <script src="dist/sidebar_items.js"></script>
   </head>
@@ -27,7 +27,7 @@ <h1 class="sidebar-projectName">
         Xlsxir
       </h1>
       <h2 class="sidebar-projectVersion">
-        v1.1.0
+        v1.2.0
       </h2>
     </div>
 
@@ -59,7 +59,7 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">Xlsxir v1.1.0</small>
+        <small class="visible-xs">Xlsxir v1.2.0</small>
         Xlsxir.ParseWorksheet
 
 

diff --git a/doc/Xlsxir.SaxParser.html b/doc/Xlsxir.SaxParser.html
@@ -5,7 +5,7 @@
     <meta http-equiv="x-ua-compatible" content="ie=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="ExDoc v0.11.4">
-    <title>Xlsxir.SaxParser – Xlsxir v1.1.0</title>
+    <title>Xlsxir.SaxParser – Xlsxir v1.2.0</title>
     <link rel="stylesheet" href="dist/app-1e374caa3d.css" />
     <script src="dist/sidebar_items.js"></script>
   </head>
@@ -27,7 +27,7 @@ <h1 class="sidebar-projectName">
         Xlsxir
       </h1>
       <h2 class="sidebar-projectVersion">
-        v1.1.0
+        v1.2.0
       </h2>
     </div>
 
@@ -59,7 +59,7 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">Xlsxir v1.1.0</small>
+        <small class="visible-xs">Xlsxir v1.2.0</small>
         Xlsxir.SaxParser
 
 

diff --git a/doc/Xlsxir.SharedString.html b/doc/Xlsxir.SharedString.html
@@ -5,7 +5,7 @@
     <meta http-equiv="x-ua-compatible" content="ie=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="ExDoc v0.11.4">
-    <title>Xlsxir.SharedString – Xlsxir v1.1.0</title>
+    <title>Xlsxir.SharedString – Xlsxir v1.2.0</title>
     <link rel="stylesheet" href="dist/app-1e374caa3d.css" />
     <script src="dist/sidebar_items.js"></script>
   </head>
@@ -27,7 +27,7 @@ <h1 class="sidebar-projectName">
         Xlsxir
       </h1>
       <h2 class="sidebar-projectVersion">
-        v1.1.0
+        v1.2.0
       </h2>
     </div>
 
@@ -59,7 +59,7 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">Xlsxir v1.1.0</small>
+        <small class="visible-xs">Xlsxir v1.2.0</small>
         Xlsxir.SharedString
 
 

diff --git a/doc/Xlsxir.Style.html b/doc/Xlsxir.Style.html
@@ -5,7 +5,7 @@
     <meta http-equiv="x-ua-compatible" content="ie=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="ExDoc v0.11.4">
-    <title>Xlsxir.Style – Xlsxir v1.1.0</title>
+    <title>Xlsxir.Style – Xlsxir v1.2.0</title>
     <link rel="stylesheet" href="dist/app-1e374caa3d.css" />
     <script src="dist/sidebar_items.js"></script>
   </head>
@@ -27,7 +27,7 @@ <h1 class="sidebar-projectName">
         Xlsxir
       </h1>
       <h2 class="sidebar-projectVersion">
-        v1.1.0
+        v1.2.0
       </h2>
     </div>
 
@@ -59,7 +59,7 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">Xlsxir v1.1.0</small>
+        <small class="visible-xs">Xlsxir v1.2.0</small>
         Xlsxir.Style
 
 

diff --git a/doc/Xlsxir.Timer.html b/doc/Xlsxir.Timer.html
@@ -5,7 +5,7 @@
     <meta http-equiv="x-ua-compatible" content="ie=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="ExDoc v0.11.4">
-    <title>Xlsxir.Timer – Xlsxir v1.1.0</title>
+    <title>Xlsxir.Timer – Xlsxir v1.2.0</title>
     <link rel="stylesheet" href="dist/app-1e374caa3d.css" />
     <script src="dist/sidebar_items.js"></script>
   </head>
@@ -27,7 +27,7 @@ <h1 class="sidebar-projectName">
         Xlsxir
       </h1>
       <h2 class="sidebar-projectVersion">
-        v1.1.0
+        v1.2.0
       </h2>
     </div>
 
@@ -59,7 +59,7 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">Xlsxir v1.1.0</small>
+        <small class="visible-xs">Xlsxir v1.2.0</small>
         Xlsxir.Timer
 
 

diff --git a/doc/Xlsxir.Unzip.html b/doc/Xlsxir.Unzip.html
@@ -5,7 +5,7 @@
     <meta http-equiv="x-ua-compatible" content="ie=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="ExDoc v0.11.4">
-    <title>Xlsxir.Unzip – Xlsxir v1.1.0</title>
+    <title>Xlsxir.Unzip – Xlsxir v1.2.0</title>
     <link rel="stylesheet" href="dist/app-1e374caa3d.css" />
     <script src="dist/sidebar_items.js"></script>
   </head>
@@ -27,7 +27,7 @@ <h1 class="sidebar-projectName">
         Xlsxir
       </h1>
       <h2 class="sidebar-projectVersion">
-        v1.1.0
+        v1.2.0
       </h2>
     </div>
 
@@ -59,7 +59,7 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">Xlsxir v1.1.0</small>
+        <small class="visible-xs">Xlsxir v1.2.0</small>
         Xlsxir.Unzip
 
 

diff --git a/doc/Xlsxir.Worksheet.html b/doc/Xlsxir.Worksheet.html
@@ -5,7 +5,7 @@
     <meta http-equiv="x-ua-compatible" content="ie=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="ExDoc v0.11.4">
-    <title>Xlsxir.Worksheet – Xlsxir v1.1.0</title>
+    <title>Xlsxir.Worksheet – Xlsxir v1.2.0</title>
     <link rel="stylesheet" href="dist/app-1e374caa3d.css" />
     <script src="dist/sidebar_items.js"></script>
   </head>
@@ -27,7 +27,7 @@ <h1 class="sidebar-projectName">
         Xlsxir
       </h1>
       <h2 class="sidebar-projectVersion">
-        v1.1.0
+        v1.2.0
       </h2>
     </div>
 
@@ -59,7 +59,7 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">Xlsxir v1.1.0</small>
+        <small class="visible-xs">Xlsxir v1.2.0</small>
         Xlsxir.Worksheet