Merge pull request #35 from Paulanerus/dev

Dev

Author: Paulanerus

.github/workflows/build-and-publish.yml

@@ -111,12 +111,12 @@ jobs:
 
       - name: Upload Windows Artifact
         if: matrix.os == 'windows-latest'
-        run: gh release upload v${{ env.VERSION }} build/compose/binaries/main-release/msi/TextExplorer-${{ env.VERSION }}.msi --clobber
+        run: gh release upload v${{ env.VERSION }} build/compose/binaries/main-release/msi/TextVariantExplorer-${{ env.VERSION }}.msi --clobber
 
       - name: Upload Linux  Artifact
         if: matrix.os == 'ubuntu-latest'
-        run: gh release upload v${{ env.VERSION }} build/compose/binaries/main-release/deb/textexplorer_${{ env.VERSION }}_amd64.deb --clobber
+        run: gh release upload v${{ env.VERSION }} build/compose/binaries/main-release/deb/textvariantexplorer_${{ env.VERSION }}_amd64.deb --clobber
 
       - name: Upload macOS Artifact
         if: matrix.os == 'macos-latest'
-        run: gh release upload v${{ env.VERSION }} build/compose/binaries/main-release/dmg/TextExplorer-${{ env.VERSION }}.Dmg --clobber
+        run: gh release upload v${{ env.VERSION }} build/compose/binaries/main-release/dmg/TextVariantExplorer-${{ env.VERSION }}.Dmg --clobber

CITATION.cff

@@ -1,5 +1,5 @@
 cff-version: 1.2.0
-title: TextExplorer
+title: TextVariantExplorer
 message: >-
   If you use this software, please cite it using the
   metadata from this file.
@@ -8,13 +8,13 @@ authors:
   - given-names: Paul
     family-names: Fröhlich
 repository-code: 'https://github.com/Paulanerus/TextExplorer'
-url: 'https://paulee.dev/textexplorer/'
+url: 'https://paulee.dev/textvariantexplorer/'
 repository-artifact: >-
   https://github.com/Paulanerus/TextExplorer/releases/tag/v1.2.3
 abstract: >-
   A tool designed for the exploration, analysis, and
   comparison of textual data variants.
 license: GPL-3.0
 commit: 2bbaa5a
-version: 1.2.3
-date-released: '2025-08-05'
+version: 1.3.0
+date-released: '2025-08-11'

README.md

@@ -1,49 +1,16 @@
-# TextExplorer
+# TextVariantExplorer
 
-This is a tool designed for the exploration and comparison of variants of textual data.
+Is an open-source, cross-platform tool designed for the exploration and comparison of text variants, making it easier to analyze differences and similarities in textual data.
 
 ## Getting Started
 
-### Initial Setup
+You can download the latest version of TextVariantExplorer from the [**GitHub releases page**](https://github.com/Paulanerus/TextExplorer/releases/latest).
 
-1. **Download and Install**
-   - Get the [latest release](https://github.com/Paulanerus/TextExplorer/releases/latest) of the application and install it on your system
-
-2. **Obtain a Plugin and Dataset**
-   - Download a demo plugin from the release page along with its [corresponding dataset](https://zenodo.org/records/12723324), or create your own
-
-3. **Load the Data**
-   - Start the application
-   - Load the data via the menu in the top right-corner of the window
-   - The data layout can be configured in the new window
-   - When the configuration is complete, press the 'Load' button 
-   - Depending on the size of your dataset, the loading process may take some time
-
-4. **Load the Plugin**
-   - Load the plugin via the menu in the top right-corner of the window 
-
-### Search
-
-1. **Select a Datapool**
-   - If multiple datasets are available, you can switch between them using the menu in the top-left corner.
-
-2. **Perform a Search**
-   - Enter simple words or sentences to search through the dataset.
-   - Use Boolean operators to refine your search: and, and not, or
-
-3. **Use Name Variants**
-   - The syntax for searching name variants is: `@name:value`
-
-4. **Apply Pre-Filters**
-   - You can pre-filter search results using the following syntax: `@name:value1:value2`
-
-## Development
-
-To create plugins for TextExplorer, see the [API ReadMe](api/README.md) for details.
+For comprehensive usage guides and development information, please see the [**official documentation**](https://textvariantexplorer.readthedocs.io/en/latest/) on Read the Docs.
 
 ## Citation
 
-If you use TextExplorer in your research, please cite it using the information provided in the [CITATION.cff](CITATION.cff) file.
+If you use TextVariantExplorer in your research, please cite it using the information provided in the [CITATION.cff](CITATION.cff) file.
 
 ## Support
 

api/README.md

@@ -93,14 +93,14 @@ sealed interface SourceField {
 data class BasicField(
     override val name: String,
     override val fieldType: FieldType,
-    @JsonInclude(JsonInclude.Include.NON_EMPTY) override val sourceLink: String = ""
+    @param:JsonInclude(JsonInclude.Include.NON_EMPTY) override val sourceLink: String = ""
 ) :
     SourceField
 
 data class IndexField(
     override val name: String,
     override val fieldType: FieldType,
-    @JsonInclude(JsonInclude.Include.NON_EMPTY)
+    @param:JsonInclude(JsonInclude.Include.NON_EMPTY)
     override val sourceLink: String = "",
     val lang: Language,
     val default: Boolean = false
@@ -109,7 +109,7 @@ data class IndexField(
 data class UniqueField(
     override val name: String,
     override val fieldType: FieldType,
-    @JsonInclude(JsonInclude.Include.NON_EMPTY)
+    @param:JsonInclude(JsonInclude.Include.NON_EMPTY)
     override val sourceLink: String = "",
     val identify: Boolean = false
 ) : SourceField

api/src/main/kotlin/dev/paulee/api/data/Data.kt

@@ -1,6 +1,7 @@
 package dev.paulee.api.data
 
 import dev.paulee.api.data.provider.IStorageProvider
+import dev.paulee.api.data.provider.QueryOrder
 import java.io.Closeable
 import java.nio.file.Path
 
@@ -20,7 +21,9 @@ interface IDataService : Closeable {
 
     fun getAvailableDataInfo(): Set<DataInfo>
 
-    fun getPage(query: String, pageCount: Int): Pair<List<Map<String, String>>, Map<String, List<Map<String, String>>>>
+    fun getSuggestions(field: String, value: String): List<String>
+
+    fun getPage(query: String, order: QueryOrder?, pageCount: Int): Pair<List<Map<String, String>>, Map<String, List<Map<String, String>>>>
 
     fun getPageCount(query: String): Triple<Long, Long, Set<String>>
 

api/src/main/kotlin/dev/paulee/api/data/IDataService.kt

@@ -4,6 +4,8 @@ import dev.paulee.api.data.DataInfo
 import java.io.Closeable
 import java.nio.file.Path
 
+typealias QueryOrder = Pair<String, Boolean>
+
 enum class StorageType {
     SQLITE,
 }
@@ -25,6 +27,7 @@ interface IStorageProvider : Closeable {
         ids: Set<Long> = emptySet(),
         whereClause: List<String> = emptyList(),
         filter: List<String> = emptyList(),
+        order: QueryOrder? = null,
         offset: Int = 0,
         limit: Int = Int.MAX_VALUE,
     ): List<Map<String, String>>
@@ -35,4 +38,6 @@ interface IStorageProvider : Closeable {
         whereClause: List<String> = emptyList(),
         filter: List<String> = emptyList(),
     ): Long
+
+    fun suggestions(name: String, field: String, value: String, amount: Int): List<String>
 }

api/src/main/kotlin/dev/paulee/api/data/provider/StorageProvider.kt

@@ -45,7 +45,7 @@ compose.desktop {
 
         nativeDistributions {
             targetFormats(TargetFormat.Dmg, TargetFormat.Msi, TargetFormat.Deb)
-            packageName = "TextExplorer"
+            packageName = "TextVariantExplorer"
 
             modules += listOf("java.sql")
         }