Skip to content

Commit bdd19c2

Browse files
authored
docs: Complete FastExcel to FesodSheet rename (#694)
* docs: Fix remaining issues from FastExcel to FesodSheet rename * docs: Update README files with terminology changes * docs: Update repository description
1 parent efe89d7 commit bdd19c2

File tree

8 files changed

+33
-33
lines changed

8 files changed

+33
-33
lines changed

.asf.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
# All configurations could be found here: https://github.com/apache/infrastructure-asfyaml/
1919

2020
github:
21-
description: "Fast. Easy. Done. Processing Excels without worrying about large files causing OOM."
21+
description: "Fast. Easy. Done. Processing spreadsheets without worrying about large files causing OOM."
2222
homepage: https://fesod.apache.org
2323
labels:
2424
- java

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -39,23 +39,23 @@
3939

4040
## Introduction
4141

42-
**Apache Fesod (Incubating)** is a high-performance and memory-efficient Java library for reading and writing Excel
42+
**Apache Fesod (Incubating)** is a high-performance and memory-efficient Java library for reading and writing spreadsheet
4343
files, designed to simplify development and ensure reliability.
4444

4545
Apache Fesod (Incubating) can provide developers and enterprises with great freedom and flexibility. We plan to
4646
introduce more new features in the future to continually enhance user experience and tool usability. Apache Fesod (
47-
Incubating) is committed to being your best choice for handling Excel files.
47+
Incubating) is committed to being your best choice for handling spreadsheet files.
4848

4949
The name fesod(pronounced `/ˈfɛsɒd/`), an acronym for "fast easy spreadsheet and other documents" expresses the
5050
project's origin, background and vision.
5151

5252
### Features
5353

5454
- **High-performance Reading and Writing**: Apache Fesod (Incubating) focuses on performance optimization, capable of
55-
efficiently handling large-scale Excel data. Compared to some traditional Excel processing libraries, it can
55+
efficiently handling large-scale spreadsheet data. Compared to some traditional spreadsheet processing libraries, it can
5656
significantly reduce memory consumption.
5757
- **Simplicity and Ease of Use**: The library offers a simple and intuitive API, allowing developers to easily integrate
58-
it into projects, whether for simple Excel operations or complex data processing.
58+
it into projects, whether for simple spreadsheet operations or complex data processing.
5959
- **Stream Operations**: Apache Fesod (Incubating) supports stream reading, minimizing the problem of loading large
6060
amounts of data at once. This design is especially important when dealing with hundreds of thousands or even millions
6161
of rows of data.
@@ -101,7 +101,7 @@ dependencies {
101101

102102
### Read
103103

104-
Below is an example of reading an Excel document:
104+
Below is an example of reading a spreadsheet document:
105105

106106
```java
107107
// Implement the ReadListener interface to set up operations for reading data
@@ -120,14 +120,14 @@ public class DemoDataListener implements ReadListener<DemoData> {
120120

121121
public static void main(String[] args) {
122122
String fileName = "demo.xlsx";
123-
// Read Excel file
124-
Fesod.read(fileName, DemoData.class, new DemoDataListener()).sheet().doRead();
123+
// Read spreadsheet file
124+
FesodSheet.read(fileName, DemoData.class, new DemoDataListener()).sheet().doRead();
125125
}
126126
```
127127

128128
### Write
129129

130-
Below is a simple example of creating an Excel document:
130+
Below is a simple example of creating a spreadsheet document:
131131

132132
```java
133133
// Sample data class
@@ -162,7 +162,7 @@ private static List<DemoData> data() {
162162
public static void main(String[] args) {
163163
String fileName = "demo.xlsx";
164164
// Create a "Template" sheet and write data
165-
Fesod.write(fileName, DemoData.class).sheet("Template").doWrite(data());
165+
FesodSheet.write(fileName, DemoData.class).sheet("Template").doWrite(data());
166166
}
167167
```
168168

README_CN.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,16 +38,16 @@
3838

3939
## 简介
4040

41-
**Apache Fesod (Incubating)** 是一个高性能、内存高效的 Java 库,用于读写 Excel 文件,旨在简化开发并确保可靠性。
41+
**Apache Fesod (Incubating)** 是一个高性能、内存高效的 Java 库,用于读写电子表格文件,旨在简化开发并确保可靠性。
4242

43-
Apache Fesod (Incubating) 可以为开发者和企业提供极大的自由度和灵活性。我们计划在未来引入更多新功能,以持续提升用户体验和工具可用性。Apache Fesod (Incubating) 致力于成为您处理 Excel 文件的最佳选择
43+
Apache Fesod (Incubating) 可以为开发者和企业提供极大的自由度和灵活性。我们计划在未来引入更多新功能,以持续提升用户体验和工具可用性。Apache Fesod (Incubating) 致力于成为您处理电子表格文件的最佳选择
4444

4545
名称 fesod(发音为 `/ˈfɛsɒd/`),是 "fast easy spreadsheet and other documents"(快速简单的电子表格和其他文档)的首字母缩写,表达了项目的起源、背景和愿景。
4646

4747
### 特性
4848

49-
- **高性能读写**:Apache Fesod (Incubating) 专注于性能优化,能够高效处理大规模 Excel 数据。与一些传统的 Excel 处理库相比,它可以显著减少内存消耗。
50-
- **简单易用**:该库提供了简单直观的 API,使开发者能够轻松将其集成到项目中,无论是简单的 Excel 操作还是复杂的数据处理
49+
- **高性能读写**:Apache Fesod (Incubating) 专注于性能优化,能够高效处理大规模电子表格数据。与一些传统的电子表格处理库相比,它可以显著减少内存消耗。
50+
- **简单易用**:该库提供了简单直观的 API,使开发者能够轻松将其集成到项目中,无论是简单的电子表格操作还是复杂的数据处理
5151
- **流式操作**:Apache Fesod (Incubating) 支持流式读取,最大程度地减少一次性加载大量数据的问题。这一设计在处理数十万甚至数百万行数据时尤其重要。
5252

5353
## 安装
@@ -85,7 +85,7 @@ dependencies {
8585

8686
### 读取
8787

88-
以下是读取 Excel 文档的示例
88+
以下是读取电子表格文档的示例
8989

9090
```java
9191
// 实现 ReadListener 接口以设置读取数据的操作
@@ -104,14 +104,14 @@ public class DemoDataListener implements ReadListener<DemoData> {
104104

105105
public static void main(String[] args) {
106106
String fileName = "demo.xlsx";
107-
// 读取 Excel 文件
108-
Fesod.read(fileName, DemoData.class, new DemoDataListener()).sheet().doRead();
107+
// 读取电子表格文件
108+
FesodSheet.read(fileName, DemoData.class, new DemoDataListener()).sheet().doRead();
109109
}
110110
```
111111

112112
### 写入
113113

114-
以下是创建 Excel 文档的简单示例
114+
以下是创建电子表格文档的简单示例
115115

116116
```java
117117
// 示例数据类
@@ -146,7 +146,7 @@ private static List<DemoData> data() {
146146
public static void main(String[] args) {
147147
String fileName = "demo.xlsx";
148148
// 创建一个名为 "Template" 的工作表并写入数据
149-
Fesod.write(fileName, DemoData.class).sheet("Template").doWrite(data());
149+
FesodSheet.write(fileName, DemoData.class).sheet("Template").doWrite(data());
150150
}
151151
```
152152

website/docs/introduce.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ public class DemoDataListener implements ReadListener<DemoData> {
5454
public static void main(String[] args) {
5555
String fileName = "demo.xlsx";
5656
// Read file
57-
Fesod.read(fileName, DemoData.class, new DemoDataListener()).sheet().doRead();
57+
FesodSheet.read(fileName, DemoData.class, new DemoDataListener()).sheet().doRead();
5858
}
5959
```
6060

website/docs/sheet/help/large-data.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ When reading files larger than 10 MB, Microsoft Excel 03 is unable to handle the
1313
memory. Microsoft Excel 2007 introduces the concept
1414
of [Shared Strings](https://learn.microsoft.com/en-us/office/open-xml/spreadsheet/working-with-the-shared-string-table),
1515
which can consume a significant amount of memory.
16-
If all shared strings are loaded into memory, the memory usage can be approximately 3 to 10 times the size of the Excel
16+
If all shared strings are loaded into memory, the memory usage can be approximately 3 to 10 times the size of the spreadsheet
1717
file. Therefore, FesodSheet uses a strategy of first storing the file and then deserialising it to read the data,
1818
thereby
1919
saving memory. Of course, after deserialising the file, efficiency will decrease by approximately 30-50% (this is not
2020
fixed and depends on the hit rate, which may exceed 100%).
2121

2222
If the read efficiency is acceptable, use the default setting. The permanent memory usage (for the entire process of
23-
reading a single Excel file) generally does not exceed 50MB (most likely around 30MB), and the remaining temporary
23+
reading a single spreadsheet file) generally does not exceed 50MB (most likely around 30MB), and the remaining temporary
2424
memory is quickly recycled by the garbage collector.
2525

2626
### Default Policy
@@ -34,18 +34,18 @@ read an extremely large file.
3434
### Configure Memory
3535

3636
If you want to customise the settings, first determine how much memory you are willing to allocate for reading a very
37-
large Excel file.
38-
For example, if you want the Excel file to occupy a maximum of 100MB of memory during the reading process (this is the
37+
large spreadsheet file.
38+
For example, if you want the spreadsheet file to occupy a maximum of 100MB of memory during the reading process (this is the
3939
permanent memory usage during reading, not including memory immediately reclaimed by the young generation), then set the
4040
size of the shared string stored in the file to 20MB (less than 20MB is stored in memory, more than 20MB is stored in a
4141
temporary file), and then set the memory size occupied by the temporary shared string when stored in the file to
4242
approximately 90MB.
4343

44-
If the maximum number of file entries is only a few hundred thousand, and the Excel file is only a few dozen megabytes,
44+
If the maximum number of file entries is only a few hundred thousand, and the spreadsheet file is only a few dozen megabytes,
4545
and there is no high concurrency, and memory is sufficient,
4646

4747
```java
48-
// Force memory storage, so a 20M Excel file will use 150M of memory (many temporary objects, so 100M will be constantly GC'd).
48+
// Force memory storage, so a 20M spreadsheet file will use 150M of memory (many temporary objects, so 100M will be constantly GC'd).
4949
// This will be much more efficient than the complex strategy above.
5050
// Just to clarify, all I did was add the readCache(new MapCache()) parameter. For the rest, refer to other examples.
5151
FesodSheet.read().
@@ -58,7 +58,7 @@ High concurrency requirements, and often involve extremely large files.
5858
```java
5959
// The first parameter specifies how many MB of shared string data will be stored in the file (default is 5 MB).
6060
// The second parameter specifies how many MB of cache data will be stored in memory when using file storage (default is 20 MB).
61-
// For example, if you want to use 100 MB of memory (this refers to permanent memory usage during parsing, excluding temporary objects) to parse an Excel file, the calculation shows it to be approximately 20 MB + 90 MB, so set the parameters to: 20 and 90.
61+
// For example, if you want to use 100 MB of memory (this refers to permanent memory usage during parsing, excluding temporary objects) to parse a spreadsheet file, the calculation shows it to be approximately 20 MB + 90 MB, so set the parameters to: 20 and 90.
6262
// Here's a clarification: the only addition is the readCacheSelector(new SimpleReadCacheSelector(5, 20)) parameter; the rest follows the examples provided.
6363
FesodSheet.read().
6464

@@ -68,7 +68,7 @@ readCacheSelector(new SimpleReadCacheSelector(5, 20));
6868
### About maxCacheActivateSize
6969

7070
When using file storage, FesodSheet splits the shared string into batches of **1000** items and then stores them in file
71-
storage. Excel typically reads shared strings in sequential order, so by default, 1000 entries (approximately 20MB) are
71+
storage. Spreadsheets typically read shared strings in sequential order, so by default, 1000 entries (approximately 20MB) are
7272
kept in memory. If a match is found, the data is returned directly; if not, the file is read. Therefore, the size should
7373
not be set too small, as this makes it difficult to find a match and results in constant file reads. Conversely, setting
7474
it too large can consume excessive memory.

website/docs/sheet/write/sheet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: 'Sheet'
77

88
This chapter introduces how to configure Sheets to write data.
99

10-
> **Note:** Excel limits sheet names to 31 characters. Longer names are automatically trimmed with a warning logged.
10+
> **Note:** Microsoft Excel limits sheet names to 31 characters. Longer names are automatically trimmed with a warning logged.
1111
1212
## Writing to the Same Sheet
1313

website/i18n/en/code.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"site.description": {
3-
"message": "A high-performance and memory-efficient Java library for reading and writing Excel files, designed to simplify development and ensure reliability."
3+
"message": "A high-performance and memory-efficient Java library for reading and writing spreadsheet files, designed to simplify development and ensure reliability."
44
},
55
"quickstart": {
66
"message": "Get Start"
@@ -12,13 +12,13 @@
1212
"message": "High-performance"
1313
},
1414
"homepage.feature.quick.description": {
15-
"message": "Focuses on performance optimization, capable of efficiently handling large-scale Excel data.\n Compared to some traditional Excel processing libraries, it can significantly reduce memory consumption."
15+
"message": "Focuses on performance optimization, capable of efficiently handling large-scale spreadsheet data.\n Compared to some traditional spreadsheet processing libraries, it can significantly reduce memory consumption."
1616
},
1717
"homepage.feature.simple.title": {
1818
"message": "Simplicity and Ease of Use"
1919
},
2020
"homepage.feature.simple.description": {
21-
"message": "The library offers a simple and intuitive API, allowing developers to easily integrate it into projects, whether for simple Excel operations or complex data processing."
21+
"message": "The library offers a simple and intuitive API, allowing developers to easily integrate it into projects, whether for simple spreadsheet operations or complex data processing."
2222
},
2323
"homepage.feature.bigdata": {
2424
"message": "Stream Operations"

website/src/pages/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ export default function Home() {
6666
return (
6767
<Layout
6868
title=""
69-
description="Apache Fesod (Incubating) Official Documentation | Fast, concise, Java tool for processing Excel files that solves memory overflow issues with large files <head />">
69+
description="Apache Fesod (Incubating) Official Documentation | Fast, concise, Java tool for processing spreadsheet files that solves memory overflow issues with large files <head />">
7070
<HomepageHeader/>
7171
<main>
7272
<HomepageFeatures/>

0 commit comments

Comments
 (0)