-
Notifications
You must be signed in to change notification settings - Fork 534
feat: add java.sql.Clob converter #1134
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
AhmedYoussef98
wants to merge
1
commit into
apache:main
Choose a base branch
from
AhmedYoussef98:feat-clob-converter
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
69 changes: 69 additions & 0 deletions
69
fesod-sheet/src/main/java/org/apache/fesod/sheet/converters/clob/ClobStringConverter.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| package org.apache.fesod.sheet.converters.clob; | ||
|
|
||
| import java.io.Reader; | ||
| import java.sql.Clob; | ||
| import javax.sql.rowset.serial.SerialClob; | ||
| import org.apache.fesod.sheet.converters.Converter; | ||
| import org.apache.fesod.sheet.enums.CellDataTypeEnum; | ||
| import org.apache.fesod.sheet.metadata.GlobalConfiguration; | ||
| import org.apache.fesod.sheet.metadata.data.ReadCellData; | ||
| import org.apache.fesod.sheet.metadata.data.WriteCellData; | ||
| import org.apache.fesod.sheet.metadata.property.ExcelContentProperty; | ||
|
|
||
| /** | ||
| * Clob and string converter. Clob data is represented as a string cell; reads return a | ||
| * {@link SerialClob} so callers receive a usable, detached JDBC Clob value. | ||
| */ | ||
| public class ClobStringConverter implements Converter<Clob> { | ||
| @Override | ||
| public Class<?> supportJavaTypeKey() { | ||
| return Clob.class; | ||
| } | ||
|
|
||
| @Override | ||
| public CellDataTypeEnum supportExcelTypeKey() { | ||
| return CellDataTypeEnum.STRING; | ||
| } | ||
|
|
||
| @Override | ||
| public Clob convertToJavaData( | ||
| ReadCellData<?> cellData, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) | ||
| throws Exception { | ||
| // Materialize cell text into a detached JDBC Clob, avoiding a database-specific Clob implementation. | ||
| return new SerialClob(cellData.getStringValue().toCharArray()); | ||
| } | ||
|
|
||
| @Override | ||
| public WriteCellData<?> convertToExcelData( | ||
| Clob value, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) | ||
| throws Exception { | ||
| StringBuilder text = new StringBuilder(); | ||
| char[] buffer = new char[4096]; | ||
| try (Reader reader = value.getCharacterStream()) { | ||
| int count; | ||
| while ((count = reader.read(buffer)) != -1) { | ||
| text.append(buffer, 0, count); | ||
| } | ||
| } | ||
| return new WriteCellData<>(text.toString()); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
60 changes: 60 additions & 0 deletions
60
...d-sheet/src/test/java/org/apache/fesod/sheet/converters/clob/ClobStringConverterTest.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| package org.apache.fesod.sheet.converters.clob; | ||
|
|
||
| import java.sql.Clob; | ||
| import javax.sql.rowset.serial.SerialClob; | ||
| import org.apache.fesod.sheet.enums.CellDataTypeEnum; | ||
| import org.apache.fesod.sheet.metadata.GlobalConfiguration; | ||
| import org.apache.fesod.sheet.metadata.data.ReadCellData; | ||
| import org.apache.fesod.sheet.metadata.data.WriteCellData; | ||
| import org.apache.fesod.sheet.testkit.Tags; | ||
| import org.junit.jupiter.api.Assertions; | ||
| import org.junit.jupiter.api.Tag; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| @Tag(Tags.UNIT) | ||
| class ClobStringConverterTest { | ||
| private static final GlobalConfiguration GLOBAL_CONFIGURATION = new GlobalConfiguration(); | ||
| private final ClobStringConverter converter = new ClobStringConverter(); | ||
|
|
||
| @Test | ||
| void supportKeys() { | ||
| Assertions.assertEquals(Clob.class, converter.supportJavaTypeKey()); | ||
| Assertions.assertEquals(CellDataTypeEnum.STRING, converter.supportExcelTypeKey()); | ||
| } | ||
|
|
||
| @Test | ||
| void convertsCellStringToDetachedClob() throws Exception { | ||
| Clob actual = converter.convertToJavaData(new ReadCellData<>("Large text 字符"), null, GLOBAL_CONFIGURATION); | ||
|
|
||
| Assertions.assertEquals("Large text 字符", actual.getSubString(1, (int) actual.length())); | ||
| } | ||
|
|
||
| @Test | ||
| void convertsClobCharacterStreamToCellString() throws Exception { | ||
| Clob value = new SerialClob("Large text 字符".toCharArray()); | ||
|
|
||
| WriteCellData<?> written = converter.convertToExcelData(value, null, GLOBAL_CONFIGURATION); | ||
|
|
||
| Assertions.assertEquals(CellDataTypeEnum.STRING, written.getType()); | ||
| Assertions.assertEquals("Large text 字符", written.getStringValue()); | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a test gap on the write path?
convertsClobCharacterStreamToCellStringuses a 13-char value, so the 4096-char read loop only runs once. Changingwhiletoif(so only the first chunk is kept) still passes all three tests. Using the cell text limit as the length covers several chunks and delei's boundary at the same time: