From e93ce266bbae4fcc566b18eb9904011a9a1e22b0 Mon Sep 17 00:00:00 2001 From: Strongest Number 9 <16169054+StrongestNumber9@users.noreply.github.com> Date: Wed, 13 Aug 2025 11:15:23 +0300 Subject: [PATCH 01/22] Doxygens (#1) * geners * add docs * Revert "add docs" This reverts commit a8866b8126532689b2260f44b613914cb0f51837. --------- Co-authored-by: Motoko Kusanagi --- Doxyfile | 39 +++++++++++++++++++ .../functions/dpf_02/BatchCollect.java | 28 +++++++++++++ .../teragrep/functions/dpf_02/Graafinen.java | 15 +++++++ .../functions/dpf_02/SortByClause.java | 14 ++++++- .../functions/dpf_02/UusiObjekti.java | 32 +++++++++++++++ 5 files changed, 127 insertions(+), 1 deletion(-) create mode 100644 Doxyfile create mode 100644 src/main/java/com/teragrep/functions/dpf_02/Graafinen.java create mode 100644 src/main/java/com/teragrep/functions/dpf_02/UusiObjekti.java diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000..ceecc6d --- /dev/null +++ b/Doxyfile @@ -0,0 +1,39 @@ +# INPUT FILES +INPUT = src/ +FILE_PATTERNS = *.java +RECURSIVE = YES + +# OUTPUT +OUTPUT_DIRECTORY = docs +GENERATE_LATEX = NO +GENERATE_HTML = YES + +# JAVA MODE +OPTIMIZE_OUTPUT_JAVA = YES +EXTRACT_ALL = YES +EXTRACT_PRIVATE = YES +EXTRACT_STATIC = YES +JAVADOC_AUTOBRIEF = YES +SOURCE_BROWSER = YES +INLINE_SOURCES = YES + +# DIAGRAMS +HAVE_DOT = YES +DOT_NUM_THREADS = 2 +CLASS_DIAGRAMS = YES +CALL_GRAPH = YES +CALLER_GRAPH = YES +DOT_IMAGE_FORMAT = svg + +# PLANTUML (optional) +USE_PLANTUML = YES +PLANTUML_JAR_PATH = /usr/share/java/plantuml.jar +PLANTUML_INCLUDE_PATH = . +PLANTUML_CFG_FILE = + +# ALIASES (optional: adds headings like @responsibilities) +ALIASES += responsibilities="\par Responsibilities:" +ALIASES += collaborators="\par Collaborators:" + +# MARKDOWN +MARKDOWN_SUPPORT = YES diff --git a/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java b/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java index 4368803..04afb61 100644 --- a/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java +++ b/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java @@ -54,6 +54,34 @@ import java.util.*; +/** + * @class BatchCollect + * @brief Handles the business logic for processing orders. + * + * @responsibilities + * - Magiaa tapahtuu + * + * @collaborators + * - UusiObjekti + * + * @startuml + * class BatchCollect { + * + call() + * } + * + * BatchCollect --> SortByClause : sort order + * BatchCollect --> UusiObjekti : magiaa + * + * note right of BatchCollect + * Responsibilities: + * - Collects Rows + * + * Collaborators: + * - SortByClause + * end note + * + * @enduml + */ public final class BatchCollect extends SortOperation { private static final Logger LOGGER = LoggerFactory.getLogger(BatchCollect.class); private Dataset savedDs = null; diff --git a/src/main/java/com/teragrep/functions/dpf_02/Graafinen.java b/src/main/java/com/teragrep/functions/dpf_02/Graafinen.java new file mode 100644 index 0000000..b279c06 --- /dev/null +++ b/src/main/java/com/teragrep/functions/dpf_02/Graafinen.java @@ -0,0 +1,15 @@ +package com.teragrep.functions.dpf_02; + +/** + * @startuml + * !include src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java!0 + * !include src/main/java/com/teragrep/functions/dpf_02/SortByClause.java!0 + * !include src/main/java/com/teragrep/functions/dpf_02/UusiObjekti.java!0 + * + * @enduml + */ + + +public class Graafinen { + +} diff --git a/src/main/java/com/teragrep/functions/dpf_02/SortByClause.java b/src/main/java/com/teragrep/functions/dpf_02/SortByClause.java index f34c607..b825b67 100644 --- a/src/main/java/com/teragrep/functions/dpf_02/SortByClause.java +++ b/src/main/java/com/teragrep/functions/dpf_02/SortByClause.java @@ -49,7 +49,19 @@ import java.io.Serializable; /** - * Class for the different sortByClauses in the 'sort' command + * @startuml + * class SortByClause { + * - getLimit() + * } + * + * note right of SortByClause + * Responsibilities: + * - Sorts Rows + * + * Collaborators: + * - ConvertIPStringToInt + * end note + * @enduml */ public class SortByClause implements Serializable { private boolean descending = false; // + or - diff --git a/src/main/java/com/teragrep/functions/dpf_02/UusiObjekti.java b/src/main/java/com/teragrep/functions/dpf_02/UusiObjekti.java new file mode 100644 index 0000000..e256cc0 --- /dev/null +++ b/src/main/java/com/teragrep/functions/dpf_02/UusiObjekti.java @@ -0,0 +1,32 @@ +package com.teragrep.functions.dpf_02; + + +/** + * @brief You see nothing here + * + * @responsibilities + * - none + * + * @collaborators + * - SortOperation + * + * @startuml + * class UusiObjekti { + * + jotain() + * } + * + * note right of UusiObjekti + * Responsibilities: + * - irresponsible + * end note + * @enduml + */ +public class UusiObjekti { + + /** + * tekee jotain odottamatonta + */ + public void jotain() { + + } +} From 2eedee85b76e51d9255cf7a311945e183f98db61 Mon Sep 17 00:00:00 2001 From: StrongestNumber9 <16169054+StrongestNumber9@users.noreply.github.com> Date: Wed, 13 Aug 2025 11:20:54 +0300 Subject: [PATCH 02/22] Publish javadoc --- .github/workflows/publish-javadoc.yaml | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 .github/workflows/publish-javadoc.yaml diff --git a/.github/workflows/publish-javadoc.yaml b/.github/workflows/publish-javadoc.yaml new file mode 100644 index 0000000..38f4afb --- /dev/null +++ b/.github/workflows/publish-javadoc.yaml @@ -0,0 +1,16 @@ +on: + push: +jobs: + publish: + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - name: Deploy JavaDoc + uses: MathieuSoysal/Javadoc-publisher.yml@v3.0.2 + with: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + javadoc-branch: javadoc + java-version: 11 + target-folder: "${GITHUB_REF##*/}" + project: maven From f0db90a293c35facbf56a94ab103a1d7489960fe Mon Sep 17 00:00:00 2001 From: StrongestNumber9 <16169054+StrongestNumber9@users.noreply.github.com> Date: Wed, 13 Aug 2025 11:32:15 +0300 Subject: [PATCH 03/22] Don't fail on error --- .github/workflows/publish-javadoc.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/publish-javadoc.yaml b/.github/workflows/publish-javadoc.yaml index 38f4afb..09b56c4 100644 --- a/.github/workflows/publish-javadoc.yaml +++ b/.github/workflows/publish-javadoc.yaml @@ -14,3 +14,5 @@ jobs: java-version: 11 target-folder: "${GITHUB_REF##*/}" project: maven + env: + MAVEN_OPTS: "-Dmaven.javadoc.failOnError=false" From 21bf9d990ceec6027fa5b2a2eb8685ab1750a7f4 Mon Sep 17 00:00:00 2001 From: StrongestNumber9 <16169054+StrongestNumber9@users.noreply.github.com> Date: Wed, 13 Aug 2025 12:11:32 +0300 Subject: [PATCH 04/22] Cosmetic change --- .github/workflows/publish-javadoc.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/publish-javadoc.yaml b/.github/workflows/publish-javadoc.yaml index 09b56c4..6395598 100644 --- a/.github/workflows/publish-javadoc.yaml +++ b/.github/workflows/publish-javadoc.yaml @@ -6,7 +6,7 @@ jobs: permissions: contents: write steps: - - name: Deploy JavaDoc + - name: Publish JavaDoc uses: MathieuSoysal/Javadoc-publisher.yml@v3.0.2 with: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} From 3de9eef0e29e3cb2e9e1213cf3684e9c44b927ce Mon Sep 17 00:00:00 2001 From: StrongestNumber9 <16169054+StrongestNumber9@users.noreply.github.com> Date: Wed, 13 Aug 2025 12:16:44 +0300 Subject: [PATCH 05/22] Maybe fixes outputs path? --- .github/workflows/publish-javadoc.yaml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/workflows/publish-javadoc.yaml b/.github/workflows/publish-javadoc.yaml index 6395598..462b03d 100644 --- a/.github/workflows/publish-javadoc.yaml +++ b/.github/workflows/publish-javadoc.yaml @@ -6,13 +6,17 @@ jobs: permissions: contents: write steps: + - name: Extract branch name + shell: bash + run: echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_OUTPUT + id: extract_branch - name: Publish JavaDoc uses: MathieuSoysal/Javadoc-publisher.yml@v3.0.2 with: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} javadoc-branch: javadoc java-version: 11 - target-folder: "${GITHUB_REF##*/}" + target-folder: "${{ steps.extract_branch.outputs.branch }}" project: maven env: MAVEN_OPTS: "-Dmaven.javadoc.failOnError=false" From 9d299eb49a0f51bf1eec2183b691448a93cc8741 Mon Sep 17 00:00:00 2001 From: StrongestNumber9 <16169054+StrongestNumber9@users.noreply.github.com> Date: Mon, 18 Aug 2025 12:19:50 +0300 Subject: [PATCH 06/22] Updates to use proper doxygen/javadoc with plantuml setup --- .github/workflows/publish-docs.yaml | 52 ++++++++++++++++++++++++++ .github/workflows/publish-javadoc.yaml | 22 ----------- Doxyfile | 4 +- 3 files changed, 54 insertions(+), 24 deletions(-) create mode 100644 .github/workflows/publish-docs.yaml delete mode 100644 .github/workflows/publish-javadoc.yaml diff --git a/.github/workflows/publish-docs.yaml b/.github/workflows/publish-docs.yaml new file mode 100644 index 0000000..777a706 --- /dev/null +++ b/.github/workflows/publish-docs.yaml @@ -0,0 +1,52 @@ +on: + push: +jobs: + publish: + runs-on: ubuntu-latest + permissions: + contents: write + steps: + # Checkout + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + # Cache + - name: Cache Local Maven Repository + uses: actions/cache@v4 + with: + path: ~/.m2/repository + key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }} + # Setup java + - name: Setup Java + uses: actions/setup-java@v4 + with: + java-version: 11 + distribution: 'adopt' + # Used for docs output + - name: Extract branch name + shell: bash + run: echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_OUTPUT + id: extract_branch + # Make dirs + - name: Make dirs + run: mkdir -p docs/${{steps.extract_branch.outputs.branch}}/ + # Run javadoc + - name: Generate javadoc + run: mvn -B javadoc:aggregate && mv target/site/apidocs "docs/${{steps.extract_branch.outputs.branch}}/javadoc/" + env: + MAVEN_OPTS: "-Dmaven.javadoc.failOnError=false" + # Install dependencies + - name: Install dependencies + run: sudo apt-get update && sudo apt-get install doxygen graphviz plantuml + # Generate doxygen docs + - name: Generate Doxygen docs + run: doxygen Doxyfile && mv "target/doxygen/html" "docs/${{steps.extract_branch.outputs.branch}}/doxygen/" + env: + OUTPUT_DIRECTORY: "target/doxygen" + # Deploy + - name: Deploy docs + uses: JamesIves/github-pages-deploy-action@v4 + with: + folder: docs/${{steps.extract_branch.outputs.branch}}/ + target-folder: docs/${{steps.extract_branch.outputs.branch}}/ + token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/publish-javadoc.yaml b/.github/workflows/publish-javadoc.yaml deleted file mode 100644 index 462b03d..0000000 --- a/.github/workflows/publish-javadoc.yaml +++ /dev/null @@ -1,22 +0,0 @@ -on: - push: -jobs: - publish: - runs-on: ubuntu-latest - permissions: - contents: write - steps: - - name: Extract branch name - shell: bash - run: echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_OUTPUT - id: extract_branch - - name: Publish JavaDoc - uses: MathieuSoysal/Javadoc-publisher.yml@v3.0.2 - with: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - javadoc-branch: javadoc - java-version: 11 - target-folder: "${{ steps.extract_branch.outputs.branch }}" - project: maven - env: - MAVEN_OPTS: "-Dmaven.javadoc.failOnError=false" diff --git a/Doxyfile b/Doxyfile index ceecc6d..9df55f0 100644 --- a/Doxyfile +++ b/Doxyfile @@ -4,7 +4,7 @@ FILE_PATTERNS = *.java RECURSIVE = YES # OUTPUT -OUTPUT_DIRECTORY = docs +OUTPUT_DIRECTORY = $(OUTPUT_DIRECTORY) GENERATE_LATEX = NO GENERATE_HTML = YES @@ -27,7 +27,7 @@ DOT_IMAGE_FORMAT = svg # PLANTUML (optional) USE_PLANTUML = YES -PLANTUML_JAR_PATH = /usr/share/java/plantuml.jar +PLANTUML_JAR_PATH = /usr/share/plantuml/plantuml.jar PLANTUML_INCLUDE_PATH = . PLANTUML_CFG_FILE = From 8796d5a9102d1470af8eff138c0cf8d5851d05d5 Mon Sep 17 00:00:00 2001 From: StrongestNumber9 <16169054+StrongestNumber9@users.noreply.github.com> Date: Mon, 18 Aug 2025 12:22:14 +0300 Subject: [PATCH 07/22] Remove UusiObjekti --- .../functions/dpf_02/UusiObjekti.java | 32 ------------------- 1 file changed, 32 deletions(-) delete mode 100644 src/main/java/com/teragrep/functions/dpf_02/UusiObjekti.java diff --git a/src/main/java/com/teragrep/functions/dpf_02/UusiObjekti.java b/src/main/java/com/teragrep/functions/dpf_02/UusiObjekti.java deleted file mode 100644 index e256cc0..0000000 --- a/src/main/java/com/teragrep/functions/dpf_02/UusiObjekti.java +++ /dev/null @@ -1,32 +0,0 @@ -package com.teragrep.functions.dpf_02; - - -/** - * @brief You see nothing here - * - * @responsibilities - * - none - * - * @collaborators - * - SortOperation - * - * @startuml - * class UusiObjekti { - * + jotain() - * } - * - * note right of UusiObjekti - * Responsibilities: - * - irresponsible - * end note - * @enduml - */ -public class UusiObjekti { - - /** - * tekee jotain odottamatonta - */ - public void jotain() { - - } -} From aedb10d39ddd8766804cbdaa53384dcbdafc187f Mon Sep 17 00:00:00 2001 From: StrongestNumber9 <16169054+StrongestNumber9@users.noreply.github.com> Date: Mon, 18 Aug 2025 12:22:36 +0300 Subject: [PATCH 08/22] Removes Graafinen --- .../com/teragrep/functions/dpf_02/Graafinen.java | 15 --------------- 1 file changed, 15 deletions(-) delete mode 100644 src/main/java/com/teragrep/functions/dpf_02/Graafinen.java diff --git a/src/main/java/com/teragrep/functions/dpf_02/Graafinen.java b/src/main/java/com/teragrep/functions/dpf_02/Graafinen.java deleted file mode 100644 index b279c06..0000000 --- a/src/main/java/com/teragrep/functions/dpf_02/Graafinen.java +++ /dev/null @@ -1,15 +0,0 @@ -package com.teragrep.functions.dpf_02; - -/** - * @startuml - * !include src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java!0 - * !include src/main/java/com/teragrep/functions/dpf_02/SortByClause.java!0 - * !include src/main/java/com/teragrep/functions/dpf_02/UusiObjekti.java!0 - * - * @enduml - */ - - -public class Graafinen { - -} From 01c57ebe97983a6fe6da6a7a61115fa3603d5c5a Mon Sep 17 00:00:00 2001 From: StrongestNumber9 <16169054+StrongestNumber9@users.noreply.github.com> Date: Mon, 18 Aug 2025 12:23:37 +0300 Subject: [PATCH 09/22] Cleanup BatchCollect docs a bit --- .../java/com/teragrep/functions/dpf_02/BatchCollect.java | 7 ------- 1 file changed, 7 deletions(-) diff --git a/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java b/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java index 04afb61..ab8be56 100644 --- a/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java +++ b/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java @@ -58,19 +58,12 @@ * @class BatchCollect * @brief Handles the business logic for processing orders. * - * @responsibilities - * - Magiaa tapahtuu - * - * @collaborators - * - UusiObjekti - * * @startuml * class BatchCollect { * + call() * } * * BatchCollect --> SortByClause : sort order - * BatchCollect --> UusiObjekti : magiaa * * note right of BatchCollect * Responsibilities: From f42ab87f4aa46765046b62659ee6c247d8217b1d Mon Sep 17 00:00:00 2001 From: StrongestNumber9 <16169054+StrongestNumber9@users.noreply.github.com> Date: Mon, 18 Aug 2025 12:39:50 +0300 Subject: [PATCH 10/22] Readd collaborators as SortByClause --- src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java b/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java index ab8be56..5cca6ae 100644 --- a/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java +++ b/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java @@ -58,6 +58,9 @@ * @class BatchCollect * @brief Handles the business logic for processing orders. * + * @collaborators + * - SortByClause + * * @startuml * class BatchCollect { * + call() From f350c2cd224b66ef5427bf497522fb3a1dbd78ef Mon Sep 17 00:00:00 2001 From: StrongestNumber9 <16169054+StrongestNumber9@users.noreply.github.com> Date: Mon, 18 Aug 2025 12:45:18 +0300 Subject: [PATCH 11/22] Readd responsibilities --- src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java b/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java index 5cca6ae..0b80559 100644 --- a/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java +++ b/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java @@ -58,6 +58,9 @@ * @class BatchCollect * @brief Handles the business logic for processing orders. * + * @responsibilities + * - Collects rows + * * @collaborators * - SortByClause * From cde6b6ff7adfbb495bf33109298e8e4ac8e6a6ab Mon Sep 17 00:00:00 2001 From: StrongestNumber9 <16169054+StrongestNumber9@users.noreply.github.com> Date: Mon, 18 Aug 2025 13:22:20 +0300 Subject: [PATCH 12/22] Updates call --- src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java b/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java index 0b80559..5fdd1bc 100644 --- a/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java +++ b/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java @@ -66,7 +66,7 @@ * * @startuml * class BatchCollect { - * + call() + * + call(df: Dataset, id: Long, skipLimiting: boolean) : Dataset "Collects rows up to the defined limit unless skipLimiting is provided" * } * * BatchCollect --> SortByClause : sort order From 89591b79e88af56f29915e1a1968da191fd25222 Mon Sep 17 00:00:00 2001 From: StrongestNumber9 <16169054+StrongestNumber9@users.noreply.github.com> Date: Mon, 18 Aug 2025 13:22:49 +0300 Subject: [PATCH 13/22] Remove space --- src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java b/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java index 5fdd1bc..b4b2742 100644 --- a/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java +++ b/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java @@ -66,7 +66,7 @@ * * @startuml * class BatchCollect { - * + call(df: Dataset, id: Long, skipLimiting: boolean) : Dataset "Collects rows up to the defined limit unless skipLimiting is provided" + * +call(df: Dataset, id: Long, skipLimiting: boolean) : Dataset "Collects rows up to the defined limit unless skipLimiting is provided" * } * * BatchCollect --> SortByClause : sort order From dd9aac94666245b711276f3b55a835000c499417 Mon Sep 17 00:00:00 2001 From: StrongestNumber9 <16169054+StrongestNumber9@users.noreply.github.com> Date: Mon, 18 Aug 2025 13:34:00 +0300 Subject: [PATCH 14/22] Revert "Remove space" This reverts commit bfc81e0310260eb40faab97c14e2439d578f821f. --- src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java b/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java index b4b2742..5fdd1bc 100644 --- a/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java +++ b/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java @@ -66,7 +66,7 @@ * * @startuml * class BatchCollect { - * +call(df: Dataset, id: Long, skipLimiting: boolean) : Dataset "Collects rows up to the defined limit unless skipLimiting is provided" + * + call(df: Dataset, id: Long, skipLimiting: boolean) : Dataset "Collects rows up to the defined limit unless skipLimiting is provided" * } * * BatchCollect --> SortByClause : sort order From 31091f679f33615f9552bc2a38865ec988b5b248 Mon Sep 17 00:00:00 2001 From: StrongestNumber9 <16169054+StrongestNumber9@users.noreply.github.com> Date: Mon, 18 Aug 2025 13:34:12 +0300 Subject: [PATCH 15/22] Revert "Updates call" This reverts commit 2c866e062feb0582ae5f4b8c78ce1f53a13d6b2d. --- src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java b/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java index 5fdd1bc..0b80559 100644 --- a/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java +++ b/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java @@ -66,7 +66,7 @@ * * @startuml * class BatchCollect { - * + call(df: Dataset, id: Long, skipLimiting: boolean) : Dataset "Collects rows up to the defined limit unless skipLimiting is provided" + * + call() * } * * BatchCollect --> SortByClause : sort order From fc5f9ef3087863902f14e0a7e62c33f43b4d0f02 Mon Sep 17 00:00:00 2001 From: StrongestNumber9 <16169054+StrongestNumber9@users.noreply.github.com> Date: Mon, 18 Aug 2025 14:09:54 +0300 Subject: [PATCH 16/22] Adds ObjectDesgin.java --- .../functions/dpf_02/ObjectDesign.java | 59 +++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 src/main/java/com/teragrep/functions/dpf_02/ObjectDesign.java diff --git a/src/main/java/com/teragrep/functions/dpf_02/ObjectDesign.java b/src/main/java/com/teragrep/functions/dpf_02/ObjectDesign.java new file mode 100644 index 0000000..d26dbd0 --- /dev/null +++ b/src/main/java/com/teragrep/functions/dpf_02/ObjectDesign.java @@ -0,0 +1,59 @@ +package com.teragrep.functions.dpf_02; + +/* + * Teragrep Batch Collect DPF-02 + * Copyright (C) 2019, 2020, 2021, 2022 Suomen Kanuuna Oy + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + * + * Additional permission under GNU Affero General Public License version 3 + * section 7 + * + * If you modify this Program, or any covered work, by linking or combining it + * with other code, such other code is not for that reason alone subject to any + * of the requirements of the GNU Affero GPL version 3 as long as this Program + * is the same Program as licensed from Suomen Kanuuna Oy without any additional + * modifications. + * + * Supplemented terms under GNU Affero General Public License version 3 + * section 7 + * + * Origin of the software must be attributed to Suomen Kanuuna Oy. Any modified + * versions must be marked as "Modified version of" The Program. + * + * Names of the licensors and authors may not be used for publicity purposes. + * + * No rights are granted for use of trade names, trademarks, or service marks + * which are in The Program if any. + * + * Licensee must indemnify licensors and authors for any liability that these + * contractual assumptions impose on licensors and authors. + * + * To the extent this program is licensed as part of the Commercial versions of + * Teragrep, the applicable Commercial License may apply to this file if you as + * a licensee so wish it. + */ + +/** + * @startuml + * !include src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java!0 + * !include src/main/java/com/teragrep/functions/dpf_02/SortByClause.java!0 + * + * @enduml + */ + +public class ObjectDesign { + +} From ec5bf55869f5922c835ba0b1c8eea5e7e17af397 Mon Sep 17 00:00:00 2001 From: StrongestNumber9 <16169054+StrongestNumber9@users.noreply.github.com> Date: Mon, 18 Aug 2025 14:10:02 +0300 Subject: [PATCH 17/22] Adds building fixes --- pom.xml | 34 +++++++++++++++++++ .../functions/dpf_02/BatchCollect.java | 2 +- 2 files changed, 35 insertions(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index ad76794..863428b 100644 --- a/pom.xml +++ b/pom.xml @@ -122,6 +122,38 @@ 11 + + + startuml + + startuml + + + enduml + + enduml + + + class + + class + + + brief + + brief + + + responsibilities + + responsibilities + + + collaborators + + collaborators + + @@ -163,6 +195,8 @@ .github/ISSUE_TEMPLATE/* toolchains.xml settings.xml + + Doxyfile README.adoc README.md diff --git a/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java b/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java index 0b80559..bd3d114 100644 --- a/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java +++ b/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java @@ -69,7 +69,7 @@ * + call() * } * - * BatchCollect --> SortByClause : sort order + * BatchCollect --> SortByClause : sort order * * note right of BatchCollect * Responsibilities: From 6b403d09dc35c55d45974f7d5c850983ca9321d6 Mon Sep 17 00:00:00 2001 From: StrongestNumber9 <16169054+StrongestNumber9@users.noreply.github.com> Date: Mon, 18 Aug 2025 15:41:38 +0300 Subject: [PATCH 18/22] Code BatchCollect --- pom.xml | 2 +- src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/pom.xml b/pom.xml index 863428b..3f12cce 100644 --- a/pom.xml +++ b/pom.xml @@ -113,7 +113,7 @@ org.apache.maven.plugins maven-javadoc-plugin - 3.5.0 + 3.11.3 attach-javadocs diff --git a/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java b/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java index bd3d114..6510b8b 100644 --- a/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java +++ b/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java @@ -69,7 +69,7 @@ * + call() * } * - * BatchCollect --> SortByClause : sort order + * {@code BatchCollect --> SortByClause : sort order} * * note right of BatchCollect * Responsibilities: @@ -81,6 +81,7 @@ * * @enduml */ + public final class BatchCollect extends SortOperation { private static final Logger LOGGER = LoggerFactory.getLogger(BatchCollect.class); private Dataset savedDs = null; From f6d2e071a01d3d6f16fc1c84d052f741241a4fa7 Mon Sep 17 00:00:00 2001 From: StrongestNumber9 <16169054+StrongestNumber9@users.noreply.github.com> Date: Mon, 18 Aug 2025 15:42:56 +0300 Subject: [PATCH 19/22] Revert accidental javadoc upgrade --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 3f12cce..863428b 100644 --- a/pom.xml +++ b/pom.xml @@ -113,7 +113,7 @@ org.apache.maven.plugins maven-javadoc-plugin - 3.11.3 + 3.5.0 attach-javadocs From 9ced345428d3b77434b0749ba071187a50ca7849 Mon Sep 17 00:00:00 2001 From: StrongestNumber9 <16169054+StrongestNumber9@users.noreply.github.com> Date: Tue, 19 Aug 2025 09:52:08 +0300 Subject: [PATCH 20/22] Disable doclint --- pom.xml | 1 + 1 file changed, 1 insertion(+) diff --git a/pom.xml b/pom.xml index 863428b..1c8d03a 100644 --- a/pom.xml +++ b/pom.xml @@ -122,6 +122,7 @@ 11 + -Xdoclint:none startuml From c8da0c7c340633f37932dff2bef58b0534ad6b6f Mon Sep 17 00:00:00 2001 From: StrongestNumber9 <16169054+StrongestNumber9@users.noreply.github.com> Date: Tue, 19 Aug 2025 09:56:19 +0300 Subject: [PATCH 21/22] Remove @code --- src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java b/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java index 6510b8b..0c98863 100644 --- a/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java +++ b/src/main/java/com/teragrep/functions/dpf_02/BatchCollect.java @@ -69,7 +69,7 @@ * + call() * } * - * {@code BatchCollect --> SortByClause : sort order} + * BatchCollect --> SortByClause : sort order * * note right of BatchCollect * Responsibilities: From 97008ba4eee5405b1f41a54332f778b8225a240a Mon Sep 17 00:00:00 2001 From: StrongestNumber9 <16169054+StrongestNumber9@users.noreply.github.com> Date: Tue, 19 Aug 2025 10:03:02 +0300 Subject: [PATCH 22/22] Use correct doclint none syntax --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 1c8d03a..870a799 100644 --- a/pom.xml +++ b/pom.xml @@ -122,7 +122,7 @@ 11 - -Xdoclint:none + none startuml