Skip to content

Commit 41cc66e

Browse files
committed
docs: Update package READMEs for 1.6.0
1 parent 9da5684 commit 41cc66e

3 files changed

Lines changed: 9 additions & 6 deletions

File tree

src/main/java/eu/europa/ted/eforms/sdk/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ The `eu.europa.ted.eforms.sdk` package contains the core classes and packages th
44

55
The main packages included here are:
66

7-
* `component`: Provides a solution for handling multiple major versions of the SDK in parallel.
7+
* `component`: Provides a solution for handling multiple major versions of the SDK in parallel.
8+
* `entity`: Provides abstract entity classes for representing SDK metadata (fields, nodes, codelists, notice subtypes, data types).
9+
* `repository`: Provides classes for reading SDK entities from JSON and Genericode files.
810
* `resource`: Provides a solution for automatically discovering and downloading new versions of the eForms SDK.
911

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Common Entities
22

3-
The entities in this package can be used while reading data from the eForms SDK. Currently there are only four entities implemented here:
3+
The entities in this package can be used while reading data from the eForms SDK. The following entities are implemented here:
44

5-
* `SdkField`: Can hold basic information about a field.
6-
* `SdkNode`: Can hold basic information about a node and reconstruct the node hierarchy.
5+
* `SdkField`: Can hold basic information about a field, including repeatability, parent node, XPath metadata, and privacy settings.
6+
* `SdkNode`: Can hold basic information about a node and reconstruct the node hierarchy via parent references and ancestor chain traversal.
77
* `SdkCodelist`: Can hold codelist information including its codes.
88
* `SdkNoticeSubtype`: Can hold information about a notice subtype from the SDK's notice-types.json file.
9+
* `SdkDataType`: Can hold field type-level metadata including privacy masking values.
910

1011
All the classes are abstract so that they can have specific implementations for different major versions of the eForms SDK if needed.
1112

1213
This package also includes a factory class (`SdkEntityFactory`) that is meant to be used for instantiating concrete implementations of these abstract entity classes for different major versions of the eForms SDK.
1314

14-
_There is no rocket science in the code in this package. You are welcome to reuse it. It is intended to be used primarily by the EFX Toolkit and our sample applications._

src/main/java/eu/europa/ted/eforms/sdk/repository/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,5 @@ This package contains:
1010
* `SdkFieldRepository`: can populate a `HashMap` with `SdkField` objects read form `fields.json`
1111
* `SdkNodeRepository`: can populate a `HashMap` with `SdkNode` objects read form `fields.json`
1212
* `SdkCodelistRepository`: can populate a `HashMap` with `SdkCodelist` objects (including all codelist codes), by reading the `.gc` files from the `codelists` folder of the eForms SDK.
13-
* `SdkNoticeTypeRepository`: can populate a `HashMap` with `SdkNoticeSubtype` objects read from `notice-types.json`
13+
* `SdkNoticeTypeRepository`: can populate a `HashMap` with `SdkNoticeSubtype` objects read from `notice-types.json`
14+
* `SdkDataTypeRepository`: can populate a `HashMap` with `SdkDataType` objects

0 commit comments

Comments
 (0)