Spdx-Java-Library/spdx-java-lib-family.plantuml at master · spdx/Spdx-Java-Library · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
' SPDX-FileCopyrightText: 2025 SPDX contributors
' SPDX-FileType: DOCUMENTATION
' SPDX-License-Identifier: Apache-2.0

' Use PlantUML to generate PNG or SVG diagrams from this file.
' See https://plantuml.com/ for installation and usage instructions.

@startuml spdx-java-lib-family
scale 1.5

title Family of SPDX Java libraries

' Left-to-right layout is more familiar for readers of left-to-right languages.
left to right direction

' Use "package" to group related components and improve readability.
' This does not imply actual Java package structure.
package "SPDX Java libraries" {
    package "Core libraries" as core_pkg {
        component "<b><size:20>java-spdx-library</size></b>\nCore library & helpers" as lib #LightSalmon
        component "<b><size:20>spdx-java-core</size></b>\nCore utilities" as core #LightYellow
        component "<b><size:20>org.spdx.storage.IModelStore</size></b>\nStorage service provider interface" as storeSPI #LightBlue
        component "<b><size:20>org.spdx.storage.simple.InMemSpdxStore</size></b>\nSimple in-memory store" as inmem #LightBlue
    }

    package "Models" as model_pkg {
        component "<b><size:20>spdx-java-model-2_X</size></b>\nSPDX 2 model" as model2 #LightGreen
        component "<b><size:20>spdx-java-model-3_0</size></b>\nSPDX 3 model" as model3 #LightGreen
    }

    package "Storage implementations" as store_pkg {
        component "<b><size:20>spdx-java-tagvalue-store</size></b>\nTag-Value store" as tagvalue #LightBlue
        component "<b><size:20>spdx-java-rdf-store</size></b>\nRDF store" as rdf #LightBlue
        component "<b><size:20>spdx-java-spreadsheet-store</size></b>\nXLS spreadsheet store" as sheet #LightBlue
        component "<b><size:20>spdx-java-jackson-store</size></b>\nJSON / XML / YAML store" as jackson #LightBlue
        component "<b><size:20>spdx-java-v3jsonld-store</size></b>\nSPDX 3 JSON-LD store" as v3jsonld #LightBlue
    }

    package "Tooling" as tooling_pkg {
        component "<b><size:20>spdx-maven-plugin</size></b>\nMaven integration" as maven
        component "<b><size:20>spdx-model-to-java</size></b>\nJava code generator for SPDX 3 model" as genmodel3
    }

    package "Specifications" as spec_pkg {
        component "<i><size:20>spdx-model.ttl</size></i>\nSPDX 3 specification RDF 1.1 Turtle file" as spdx3turtle
    }

    package "User-facing applications" as app_pkg {
        component "<b><size:20>tools-java</size></b>\nCommand-line tools" as tools
        component "<i><size:20>spdx-online-tools</size></i>\nWeb-based tools" as online
    }
}

' Core libraries and models
lib --> core : depends on
lib --> model2 : depends on
lib --> model3 : depends on

' Storage SPI and implementations
core --> storeSPI : contains
lib --> inmem : contains
inmem ..|> storeSPI : implements
jackson ..|> storeSPI : implements
rdf ..|> storeSPI : implements
sheet ..|> storeSPI : implements
tagvalue ..|> storeSPI : implements
v3jsonld ..|> storeSPI : implements

' Tooling
maven --> lib : depends on
genmodel3 --> model3 : generates
genmodel3 -left-> spdx3turtle : has data file

' User-facing applications
tools --> lib : depends on
online --> tools : depends on

' Layout hints
spec_pkg -[hidden]-> tooling_pkg
store_pkg -[hidden]-> core_pkg
inmem -[hidden]-> store_pkg
model_pkg -[hidden]-> core_pkg

@enduml