Milestone 1.0.0

Features:
- disable hyper-link in generator;
- reorder by sheet column name;
- custom HyperSchema for both read/write;

Author: honhimW

README.md

@@ -7,49 +7,25 @@ The project is forked from [scndry/jackson-dataformat-spreadsheet](https://githu
 ### Maven
 ```xml
 <project>
-  <repositories>
-    <repository>
-      <id>sonatype-snapshots</id>
-      <url>https://s01.oss.sonatype.org/content/repositories/snapshots/</url>
-      <snapshots>
-        <enabled>true</enabled>
-      </snapshots>
-    </repository>
-  </repositories>
-
   <dependency>
     <groupId>io.github.honhimw</groupId>
     <artifactId>jackson-dataformat-excel-hyperlink</artifactId>
-    <version>0.0.3-SNAPSHOT</version>
+    <version>1.0.0</version>
   </dependency>
 </project>
 ```
 
 ### Gradle
 ```groovy
 // Groovy
-repositories {
-    maven {
-        name 'sonatype-snapshots'
-        url 'https://s01.oss.sonatype.org/content/repositories/snapshots/'
-    }
-}
-
 dependencies {
-    implementation 'io.github.honhimw:jackson-dataformat-excel-hyperlink:0.0.3-SNAPSHOT'
+    implementation 'io.github.honhimw:jackson-dataformat-excel-hyperlink:1.0.0'
 }
 ```
 ```kotlin
 // Kotlin
-repositories {
-    maven {
-        name = "sonatype-snapshots"
-        url = uri("https://s01.oss.sonatype.org/content/repositories/snapshots/")
-    }
-}
-
 dependencies {
-    implementation("io.github.honhimw:jackson-dataformat-excel-hyperlink:0.0.3-SNAPSHOT")
+    implementation("io.github.honhimw:jackson-dataformat-excel-hyperlink:1.0.0")
 }
 ```
 
@@ -94,6 +70,22 @@ The commonly used (.xlsx) format document for office suite spreadsheets, which c
 
 ---
 
+## Feature
+
+### io.github.honhimw.jackson.dataformat.hyper.deser.BookParser.Feature
+
+| Features               | Default | Description                                    |
+|------------------------|---------|------------------------------------------------|
+| BLANK_ROW_AS_NULL      | true    | Blank row read as an null object in collection |
+| BREAK_ON_BLANK_ROW     | false   | Blank row as symbol for ending                 |
+| REORDER_BY_COLUMN_NAME | false   | Reorder schema by sheet title column           |
+
+### io.github.honhimw.jackson.dataformat.hyper.HyperGenerator.Feature
+
+| Features   | Default | Description                                                                                                            |
+|------------|---------|------------------------------------------------------------------------------------------------------------------------|
+| HYPERLINKE | true    | Using hyperlinks to describe object relationships<br/>**Note.** Number of hyperlinks is usually limited to 65536.<br/> |
+
 ## Usage
 
 ```java

build.gradle.kts

@@ -20,11 +20,11 @@ plugins {
 }
 
 group = "io.github.honhimw"
-version = "0.0.3-SNAPSHOT"
+version = "1.0.0"
 description = "Support for reading and writing Excel-Hyperlink via Jackson abstractions."
 
 val title = "Jackson dataformat: HyperLink"
-val jacksonVersion = "2.14.2"
+val jacksonVersion = "2.16.2"
 val poiVersion = "5.2.3"
 val snapshots = version.toString().endsWith("SNAPSHOT")
 
@@ -35,7 +35,7 @@ repositories {
 dependencies {
     api("com.fasterxml.jackson.core:jackson-databind:$jacksonVersion")
     api("org.apache.poi:poi-ooxml:$poiVersion")
-    implementation("org.slf4j:slf4j-api:2.0.6")
+    implementation("org.slf4j:slf4j-api:2.0.12")
 }
 
 dependencies {
@@ -97,10 +97,10 @@ publishing {
     repositories {
         maven {
             name = "sonatype"
-            if (snapshots) {
-                url = uri("https://s01.oss.sonatype.org/content/repositories/snapshots/")
+            url = if (snapshots) {
+                uri("https://s01.oss.sonatype.org/content/repositories/snapshots/")
             } else {
-                url = uri("https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/")
+                uri("https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/")
             }
             credentials {
                 username = findProperty("SONATYPE_USERNAME") as String

example/multiSheet.xlsx

@@ -14,6 +14,6 @@
 
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.6-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradle/wrapper/gradle-wrapper.properties

@@ -14,11 +14,7 @@
 
 package io.github.honhimw.jackson.dataformat.hyper;
 
-import com.fasterxml.jackson.core.FormatSchema;
-import com.fasterxml.jackson.core.JsonEncoding;
-import com.fasterxml.jackson.core.JsonFactory;
-import com.fasterxml.jackson.core.StreamReadFeature;
-import com.fasterxml.jackson.core.Version;
+import com.fasterxml.jackson.core.*;
 import com.fasterxml.jackson.core.io.IOContext;
 import io.github.honhimw.jackson.dataformat.hyper.deser.BookInput;
 import io.github.honhimw.jackson.dataformat.hyper.deser.BookParser;
@@ -31,39 +27,41 @@
 import io.github.honhimw.jackson.dataformat.hyper.schema.HyperSchema;
 import io.github.honhimw.jackson.dataformat.hyper.ser.BookOutput;
 import io.github.honhimw.jackson.dataformat.hyper.ser.BookWriter;
+import org.apache.poi.openxml4j.opc.PackagePart;
+import org.apache.poi.ss.usermodel.Workbook;
+import org.apache.poi.ss.usermodel.WorkbookFactory;
+import org.apache.poi.util.TempFile;
+import org.apache.poi.xssf.streaming.SXSSFWorkbook;
+
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
 import java.nio.file.Files;
 import java.nio.file.StandardCopyOption;
-import org.apache.poi.openxml4j.opc.PackagePart;
-import org.apache.poi.ss.usermodel.Workbook;
-import org.apache.poi.ss.usermodel.WorkbookFactory;
-import org.apache.poi.util.TempFile;
-import org.apache.poi.xssf.streaming.SXSSFWorkbook;
 
 @SuppressWarnings("java:S2177")
 public final class HyperFactory extends JsonFactory {
 
     public static final String FORMAT_NAME = "hyper";
-    public static final int DEFAULT_SHEET_PARSER_FEATURE_FLAGS = BookParser.Feature.collectDefaults();
+    public static final int DEFAULT_BOOK_PARSER_FEATURE_FLAGS = BookParser.Feature.collectDefaults();
+    public static final int DEFAULT_BOOK_GENERATOR_FEATURE_FLAGS = HyperGenerator.Feature.collectDefaults();
 
     private final transient WorkbookProvider _workbookProvider;
-    private int _sheetParserFeatures;
+    private int _bookParserFeatures = DEFAULT_BOOK_PARSER_FEATURE_FLAGS;
+    private int _bookGeneratorFeatures = DEFAULT_BOOK_GENERATOR_FEATURE_FLAGS;
 
     public HyperFactory() {
-        this(SXSSFWorkbook::new, DEFAULT_SHEET_PARSER_FEATURE_FLAGS);
+        this(SXSSFWorkbook::new);
     }
 
-    public HyperFactory(final WorkbookProvider workbookProvider, final int sheetParserFeatures) {
-        _workbookProvider = workbookProvider;
-        _sheetParserFeatures = sheetParserFeatures;
+    public HyperFactory(final WorkbookProvider workbookProvider) {
+        this._workbookProvider = workbookProvider;
     }
 
     public HyperFactory(final HyperFactory base) {
         _workbookProvider = base._workbookProvider;
-        _sheetParserFeatures = base._sheetParserFeatures;
+        _bookParserFeatures = base._bookParserFeatures;
     }
 
     @Override
@@ -101,7 +99,7 @@ public Version version() {
 
     /*
     /**********************************************************
-    /* Configuration, sheet parser configuration
+    /* Configuration, book parser configuration
     /**********************************************************
      */
 
@@ -110,12 +108,32 @@ public HyperFactory configure(final BookParser.Feature f, final boolean state) {
     }
 
     public HyperFactory enable(final BookParser.Feature f) {
-        _sheetParserFeatures |= f.getMask();
+        _bookParserFeatures |= f.getMask();
         return this;
     }
 
     public HyperFactory disable(final BookParser.Feature f) {
-        _sheetParserFeatures &= ~f.getMask();
+        _bookParserFeatures &= ~f.getMask();
+        return this;
+    }
+
+    /*
+    /**********************************************************
+    /* Configuration, book generator configuration
+    /**********************************************************
+     */
+
+    public HyperFactory configure(final HyperGenerator.Feature f, final boolean state) {
+        return state ? enable(f) : disable(f);
+    }
+
+    public HyperFactory enable(final HyperGenerator.Feature f) {
+        _bookGeneratorFeatures |= f.getMask();
+        return this;
+    }
+
+    public HyperFactory disable(final HyperGenerator.Feature f) {
+        _bookGeneratorFeatures &= ~f.getMask();
         return this;
     }
 
@@ -179,7 +197,7 @@ public HyperGenerator createGenerator(final OutputStream out) throws IOException
      */
 
     private BookParser _createParser(final BookReader reader, final IOContext ctxt) {
-        return new BookParser(ctxt, _parserFeatures, _objectCodec, _sheetParserFeatures, reader);
+        return new BookParser(ctxt, _parserFeatures, _objectCodec, _bookParserFeatures, reader);
     }
 
     private BookReader _createFileSheetReader(final File src) throws IOException {
@@ -227,7 +245,7 @@ private BookInput<?> _preferRawAsFile(final BookInput<?> src) throws IOException
      */
 
     private HyperGenerator _createGenerator(final BookWriter writer, final IOContext ctxt) {
-        return new HyperGenerator(ctxt, _generatorFeatures, _objectCodec, writer);
+        return new HyperGenerator(ctxt, _generatorFeatures, _objectCodec, writer, _bookGeneratorFeatures);
     }
 
     @SuppressWarnings("resource")

src/main/java/io/github/honhimw/jackson/dataformat/hyper/HyperFactory.java

@@ -14,11 +14,7 @@
 
 package io.github.honhimw.jackson.dataformat.hyper;
 
-import com.fasterxml.jackson.core.Base64Variant;
-import com.fasterxml.jackson.core.FormatSchema;
-import com.fasterxml.jackson.core.ObjectCodec;
-import com.fasterxml.jackson.core.StreamWriteFeature;
-import com.fasterxml.jackson.core.Version;
+import com.fasterxml.jackson.core.*;
 import com.fasterxml.jackson.core.base.GeneratorBase;
 import com.fasterxml.jackson.core.io.IOContext;
 import io.github.honhimw.jackson.dataformat.hyper.exception.BookStreamWriteException;
@@ -48,11 +44,13 @@ public final class HyperGenerator extends GeneratorBase {
     private final BookWriter _writer;
     private HyperSchema _schema;
     private BookStreamContext _outputContext;
+    private final int _formatFeatures;
 
-    public HyperGenerator(final IOContext ctxt, final int features, final ObjectCodec codec, final BookWriter writer) {
-        super(features, codec);
+    public HyperGenerator(final IOContext ctxt, final int features, final ObjectCodec codec, final BookWriter writer, final int formatFeatures) {
+        super(features, codec, ctxt);
         _ioContext = ctxt;
         _writer = writer;
+        this._formatFeatures = formatFeatures;
     }
 
     @Override
@@ -84,6 +82,13 @@ public void setSchema(final FormatSchema schema) {
         _writer.setSchema(_schema);
         _writer.writeHeaders();
         _outputContext = BookStreamContext.createRootContext(_schema);
+        if (!isEnabled(Feature.HYPERLINKE)) {
+            _writer.disableHyperlink();
+        }
+    }
+
+    public boolean isEnabled(final Feature f) {
+        return (_formatFeatures & f.getMask()) != 0;
     }
 
     public boolean isDate1904() {
@@ -312,4 +317,42 @@ private void _checkSchemaSet() throws IOException {
                 "No schema of type '" + HyperSchema.SCHEMA_TYPE + "' set, can not generate", this);
         }
     }
+
+    public enum Feature implements FormatFeature {
+        HYPERLINKE(true),
+        ;
+        final boolean _defaultState;
+        final int _mask;
+
+        Feature(final boolean defaultState) {
+            _defaultState = defaultState;
+            _mask = 1 << ordinal();
+        }
+
+        public static int collectDefaults() {
+            int flags = 0;
+            for (Feature f : values()) {
+                if (f.enabledByDefault()) {
+                    flags |= f.getMask();
+                }
+            }
+            return flags;
+        }
+
+        @Override
+        public boolean enabledByDefault() {
+            return _defaultState;
+        }
+
+        @Override
+        public int getMask() {
+            return _mask;
+        }
+
+        @Override
+        public boolean enabledIn(final int flags) {
+            return (flags & getMask()) != 0;
+        }
+    }
+
 }

src/main/java/io/github/honhimw/jackson/dataformat/hyper/HyperGenerator.java

@@ -201,7 +201,7 @@ public BookParser createParser(final InputStream in) throws IOException {
 
     /*
     /**********************************************************
-    /* Configuration, simple features: SheetParser.Feature
+    /* Configuration, simple features: BookParser.Feature
     /**********************************************************
      */
 
@@ -224,6 +224,31 @@ public HyperMapper disable(final BookParser.Feature... features) {
         return this;
     }
 
+    /*
+    /**********************************************************
+    /* Configuration, simple features: BookParser.Feature
+    /**********************************************************
+     */
+
+    public HyperMapper configure(final HyperGenerator.Feature f, final boolean state) {
+        tokenStreamFactory().configure(f, state);
+        return this;
+    }
+
+    public HyperMapper enable(final HyperGenerator.Feature... features) {
+        for (HyperGenerator.Feature f : features) {
+            tokenStreamFactory().enable(f);
+        }
+        return this;
+    }
+
+    public HyperMapper disable(final HyperGenerator.Feature... features) {
+        for (HyperGenerator.Feature f : features) {
+            tokenStreamFactory().disable(f);
+        }
+        return this;
+    }
+
     /*
     /**********************************************************
     /* Configuration, schema generation