Merge pull request eclipse-tractusx#195 from catenax-ng/feat/api_remo…

…ve_admin_Level_2_alt_address feat(api): eclipse-tractusx#176 Remove Admin Level 2 - 4 from alternative address
catenax-ng · May 25, 2023 · d36e46c · d36e46c
2 parents 7c4ceae + d97e7cb
commit d36e46c
Show file tree

Hide file tree

Showing 23 changed files with 245 additions and 128 deletions.
diff --git a/bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/AddressIdentifierDto.kt b/bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/AddressIdentifierDto.kt
@@ -23,9 +23,9 @@ import io.swagger.v3.oas.annotations.media.Schema
 
 @Schema(name = "AddressIdentifier", description = "Identifier record for a logistic address")
 data class AddressIdentifierDto(
-    @Schema(description = "Value of the identifier")
+    @get:Schema(description = "Value of the identifier")
     val value: String,
 
-    @Schema(description = "Technical key of the type to which this identifier belongs to")
+    @get:Schema(description = "Technical key of the type to which this identifier belongs to")
     val type: String,
 )
diff --git a/bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/AddressStateDto.kt b/bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/AddressStateDto.kt
@@ -25,15 +25,15 @@ import java.time.LocalDateTime
 
 @Schema(name = "AddressState", description = "Status record for a address")
 data class AddressStateDto(
-    @Schema(description = "Description of the status")
+    @get:Schema(description = "Description of the status")
     val description: String?,
 
-    @Schema(description = "Since when the status is/was valid")
+    @get:Schema(description = "Since when the status is/was valid")
     val validFrom: LocalDateTime?,
 
-    @Schema(description = "Until the status was valid, if applicable")
+    @get:Schema(description = "Until the status was valid, if applicable")
     val validTo: LocalDateTime?,
 
-    @Schema(description = "The type of this specified status")
+    @get:Schema(description = "The type of this specified status")
     val type: BusinessStateType
 )
diff --git a/bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/AddressVersionDto.kt b/bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/AddressVersionDto.kt
@@ -25,8 +25,10 @@ import org.eclipse.tractusx.bpdm.common.model.CharacterSet
 
 @Schema(name = "AddressVersion", description = "Localization record for an address")
 data class AddressVersionDto(
-    @Schema(description = "Character set in which the address is written", defaultValue = "UNDEFINED")
+
+    @get:Schema(description = "Character set in which the address is written", defaultValue = "UNDEFINED")
     val characterSet: CharacterSet = CharacterSet.UNDEFINED,
-    @Schema(description = "Language in which the address is written", defaultValue = "undefined")
+
+    @get:Schema(description = "Language in which the address is written", defaultValue = "undefined")
     val language: LanguageCode = LanguageCode.undefined
 )
diff --git a/...ommon/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/AlternativePostalAddressDto.kt b/...ommon/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/AlternativePostalAddressDto.kt
@@ -29,12 +29,15 @@ import org.eclipse.tractusx.bpdm.common.service.DataClassUnwrappedJsonDeserializ
 @Schema(name = "AlternativePostalAddress", description = "Alternative Postal Address Part")
 data class AlternativePostalAddressDto(
 
+    @field:JsonUnwrapped
+    val baseAddress: BasePostalAddressDto,
+
+    @field:JsonUnwrapped
+    val areaPart: AreaDistrictAlternativDto,
+
     @get:Schema(description = "Describes the PO Box or private Bag number the delivery should be placed at.")
     val deliveryServiceNumber: String = "",
 
     @get:Schema(description = "The type of this specified delivery")
     val deliveryServiceType: DeliveryServiceType = DeliveryServiceType.PO_BOX,
-
-    @field:JsonUnwrapped
-    val baseAddress: BasePostalAddressDto,
 )
diff --git a/...-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/AreaDistrictAlternativDto.kt b/...-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/AreaDistrictAlternativDto.kt
@@ -0,0 +1,36 @@
+/*******************************************************************************
+ * Copyright (c) 2021,2023 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Apache License, Version 2.0 which is available at
+ * https://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ ******************************************************************************/
+
+package org.eclipse.tractusx.bpdm.common.dto
+
+import io.swagger.v3.oas.annotations.media.Schema
+
+@Schema(name = "AreaDistrictDto", description = "Record for administrativeAreaLevel and district part of an alternativ address")
+data class AreaDistrictAlternativDto(
+
+    @get:Schema(description = "Identifying code of the Region within the country (e.g. Bayern)")
+    val administrativeAreaLevel1: String? = null,
+
+    @get:Schema(description = "Divides the city in several smaller areas")
+    val districtLevel1: String? = null,
+
+    @get:Schema(description = "Divides the DistrictLevel1 in several smaller areas. Synonym: Subdistrict")
+    val districtLevel2: String? = null,
+
+    )
diff --git a/bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/AreaDistrictDto.kt b/bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/AreaDistrictDto.kt
@@ -0,0 +1,41 @@
+/*******************************************************************************
+ * Copyright (c) 2021,2023 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Apache License, Version 2.0 which is available at
+ * https://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ ******************************************************************************/
+
+package org.eclipse.tractusx.bpdm.common.dto
+
+import io.swagger.v3.oas.annotations.media.Schema
+
+@Schema(name = "AreaDistrictDto", description = "Record for administrativeAreaLevel and district part of an address")
+data class AreaDistrictDto(
+
+    @get:Schema(description = "Identifying code of the Region within the country (e.g. Bayern)")
+    val administrativeAreaLevel1: String? = null,
+
+    @get:Schema(description = "Further possibility to describe the region/address(e.g. County/Landkreis)")
+    val administrativeAreaLevel2: String? = null,
+
+    @get:Schema(description = "Further possibility to describe the region/address(e.g. Township/Gemeinde)")
+    val administrativeAreaLevel3: String? = null,
+
+    @get:Schema(description = "Divides the city in several smaller areas")
+    val districtLevel1: String? = null,
+
+    @get:Schema(description = "Divides the DistrictLevel1 in several smaller areas. Synonym: Subdistrict")
+    val districtLevel2: String? = null,
+)
diff --git a/bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/BasePostalAddressDto.kt b/bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/BasePostalAddressDto.kt
@@ -31,27 +31,12 @@ data class BasePostalAddressDto(
     @get:Schema(description = "Describes the country")
     val country: CountryCode,
 
-    @get:Schema(description = "Identifying code of the Region within the country (e.g. Bayern)")
-    val administrativeAreaLevel1: String? = null,
-
-    @get:Schema(description = "Further possibility to describe the region/address(e.g. County/Landkreis)")
-    val administrativeAreaLevel2: String? = null,
-
-    @get:Schema(description = "Further possibility to describe the region/address(e.g. Township/Gemeinde)")
-    val administrativeAreaLevel3: String? = null,
-
     @get:Schema(description = "A postal code, also known as postcode, PIN or ZIP Code")
     val postCode: String? = null,
 
     @get:Schema(description = "The city of the address (Synonym: Town, village, municipality)")
     val city: String,
-
-    @get:Schema(description = "Divides the city in several smaller areas")
-    val districtLevel1: String? = null,
-
-    @get:Schema(description = "Divides the DistrictLevel1 in several smaller areas. Synonym: Subdistrict")
-    val districtLevel2: String? = null,
-
+
     @get:Schema(description = "Address country")
     val street: StreetDto? = null,
 

diff --git a/bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/ClassificationDto.kt b/bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/ClassificationDto.kt
@@ -24,12 +24,12 @@ import org.eclipse.tractusx.bpdm.common.model.ClassificationType
 
 @Schema(name = "Classification", description = "Classification record for a business partner")
 data class ClassificationDto(
-    @Schema(description = "Name of the classification")
+    @get:Schema(description = "Name of the classification")
     val value: String?,
 
-    @Schema(description = "Identifying code of the classification, if applicable")
+    @get:Schema(description = "Identifying code of the classification, if applicable")
     val code: String?,
 
-    @Schema(description = "Type of specified classification")
+    @get:Schema(description = "Type of specified classification")
     val type: ClassificationType
 )
diff --git a/bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/FieldQualityRuleDto.kt b/bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/FieldQualityRuleDto.kt
@@ -25,15 +25,15 @@ import io.swagger.v3.oas.annotations.media.Schema
 @Schema(name = "FieldQualityRuleDto", description = "Rule for the quality level of an entity field ")
 data class FieldQualityRuleDto(
 
-    @Schema(description = "Path to the field")
+    @get:Schema(description = "Path to the field")
     val fieldPath: String,
 
-    @Schema(description = "Schema name of the entity the field belongs to")
+    @get:Schema(description = "Schema name of the entity the field belongs to")
     val schemaName: String?,
 
-    @Schema(description = "Country for wich the rule is valid")
+    @get:Schema(description = "Country for wich the rule is valid")
     val country: CountryCode,
 
-    @Schema(description = "Quality level of the field")
+    @get:Schema(description = "Quality level of the field")
     val qualityLevel: QualityLevel
 )
diff --git a/bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/GenericIdentifierDto.kt b/bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/GenericIdentifierDto.kt
@@ -23,9 +23,9 @@ import io.swagger.v3.oas.annotations.media.Schema
 
 @Schema(name = "GenericIdentifier", description = "Identifier record for a generic business partner")
 data class GenericIdentifierDto(
-    @Schema(description = "Value of the identifier")
+    @get:Schema(description = "Value of the identifier")
     val value: String,
 
-    @Schema(description = "Technical key of the type to which this identifier belongs to")
+    @get:Schema(description = "Technical key of the type to which this identifier belongs to")
     val type: String
 )
diff --git a/bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/GeoCoordinateDto.kt b/bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/GeoCoordinateDto.kt
@@ -23,10 +23,13 @@ import io.swagger.v3.oas.annotations.media.Schema
 
 @Schema(name = "GeoCoordinates", description = "Geo coordinates record for an address")
 data class GeoCoordinateDto(
-    @Schema(description = "Longitude coordinate")
+
+    @get:Schema(description = "Longitude coordinate")
     val longitude: Float,
-    @Schema(description = "Latitude coordinate")
+
+    @get:Schema(description = "Latitude coordinate")
     val latitude: Float,
-    @Schema(description = "Altitude, if applicable")
+
+    @get:Schema(description = "Altitude, if applicable")
     val altitude: Float? = null
 )
diff --git a/bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/PhysicalPostalAddressDto.kt b/bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/dto/PhysicalPostalAddressDto.kt
@@ -31,6 +31,9 @@ data class PhysicalPostalAddressDto(
     @field:JsonUnwrapped
     val baseAddress: BasePostalAddressDto,
 
+    @field:JsonUnwrapped
+    val areaPart: AreaDistrictDto,
+
     @get:Schema(description = "A separate postal code for a company, also known as postcode, PIN or ZIP Code")
     val companyPostCode: String? = null,
 

diff --git a/bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/service/SaasMappings.kt b/bpdm-common/src/main/kotlin/org/eclipse/tractusx/bpdm/common/service/SaasMappings.kt
@@ -217,16 +217,18 @@ object SaasMappings {
             building = map.building(),
             floor = map.floor(),
             door = map.door(),
-            baseAddress = BasePostalAddressDto(
-                geographicCoordinates = map.geoCoordinates(),
-                city = city,
-                country = country,
+            areaPart = AreaDistrictDto(
                 administrativeAreaLevel1 = map.adminAreaLevel1(),
                 administrativeAreaLevel2 = map.adminAreaLevel2(),
                 administrativeAreaLevel3 = null,
-                postCode = map.postcode(),
                 districtLevel1 = map.districtLevel1(),
                 districtLevel2 = map.districtLevel2(),
+            ),
+            baseAddress = BasePostalAddressDto(
+                geographicCoordinates = map.geoCoordinates(),
+                city = city,
+                country = country,
+                postCode = map.postcode(),
                 street = toStreetDto(map),
             )
         )
@@ -251,16 +253,16 @@ object SaasMappings {
         return AlternativePostalAddressDto(
             deliveryServiceNumber = deliveryServiceNumber,
             deliveryServiceType = deliveryServiceType,
+            areaPart = AreaDistrictAlternativDto(
+                administrativeAreaLevel1 = map.adminAreaLevel1(),
+                districtLevel1 = map.districtLevel1(),
+                districtLevel2 = map.districtLevel2(),
+            ),
             baseAddress = BasePostalAddressDto(
                 geographicCoordinates = map.geoCoordinates(),
                 city = city,
                 country = country,
-                administrativeAreaLevel1 = map.adminAreaLevel1(),
-                administrativeAreaLevel2 = map.adminAreaLevel2(),
-                administrativeAreaLevel3 = null,
                 postCode = map.postcode(),
-                districtLevel1 = map.districtLevel1(),
-                districtLevel2 = map.districtLevel2(),
                 street = toStreetDto(map),
             )
         )

diff --git a/bpdm-gate/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/service/ResponseMappings.kt b/bpdm-gate/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/service/ResponseMappings.kt
@@ -63,12 +63,10 @@ fun AlternativePostalAddressDto.toAlternativePostalAddressEntity(): AlternativeP
         geographicCoordinates = baseAddress.geographicCoordinates?.toGeographicCoordinateEntity(),
         country = baseAddress.country,
         administrativeAreaLevel1 = null, // TODO Add region mapping Logic
-        administrativeAreaLevel2 = baseAddress.administrativeAreaLevel2,
-        administrativeAreaLevel3 = baseAddress.administrativeAreaLevel3,
         postCode = baseAddress.postCode,
         city = baseAddress.city,
-        districtLevel1 = baseAddress.districtLevel1,
-        districtLevel2 = baseAddress.districtLevel2,
+        districtLevel1 = areaPart.districtLevel1,
+        districtLevel2 = areaPart.districtLevel2,
         street = baseAddress.street?.toStreetEntity(),
         deliveryServiceType = deliveryServiceType,
         deliveryServiceNumber = deliveryServiceNumber
@@ -82,12 +80,12 @@ fun PhysicalPostalAddressDto.toPhysicalPostalAddressEntity(): PhysicalPostalAddr
         geographicCoordinates = baseAddress.geographicCoordinates?.toGeographicCoordinateEntity(),
         country = baseAddress.country,
         administrativeAreaLevel1 = null, // TODO Add region mapping Logic
-        administrativeAreaLevel2 = baseAddress.administrativeAreaLevel2,
-        administrativeAreaLevel3 = baseAddress.administrativeAreaLevel3,
+        administrativeAreaLevel2 = areaPart.administrativeAreaLevel2,
+        administrativeAreaLevel3 = areaPart.administrativeAreaLevel3,
         postCode = baseAddress.postCode,
         city = baseAddress.city,
-        districtLevel1 = baseAddress.districtLevel1,
-        districtLevel2 = baseAddress.districtLevel2,
+        districtLevel1 = areaPart.districtLevel1,
+        districtLevel2 = areaPart.districtLevel2,
         street = baseAddress.street?.toStreetEntity(),
         companyPostCode = companyPostCode,
         industrialZone = industrialZone,