Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nabehiro/TableIO
TableIO provides common interaface for reading and writing CSV, Excel and other table format content.
https://github.com/nabehiro/TableIO
Last synced: about 2 months ago
JSON representation
TableIO provides common interaface for reading and writing CSV, Excel and other table format content.
- Host: GitHub
- URL: https://github.com/nabehiro/TableIO
- Owner: nabehiro
- License: apache-2.0
- Created: 2016-12-29T01:13:02.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2021-01-23T16:05:02.000Z (almost 4 years ago)
- Last Synced: 2024-10-08T18:29:04.262Z (2 months ago)
- Language: C#
- Homepage:
- Size: 1.45 MB
- Stars: 21
- Watchers: 3
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred-test - nabehiro/TableIO - TableIO provides common interaface for reading and writing CSV, Excel and other table format content. (C# #)
README
# TableIO
TableIO provides common interaface for reading and writing CSV, TSV, Excel and other table format content.
# Nuget
[TableIO](https://www.nuget.org/packages/TableIO/)
provides core functionality, reading and writing CSV, TSV file.
```
PM> Install-Package TableIO
```
[TableIO.ClosedXml](https://www.nuget.org/packages/TableIO.ClosedXml)
provides reading and writing Excel(xlsx only) file.
TableIO.ClosedXml depends on ClosedXml and TableIO.
```
PM> Install-Package TableIO.ClosedXml
```
# How to use
## Read and Write CSV, TSV
```csharp
using TableIO;
class Model
{
public int Id { get; set; }
public string Name { get; set; }
public decimal Price { get; set; }
public string Remarks { get; set; }
}
// CSV
public void CSV()
{
IList models = null;
// read all rows into a array.
using (var stmReader = new StreamReader("readfile.csv"))
{
// parameters is (textReader, hasHeader)
var tableReader = new TableFactory().CreateCsvReader(stmReader, true);
var models = tableReader.Read().ToArray();
Assert.AreEqual(5, models.Count);
Assert.AreEqual(1, model[0].Id);
}
// read row by row.(yield results)
using (var stmReader = new StreamReader("readfile.csv"))
{
var tableReader = new TableFactory().CreateCsvReader(stmReader, true);
foreach (var model in tableReader.Read())
{
Console.WriteLine(model.Id);
}
}
// write models to file.
using (var stmWriter = new StreamWriter("writefile.csv"))
{
var tableWriter = new TableFactory().CreateCsvWriter(stmWriter);
// parameter is (models, header)
tableWriter.Write(models, new[] { "ID", "NAME", "PRICE", "REMARKS" });
}
}
// TSV
public void TSV()
{
IList models = null;
using (var stmReader = new StreamReader("readfile.tsv"))
{
var tableReader = new TableFactory().CreateTsvReader(stmReader, true);
var models = tableReader.Read().ToArray();
Assert.AreEqual(5, models.Count);
Assert.AreEqual(1, model[0].Id);
}
using (var stmWriter = new StreamWriter("writefile.tsv"))
{
var tableWriter = new TableFactory().CreateTsvWriter(stmWriter);
tableWriter.Write(models, new[] { "ID", "NAME", "PRICE", "REMARKS" });
}
}
```
## Read and Write Excel
```csharp
using TableIO;
using TableIO.ClosedXml; // nuget TableIO.ClosedXml
class Model
{
public int Id { get; set; }
public string Name { get; set; }
public decimal Price { get; set; }
public string Remarks { get; set; }
}
public void EXCEL()
{
IList models = null;
// read file to models.
using (var workbook = new XLWorkbook("readfile.xlsx"))
{
var worksheet = workbook.Worksheet(1);
// parameters is (worksheet, startRowNumber, startColumnNumber, columnSize, hasHeader)
var tableReader = new TableFactory().CreateXlsxReader(worksheet, 1, 1, 4, true);
var models = tableReader.Read();
Assert.AreEqual(5, models.Count);
Assert.AreEqual(1, model[0].Id);
}
// write models to file.
using (var workbook = new XLWorkbook())
{
var worksheet = workbook.Worksheets.Add("sample");
// parameters is (worksheet, startRowNumber, startColumnNuber)
var tableWriter = new TableFactory().CreateXlsxWriter(worksheet, 1, 1);
// parameter is (models, header)
tableWriter.Write(models, new[] { "ID", "NAME", "PRICE", "REMARKS" });
workbook.SaveAs("writefile.xlsx");
}
}
```
# Design
TableReader and TableWriter consists of some interfaces that have single work responsiblity.
We can replace a concrete class that impliment interface with prefer one as you like !
## IRowReader
IRowReader reads table row by row.
## IRowWriter
IRowWriter writes row to table.
## IPropertyMapper
IPropertyMapper maps class property to table column index.
### AutoIndexPropertyMapper (Default)
Mapping rules are that column index is class property definition order.
```csharp
class Model
{
public int Id { get; set; } // assign to 0 column index.
public string Name { get; set; } // assign to 1 column index.
public decimal Price { get; set; } // assign to 2 column index.
public string Remarks { get; set; } // assign to 3 column index.
}
...
var mapper = new AutoIndexPropertyMapper();
var tableReader = new TableFactory().CreateCsvReader(textReader, propertyMapper:mapper);
```
### ManualIndexPropertyMapper
Mapping rules are indicated by manual.
```csharp
class Model
{
public int Id { get; set; }
public string Name { get; set; }
public decimal Price { get; set; }
public string Remarks { get; set; }
}
...
var mapper = new ManualIndexPropertyMapper()
.Map(m => m.Id, 11)
.Map(m => m.Name, 10)
.Map(m => m.Remarks, 0);
var tableReader = new TableFactory().CreateCsvReader(textReader, propertyMapper:mapper);
```
## IModelValidator
IModelValidator validates model that is generated from table row while reading table.
### NullModelValidator (Default)
NullModelValidator doesn't validate.
### DefaultModelValidator
DefaultModelValidator validates model using DataAnnotations attribute and System.ComponentModel.DataAnnotations.Validator.
```csharp
var validator = new DefaultModelValidator();
var tableReader = new TableFactory().CreateCsvReader(textReader, modelValidator:validator);
```
## ITypeConverter
ITypeConverter convert from table field to class property or convert from class property to table field.
## ITypeConverterResolver
ITypeConverterResolver provide appropriate ITypeConverter for class property.