| | | 1 | | using System.Diagnostics.CodeAnalysis; |
| | | 2 | | using System.Text.Json.Serialization; |
| | | 3 | | using Spdx3.Exceptions; |
| | | 4 | | using Spdx3.Model.Core.Classes; |
| | | 5 | | using Spdx3.Model.Core.Enums; |
| | | 6 | | using Spdx3.Model.Dataset.Enums; |
| | | 7 | | using Spdx3.Model.Software.Classes; |
| | | 8 | | using Spdx3.Serialization; |
| | | 9 | | using Spdx3.Utility; |
| | | 10 | | |
| | | 11 | | namespace Spdx3.Model.Dataset.Classes; |
| | | 12 | | |
| | | 13 | | /// <summary> |
| | | 14 | | /// Specifies a data package and its associated information. |
| | | 15 | | /// See https://spdx.github.io/spdx-spec/v3.0.1/model/Dataset/Classes/DatasetPackage/ |
| | | 16 | | /// </summary> |
| | | 17 | | public class DatasetPackage : Package |
| | | 18 | | { |
| | | 19 | | private int? _datasetSize; |
| | | 20 | | |
| | | 21 | | [JsonPropertyName("dataset_anonymizationMethodUsed")] |
| | | 22 | | [JsonConverter(typeof(SpdxModelConverterFactory))] |
| | 5 | 23 | | public IList<string> AnonymizationMethodUsed { get; set; } = new List<string>(); |
| | | 24 | | |
| | | 25 | | [JsonPropertyName("dataset_confidentialityLevel")] |
| | | 26 | | [JsonConverter(typeof(SpdxModelConverterFactory))] |
| | 1 | 27 | | public ConfidentialityLevelType? ConfidentialityLevel { get; set; } |
| | | 28 | | |
| | | 29 | | [JsonPropertyName("dataset_datasetAvailability")] |
| | | 30 | | [JsonConverter(typeof(SpdxModelConverterFactory))] |
| | 1 | 31 | | public DataAvailabilityType? DataAvailabilityType { get; set; } |
| | | 32 | | |
| | | 33 | | [JsonPropertyName("dataset_dataCollectionProcess")] |
| | | 34 | | [JsonConverter(typeof(SpdxModelConverterFactory))] |
| | 1 | 35 | | public string? DataCollectionProcess { get; set; } |
| | | 36 | | |
| | | 37 | | [JsonPropertyName("dataset_dataPreprocessing")] |
| | | 38 | | [JsonConverter(typeof(SpdxModelConverterFactory))] |
| | 5 | 39 | | public IList<string> DataPreprocessing { get; set; } = new List<string>(); |
| | | 40 | | |
| | | 41 | | [JsonPropertyName("dataset_datasetNoise")] |
| | | 42 | | [JsonConverter(typeof(SpdxModelConverterFactory))] |
| | 1 | 43 | | public string? DatasetNoise { get; set; } |
| | | 44 | | |
| | | 45 | | [JsonPropertyName("dataset_datasetSize")] |
| | | 46 | | [JsonConverter(typeof(SpdxModelConverterFactory))] |
| | | 47 | | public int? DatasetSize |
| | | 48 | | { |
| | 4 | 49 | | get => _datasetSize; |
| | | 50 | | set |
| | | 51 | | { |
| | | 52 | | switch (value) |
| | | 53 | | { |
| | | 54 | | case < 0: |
| | 1 | 55 | | throw new Spdx3Exception($"Value of {value} is not a positive non-zero integer", |
| | 1 | 56 | | new ArgumentOutOfRangeException(nameof(DatasetSize))); |
| | | 57 | | case null: |
| | 1 | 58 | | _datasetSize = null; |
| | 1 | 59 | | break; |
| | | 60 | | default: |
| | 1 | 61 | | _datasetSize = value; |
| | | 62 | | break; |
| | | 63 | | } |
| | 1 | 64 | | } |
| | | 65 | | } |
| | | 66 | | |
| | | 67 | | [JsonPropertyName("dataset_datasetType")] |
| | | 68 | | [JsonConverter(typeof(SpdxModelConverterFactory))] |
| | 12 | 69 | | public IList<DatasetType> DatasetType { get; set; } = new List<DatasetType>(); |
| | | 70 | | |
| | | 71 | | [JsonPropertyName("dataset_datasetUpdateMechanism")] |
| | | 72 | | [JsonConverter(typeof(SpdxModelConverterFactory))] |
| | 1 | 73 | | public string? DatasetUpdateMechanism { get; set; } |
| | | 74 | | |
| | | 75 | | [JsonPropertyName("dataset_hasSensitivePersonalInformation")] |
| | | 76 | | [JsonConverter(typeof(SpdxModelConverterFactory))] |
| | 1 | 77 | | public PresenceType? HasSensitivePersonalInformation { get; set; } |
| | | 78 | | |
| | | 79 | | [JsonPropertyName("dataset_intendedUse")] |
| | | 80 | | [JsonConverter(typeof(SpdxModelConverterFactory))] |
| | 1 | 81 | | public string? IntendedUse { get; set; } |
| | | 82 | | |
| | | 83 | | [JsonPropertyName("dataset_knownBias")] |
| | | 84 | | [JsonConverter(typeof(SpdxModelConverterFactory))] |
| | 1 | 85 | | public string? KnownBias { get; set; } |
| | | 86 | | |
| | | 87 | | [JsonPropertyName("dataset_sensor")] |
| | | 88 | | [JsonConverter(typeof(SpdxModelConverterFactory))] |
| | 5 | 89 | | public IList<DictionaryEntry> Sensor { get; set; } = new List<DictionaryEntry>(); |
| | | 90 | | |
| | | 91 | | |
| | | 92 | | // protected internal no-parm constructor required for deserialization |
| | | 93 | | // ReSharper disable once UnusedMember.Global |
| | 0 | 94 | | protected internal DatasetPackage() |
| | | 95 | | { |
| | 0 | 96 | | } |
| | | 97 | | |
| | | 98 | | [SetsRequiredMembers] |
| | 3 | 99 | | public DatasetPackage(Catalog catalog, CreationInfo creationInfo, IList<DatasetType> datasetTypes) : base(catalog, |
| | 3 | 100 | | creationInfo) |
| | | 101 | | { |
| | 3 | 102 | | if (datasetTypes.Count == 0) |
| | | 103 | | { |
| | 0 | 104 | | throw new ArgumentException( |
| | 0 | 105 | | $"{nameof(datasetTypes)} list needs to contain at least one dataset type value"); |
| | | 106 | | } |
| | 3 | 107 | | DatasetType = new List<DatasetType>(); |
| | 6 | 108 | | datasetTypes.ToList().ForEach(ds => DatasetType.Add(ds)); |
| | 3 | 109 | | } |
| | | 110 | | |
| | | 111 | | public override void Validate() |
| | | 112 | | { |
| | 1 | 113 | | base.Validate(); |
| | | 114 | | |
| | 1 | 115 | | if (DatasetType?.Count == 0) |
| | | 116 | | { |
| | 0 | 117 | | throw new Spdx3ValidationException(this, nameof(DatasetType), "List is empty"); |
| | | 118 | | } |
| | 1 | 119 | | } |
| | | 120 | | } |