#259

Committed 05 Feb 2025 03:13PM UTC coverage: 78.205% (-1.4%) from 79.617%

Build # #259

Build Type

push

Committed by

Commit Message

Merge pull request #76 from wistefan/with-rel

support relationships

Run Details

46 of 72 new or added lines in 3 files covered. (63.89%)

1 existing line in 1 file now uncovered.

610 of 780 relevant lines covered (78.21%)

0.78 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

82.52

/src/main/java/io/github/wistefan/mapping/JavaObjectMapper.java

package io.github.wistefan.mapping;

import io.github.wistefan.mapping.annotations.*;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.fiware.ngsi.model.*;

import javax.inject.Singleton;
import java.lang.annotation.Annotation;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.net.URI;
import java.util.*;
import java.util.stream.Collectors;
import java.util.stream.Stream;

/**
 * Mapper to handle translation from Java-Objects into NGSI-LD entities.
 */
@Slf4j
@Singleton
@RequiredArgsConstructor
public class JavaObjectMapper extends Mapper {

        // name of the property containing the ID
        private static final String ID_PROPERTY = "id";
        private final MappingProperties mappingProperties;

        public static final String NO_MAPPING_DEFINED_FOR_METHOD_TEMPLATE = "No mapping defined for method %s";
        public static final String WAS_NOT_ABLE_INVOKE_METHOD_TEMPLATE = "Was not able invoke method %s on %s";


        /**
         * Translate the attribute path for the given object into the path in the ngsi-ld model.
         *
         * @param attributePath the original path
         * @param tClass        class to use for translation
         * @return the path in ngsi-ld and the type of the target attribute
         */
        public static <T> NgsiLdAttribute getNGSIAttributePath(List<String> attributePath, Class<T> tClass) {
                List<String> ngsiAttributePath = new ArrayList<>();
                QueryAttributeType type = QueryAttributeType.STRING;
                String currentAttribute = attributePath.get(0);
                if (currentAttribute.equals(ID_PROPERTY)) {
                        ngsiAttributePath.add(ID_PROPERTY);
                        return new NgsiLdAttribute(ngsiAttributePath, QueryAttributeType.STRING);
                }
                if (isMappingEnabled(tClass).isPresent()) {
                        // for mapped properties, we have to climb down the property names
                        // we need the setter in case of type-erasure and the getter in all other cases
                        Optional<Method> setter = getSetterMethodByName(tClass, currentAttribute)
                                        .filter(m -> getAttributeSetter(m.getAnnotations()).isPresent())
                                        .findFirst();
                        Optional<Method> getter = getGetterMethodByName(tClass, currentAttribute)
                                        .filter(m -> getAttributeGetter(m.getAnnotations()).isPresent())
                                        .findFirst();
                        if (setter.isPresent() && getter.isPresent()) {
                                Method setterMethod = setter.get();
                                Method getterMethod = getter.get();
                                // no need to check again
                                AttributeSetter setterAnnotation = getAttributeSetter(setterMethod.getAnnotations()).get();
                                ngsiAttributePath.add(setterAnnotation.targetName());
                                type = fromClass(getterMethod.getReturnType());
                                if (attributePath.size() > 1) {
                                        List<String> subPaths = attributePath.subList(1, attributePath.size());
                                        if (setterAnnotation.targetClass() != Object.class) {
                                                NgsiLdAttribute subAttribute = getNGSIAttributePath(subPaths, setterAnnotation.targetClass());
                                                ngsiAttributePath.addAll(subAttribute.path());
                                                type = subAttribute.type();
                                        } else {
                                                NgsiLdAttribute subAttribute = getNGSIAttributePath(subPaths, getterMethod.getReturnType());
                                                ngsiAttributePath.addAll(subAttribute.path());
                                                type = subAttribute.type();
                                        }
                                }
                        } else {
                                log.warn("No corresponding field does exist for attribute {} on {}.", currentAttribute,
                                                tClass.getCanonicalName());
                        }
                } else {
                        // we can use the "plain" object field-names, no additional mapping happens anymore
                        ngsiAttributePath.addAll(attributePath);
                        type = evaluateType(attributePath, tClass);
                }
                return new NgsiLdAttribute(ngsiAttributePath, type);
        }

        private static QueryAttributeType evaluateType(List<String> path, Class<?> tClass) {
                Class<?> currentClass = tClass;
                for (String s : path) {
                        try {
                                Optional<Class<?>> optionalReturn = getGetterMethodByName(currentClass, s).findAny()
                                                .map(Method::getReturnType);
                                if (optionalReturn.isPresent()) {
                                        currentClass = optionalReturn.get();
                                } else {
                                        currentClass = currentClass.getField(s).getType();
                                }
                        } catch (NoSuchFieldException e) {
                                throw new MappingException(String.format("No field %s exists for %s.", s, tClass.getCanonicalName()),
                                                e);
                        }
                }
                return fromClass(currentClass);
        }

        private static QueryAttributeType fromClass(Class<?> tClass) {
                if (Number.class.isAssignableFrom(tClass)) {
                        return QueryAttributeType.NUMBER;
                } else if (Boolean.class.isAssignableFrom(tClass)) {
                        return QueryAttributeType.BOOLEAN;
                }
                return QueryAttributeType.STRING;

        }

        public static <T> Stream<Method> getSetterMethodByName(Class<T> tClass, String propertyName) {
                return Arrays.stream(tClass.getMethods())
                                .filter(m -> getCorrespondingSetterFieldName(m.getName()).equals(propertyName));
        }

        public static <T> Stream<Method> getGetterMethodByName(Class<T> tClass, String propertyName) {
                return Arrays.stream(tClass.getMethods())
                                .filter(m -> getCorrespondingGetterFieldName(m.getName()).equals(propertyName));
        }

        private static String getCorrespondingGetterFieldName(String methodName) {
                var fieldName = "";
                if (methodName.matches("^get[A-Z].*")) {
                        fieldName = methodName.replaceFirst("get", "");
                } else if (methodName.matches("^is[A-Z].*")) {
                        fieldName = methodName.replaceFirst("is", "");
                } else {
                        log.debug("The method {} is neither a get or is.", methodName);
                        return fieldName;
                }
                return fieldName.substring(0, 1).toLowerCase() + fieldName.substring(1);
        }

        private static String getCorrespondingSetterFieldName(String methodName) {
                var fieldName = "";
                if (methodName.matches("^set[A-Z].*")) {
                        fieldName = methodName.replaceFirst("set", "");
                } else if (methodName.matches("^is[A-Z].*")) {
                        fieldName = methodName.replaceFirst("is", "");
                } else {
                        log.debug("The method {} is neither a set or is.", methodName);
                        return fieldName;
                }
                return fieldName.substring(0, 1).toLowerCase() + fieldName.substring(1);
        }

        /**
         * Translate the given object into an Entity.
         *
         * @param entity the object representing the entity
         * @param <T>    class of the entity
         * @return the NGSI-LD entity object
         */
        public <T> EntityVO toEntityVO(T entity) {
                isMappingEnabled(entity.getClass())
                                .orElseThrow(() -> new UnsupportedOperationException(
                                                String.format("Generic mapping to NGSI-LD entities is not supported for object %s",
                                                                entity)));

                List<Method> entityIdMethod = new ArrayList<>();
                List<Method> entityTypeMethod = new ArrayList<>();
                List<Method> propertyMethods = new ArrayList<>();
                List<Method> propertyListMethods = new ArrayList<>();
                List<Method> relationshipMethods = new ArrayList<>();
                List<Method> relationshipListMethods = new ArrayList<>();
                List<Method> geoPropertyMethods = new ArrayList<>();
                List<Method> geoPropertyListMethods = new ArrayList<>();
                List<Method> unmappedPropertiesGetterMethods = new ArrayList<>();

                Arrays.stream(entity.getClass().getMethods()).forEach(method -> {
                        if (isEntityIdMethod(method)) {
                                entityIdMethod.add(method);
                        } else if (isEntityTypeMethod(method)) {
                                entityTypeMethod.add(method);
                        } else if (isUnmappedPropertiesGetter(method)) {
                                unmappedPropertiesGetterMethods.add(method);
                        } else {
                                getAttributeGetter(method.getAnnotations()).ifPresent(annotation -> {
                                        switch (annotation.value()) {
                                                case PROPERTY -> propertyMethods.add(method);
                                                // We handle property lists the same way as properties, since it is mapped as a property which value is a json array.
                                                // A real NGSI-LD property list would require a datasetId, that is not provided here.
                                                case PROPERTY_LIST -> propertyMethods.add(method);
                                                case GEO_PROPERTY -> geoPropertyMethods.add(method);
                                                case RELATIONSHIP -> relationshipMethods.add(method);
                                                case GEO_PROPERTY_LIST -> geoPropertyListMethods.add(method);
                                                case RELATIONSHIP_LIST -> relationshipListMethods.add(method);
                                                default -> throw new UnsupportedOperationException(
                                                                String.format("Mapping target %s is not supported.", annotation.value()));
                                        }
                                });
                        }
                });

                if (entityIdMethod.size() != 1) {
                        throw new MappingException(
                                        String.format("The provided object declares %s id methods, exactly one is expected.",
                                                        entityIdMethod.size()));
                }
                if (entityTypeMethod.size() != 1) {
                        throw new MappingException(
                                        String.format("The provided object declares %s type methods, exactly one is expected.",
                                                        entityTypeMethod.size()));

                }

                if (unmappedPropertiesGetterMethods.isEmpty()) {
                        return buildEntity(entity, entityIdMethod.get(0), entityTypeMethod.get(0), Optional.empty(), propertyMethods,
                                        propertyListMethods,
                                        geoPropertyMethods, relationshipMethods, relationshipListMethods);
                } else {
                        return buildEntity(entity, entityIdMethod.get(0), entityTypeMethod.get(0), Optional.of(unmappedPropertiesGetterMethods.get(0)), propertyMethods,
                                        propertyListMethods,
                                        geoPropertyMethods, relationshipMethods, relationshipListMethods);
                }
        }

        /**
         * Build the entity from its declared methods.
         */
        private <T> EntityVO buildEntity(T entity, Method entityIdMethod, Method entityTypeMethod, Optional<Method> unmappedPropertiesMethod,
                                                                         List<Method> propertyMethods, List<Method> propertyListMethods,
                                                                         List<Method> geoPropertyMethods,
                                                                         List<Method> relationshipMethods, List<Method> relationshipListMethods) {

                EntityVO entityVO = new EntityVO();
                entityVO.setAtContext(mappingProperties.getContextUrl());

                // TODO: include extraction via annotation for all well-known attributes
                entityVO.setOperationSpace(null);
                entityVO.setObservationSpace(null);
                entityVO.setLocation(null);

                try {
                        Object entityIdObject = entityIdMethod.invoke(entity);
                        if (!(entityIdObject instanceof URI)) {
                                throw new MappingException(
                                                String.format("The entityId method does not return a valid URI for entity %s.", entity));
                        }
                        entityVO.id((URI) entityIdObject);

                        Object entityTypeObject = entityTypeMethod.invoke(entity);
                        if (!(entityTypeObject instanceof String)) {
                                throw new MappingException("The entityType method does not return a valid String.");
                        }
                        entityVO.setType((String) entityTypeObject);
                } catch (IllegalAccessException | InvocationTargetException e) {
                        throw new MappingException(String.format(WAS_NOT_ABLE_INVOKE_METHOD_TEMPLATE, "unknown-method", entity),
                                        e);
                }

                Map<String, AdditionalPropertyVO> additionalProperties = new LinkedHashMap<>();
                additionalProperties.putAll(buildProperties(entity, propertyMethods));
                additionalProperties.putAll(buildPropertyList(entity, propertyListMethods));
                additionalProperties.putAll(buildGeoProperties(entity, geoPropertyMethods));
                if (unmappedPropertiesMethod.isPresent()) {
                        additionalProperties.putAll(buildUnmappedProperties(entity, unmappedPropertiesMethod.get()));
                }
                Map<String, RelationshipVO> relationshipVOMap = buildRelationships(entity, relationshipMethods);
                Map<String, RelationshipListVO> relationshipListVOMap = buildRelationshipList(entity,
                                relationshipListMethods);
                // we need to post-process the relationships, since orion-ld only accepts dataset-ids for lists > 1
                relationshipVOMap.entrySet().stream().forEach(e -> e.getValue().setDatasetId(null));
                relationshipListVOMap.entrySet().stream().forEach(e -> {
                        if (e.getValue().size() == 1) {
                                e.getValue().get(0).setDatasetId(null);
                        }
                });

                additionalProperties.putAll(relationshipVOMap);
                additionalProperties.putAll(relationshipListVOMap);

                additionalProperties.forEach(entityVO::setAdditionalProperties);

                return entityVO;
        }

        /**
         * Check if the given method defines the entity type
         */
        private boolean isEntityTypeMethod(Method method) {
                return Arrays.stream(method.getAnnotations()).anyMatch(EntityType.class::isInstance);
        }

        /**
         * Check if the given method defines the entity id
         */
        private boolean isEntityIdMethod(Method method) {
                return Arrays.stream(method.getAnnotations()).anyMatch(EntityId.class::isInstance);
        }

        /**
         * Check if the given method handles access to the unmapped properties
         */
        private boolean isUnmappedPropertiesGetter(Method method) {
                return Arrays.stream(method.getAnnotations()).anyMatch(UnmappedPropertiesGetter.class::isInstance);
        }

        /**
         * Build a relationship from the declared methods
         */
        private <T> Map<String, RelationshipVO> buildRelationships(T entity, List<Method> relationshipMethods) {
                return relationshipMethods.stream()
                                .map(method -> methodToRelationshipEntry(entity, method))
                                .filter(Optional::isPresent)
                                .map(Optional::get)
                                .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
        }

        /**
         * Build a list of relationships from the declared methods
         */
        private <
                        T> Map<String, RelationshipListVO> buildRelationshipList(T entity, List<Method> relationshipListMethods) {
                return relationshipListMethods.stream()
                                .map(relationshipMethod -> methodToRelationshipListEntry(entity, relationshipMethod))
                                .filter(Optional::isPresent)
                                .map(Optional::get)
                                .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
        }

        /*
         * Build a list of properties from the declared methods
         */
        private <T> Map<String, PropertyListVO> buildPropertyList(T entity, List<Method> propertyListMethods) {
                return propertyListMethods.stream()
                                .map(propertyListMethod -> methodToPropertyListEntry(entity, propertyListMethod))
                                .filter(Optional::isPresent)
                                .map(Optional::get)
                                .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
        }

        /**
         * Build geoproperties from the declared methods
         */
        private <T> Map<String, GeoPropertyVO> buildGeoProperties(T entity, List<Method> geoPropertyMethods) {
                return geoPropertyMethods.stream()
                                .map(geoPropertyMethod -> methodToGeoPropertyEntry(entity, geoPropertyMethod))
                                .filter(Optional::isPresent)
                                .map(Optional::get)
                                .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
        }

        private Map.Entry<String, AdditionalPropertyVO> unmappedPropertyToAdditionalProperty(UnmappedProperty unmappedProperty) {
                AdditionalPropertyVO additionalPropertyVO = objectToAdditionalProperty(unmappedProperty.getValue());
                return new AbstractMap.SimpleEntry<>(unmappedProperty.getName(), additionalPropertyVO);

        }

        private AdditionalPropertyVO mapToRelationship(Map<?, ?> objectMap) {
                RelationshipVO relationshipVO = new RelationshipVO();
                if (objectMap.get(ID_PROPERTY) instanceof String id) {
                        relationshipVO.setObject(URI.create(id));
                } else {
                        throw new MappingException(String.format("The id is not a valid id. Object is %s", objectMap.get(ID_PROPERTY)));
                }
                objectMap.forEach((key, value) -> {
                        if (key instanceof String name) {
                                if (name.equals(ID_PROPERTY)) {
                                        return;
                                }
                                relationshipVO.setAdditionalProperties(name, objectToAdditionalProperty(value));
                        } else {
                                throw new MappingException(String.format("Only string keys are supported, but was %s", key));
                        }
                });
                return relationshipVO;
        }

        private AdditionalPropertyVO objectToAdditionalProperty(Object o) {
                if (o instanceof Map<?, ?> objectMap) {
                        if (objectMap.containsKey(ID_PROPERTY)) {
                                // contains key "id" -> relationship
                                return mapToRelationship(objectMap);
                        } else {
                                PropertyVO propertyVO = new PropertyVO();
                                Map<String, AdditionalPropertyVO> values = new HashMap<>();
                                objectMap.forEach((key, value) -> {
                                        if (key instanceof String name) {
                                                propertyVO.setAdditionalProperties(name, objectToAdditionalProperty(value));
                                                values.put(name, objectToAdditionalProperty(value));
                                        } else {
                                                throw new MappingException(String.format("Only string keys are supported, but was %s", key));
                                        }
                                });
                                return propertyVO.value(values);
                        }
                } else if (o instanceof List<?> objectList) {
                        PropertyListVO propertyVOS = new PropertyListVO();
                        RelationshipListVO relationshipVOS = new RelationshipListVO();
                        // as of now, we don't support property lists of property lists
                        objectList.stream()
                                        .map(this::objectToAdditionalProperty)
                                        .forEach(apvo -> {
                                                if (apvo instanceof PropertyVO pvo) {
                                                        propertyVOS.add(pvo);
                                                }
                                                if (apvo instanceof RelationshipVO rvo) {
                                                        relationshipVOS.add(rvo);
                                                }
                                        });
                        if (!propertyVOS.isEmpty() && !relationshipVOS.isEmpty()) {
                                throw new MappingException("Mixed lists are not supported");
                        }
                        if (!propertyVOS.isEmpty()) {
                                return propertyVOS;
                        }
                        if (!relationshipVOS.isEmpty()) {
                                return relationshipVOS;
                        }
                        return propertyVOS;
                } else {
                        PropertyVO propertyVO = new PropertyVO().value(o);
                        return propertyVO;
                }
        }

        private <T> Map<String, AdditionalPropertyVO> buildUnmappedProperties(T entity, Method method) {
                try {
                        Object unmappedProperties = method.invoke(entity);
                        if (unmappedProperties instanceof List<?> unmappedPropertiesList) {
                                List<UnmappedProperty> theList = unmappedPropertiesList
                                                .stream()
                                                .filter(UnmappedProperty.class::isInstance)
                                                .map(UnmappedProperty.class::cast)
                                                .toList();
                                return theList.stream()
                                                .map(this::unmappedPropertyToAdditionalProperty)
                                                .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
                        } else {
                                throw new MappingException("Only lists of additional Properties are supported.");
                        }

                } catch (IllegalAccessException | InvocationTargetException e) {
                        throw new MappingException(String.format(WAS_NOT_ABLE_INVOKE_METHOD_TEMPLATE, method, entity));
                }
        }


        /**
         * Build properties from the declared methods
         */
        private <T> Map<String, PropertyVO> buildProperties(T entity, List<Method> propertyMethods) {
                return propertyMethods.stream()
                                .map(propertyMethod -> methodToPropertyEntry(entity, propertyMethod))
                                .filter(Optional::isPresent)
                                .map(Optional::get)
                                .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
        }

        /**
         * Return method defining the object of the relationship for the given entity, if exists.
         */
        private <T> Optional<Method> getRelationshipObjectMethod(T entity) {
                return Arrays.stream(entity.getClass().getMethods()).filter(this::isRelationShipObject).findFirst();
        }

        /**
         * Return method defining the datasetid for the given entity, if exists.
         */
        private <T> Optional<Method> getDatasetIdMethod(T entity) {
                return Arrays.stream(entity.getClass().getMethods()).filter(this::isDatasetId).findFirst();
        }

        /**
         * Get all methods declared as attribute getters.
         */
        private <T> List<Method> getAttributeGettersMethods(T entity) {
                return Arrays.stream(entity.getClass().getMethods())
                                .filter(m -> getAttributeGetterAnnotation(m).isPresent())
                                .toList();
        }

        /**
         * return the {@link  AttributeGetter} annotation for the method if there is such.
         */
        private Optional<AttributeGetter> getAttributeGetterAnnotation(Method m) {
                return Arrays.stream(m.getAnnotations()).filter(AttributeGetter.class::isInstance).findFirst()
                                .map(AttributeGetter.class::cast);
        }

        /**
         * Find the attribute getter from all the annotations.
         */
        private static Optional<AttributeGetter> getAttributeGetter(Annotation[] annotations) {
                return Arrays.stream(annotations).filter(AttributeGetter.class::isInstance).map(AttributeGetter.class::cast)
                                .findFirst();
        }

        /**
         * Find the attribute setter from all the annotations.
         */
        private static Optional<AttributeSetter> getAttributeSetter(Annotation[] annotations) {
                return Arrays.stream(annotations).filter(AttributeSetter.class::isInstance).map(AttributeSetter.class::cast)
                                .findFirst();
        }

        /**
         * Check if the given method is declared to be used as object of a relationship
         */
        private boolean isRelationShipObject(Method m) {
                return Arrays.stream(m.getAnnotations()).anyMatch(RelationshipObject.class::isInstance);
        }

        /**
         * Check if the given method is declared to be used as datasetId
         */
        private boolean isDatasetId(Method m) {
                return Arrays.stream(m.getAnnotations()).anyMatch(DatasetId.class::isInstance);
        }

        /**
         * Build a property entry from the given method on the entity
         */
        private <T> Optional<Map.Entry<String, PropertyVO>> methodToPropertyEntry(T entity, Method method) {
                try {
                        Object propertyObject = method.invoke(entity);
                        if (propertyObject == null) {
                                return Optional.empty();
                        }
                        AttributeGetter attributeMapping = getAttributeGetter(method.getAnnotations()).orElseThrow(
                                        () -> new MappingException(String.format(NO_MAPPING_DEFINED_FOR_METHOD_TEMPLATE, method)));

                        PropertyVO propertyVO = new PropertyVO();
                        propertyVO.setValue(propertyObject);

                        return Optional.of(new AbstractMap.SimpleEntry<>(attributeMapping.targetName(), propertyVO));
                } catch (IllegalAccessException | InvocationTargetException e) {
                        throw new MappingException(String.format(WAS_NOT_ABLE_INVOKE_METHOD_TEMPLATE, method, entity));
                }
        }

        /**
         * Build a geo-property entry from the given method on the entity
         */
        private <T> Optional<Map.Entry<String, GeoPropertyVO>> methodToGeoPropertyEntry(T entity, Method method) {
                try {
                        Object o = method.invoke(entity);
                        if (o == null) {
                                return Optional.empty();
                        }
                        AttributeGetter attributeMapping = getAttributeGetter(method.getAnnotations()).orElseThrow(
                                        () -> new MappingException(String.format(NO_MAPPING_DEFINED_FOR_METHOD_TEMPLATE, method)));
                        GeoPropertyVO geoPropertyVO = new GeoPropertyVO();
                        geoPropertyVO.setValue(o);
                        return Optional.of(new AbstractMap.SimpleEntry<>(attributeMapping.targetName(), geoPropertyVO));
                } catch (IllegalAccessException | InvocationTargetException e) {
                        throw new MappingException(String.format(WAS_NOT_ABLE_INVOKE_METHOD_TEMPLATE, method, entity));
                }
        }

        /**
         * Build a relationship entry from the given method on the entity
         */
        private <T> Optional<Map.Entry<String, RelationshipVO>> methodToRelationshipEntry(T entity, Method method) {
                try {
                        Object relationShipObject = method.invoke(entity);
                        if (relationShipObject == null) {
                                return Optional.empty();
                        }
                        RelationshipVO relationshipVO = getRelationshipVO(method, relationShipObject);
                        AttributeGetter attributeMapping = getAttributeGetter(method.getAnnotations()).orElseThrow(
                                        () -> new MappingException(String.format(NO_MAPPING_DEFINED_FOR_METHOD_TEMPLATE, method)));
                        return Optional.of(new AbstractMap.SimpleEntry<>(attributeMapping.targetName(), relationshipVO));
                } catch (IllegalAccessException | InvocationTargetException e) {
                        throw new MappingException(String.format(WAS_NOT_ABLE_INVOKE_METHOD_TEMPLATE, method, entity));
                }
        }

        /**
         * Build a relationship list entry from the given method on the entity
         */
        private <T> Optional<Map.Entry<String, RelationshipListVO>> methodToRelationshipListEntry(T entity, Method method) {
                try {
                        Object o = method.invoke(entity);
                        if (o == null) {
                                return Optional.empty();
                        }
                        if (!(o instanceof List)) {
                                throw new MappingException(
                                                String.format("Relationship list method %s::%s did not return a List.", entity, method));
                        }
                        List<Object> entityObjects = (List) o;

                        AttributeGetter attributeGetter = getAttributeGetter(method.getAnnotations()).orElseThrow(
                                        () -> new MappingException(String.format(NO_MAPPING_DEFINED_FOR_METHOD_TEMPLATE, method)));
                        RelationshipListVO relationshipVOS = new RelationshipListVO();

                        relationshipVOS.addAll(entityObjects.stream()
                                        .filter(Objects::nonNull)
                                        .map(entityObject -> getRelationshipVO(method, entityObject))
                                        .toList());
                        return Optional.of(new AbstractMap.SimpleEntry<>(attributeGetter.targetName(), relationshipVOS));
                } catch (IllegalAccessException | InvocationTargetException e) {
                        throw new MappingException(String.format(WAS_NOT_ABLE_INVOKE_METHOD_TEMPLATE, method, entity));
                }
        }

        /**
         * Get the relationship for the given method and relationship object
         */
        private RelationshipVO getRelationshipVO(Method method, Object relationShipObject) {
                try {

                        Method objectMethod = getRelationshipObjectMethod(relationShipObject).orElseThrow(
                                        () -> new MappingException(
                                                        String.format("The relationship %s-%s does not provide an object method.",
                                                                        relationShipObject, method)));
                        Object objectObject = objectMethod.invoke(relationShipObject);
                        if (!(objectObject instanceof URI)) {
                                throw new MappingException(
                                                String.format("The object %s of the relationship is not a URI.", relationShipObject));
                        }

                        Method datasetIdMethod = getDatasetIdMethod(relationShipObject).orElseThrow(() -> new MappingException(
                                        String.format("The relationship %s-%s does not provide a datasetId method.", relationShipObject,
                                                        method)));
                        Object datasetIdObject = datasetIdMethod.invoke(relationShipObject);
                        if (!(datasetIdObject instanceof URI)) {
                                throw new MappingException(
                                                String.format("The datasetId %s of the relationship is not a URI.", relationShipObject));
                        }
                        RelationshipVO relationshipVO = new RelationshipVO();
                        relationshipVO.setObject((URI) objectObject);
                        relationshipVO.setDatasetId((URI) datasetIdObject);

                        // get additional properties. We do not support more depth/complexity for now
                        Map<String, AdditionalPropertyVO> additionalProperties = getAttributeGettersMethods(
                                        relationShipObject).stream()
                                        .map(getterMethod -> getAdditionalPropertyEntryFromMethod(relationShipObject, getterMethod))
                                        .filter(Optional::isPresent)
                                        .map(Optional::get)
                                        .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));

                        additionalProperties.forEach(relationshipVO::setAdditionalProperties);

                        return relationshipVO;
                } catch (IllegalAccessException | InvocationTargetException e) {
                        throw new MappingException(
                                        String.format(WAS_NOT_ABLE_INVOKE_METHOD_TEMPLATE, method, relationShipObject));
                }
        }

        /**
         * Get all additional properties for the object of the relationship
         */
        private Optional<Map.Entry<String, PropertyVO>> getAdditionalPropertyEntryFromMethod(Object relationShipObject,
                                                                                                                                                                                 Method getterMethod) {
                Optional<AttributeGetter> optionalAttributeGetter = getAttributeGetter(getterMethod.getAnnotations());
                if (optionalAttributeGetter.isEmpty() || !optionalAttributeGetter.get().embedProperty()) {
                        return Optional.empty();
                }
                if (optionalAttributeGetter.get().value().equals(AttributeType.PROPERTY)) {
                        return methodToPropertyEntry(relationShipObject, getterMethod);
                } else {
                        return Optional.empty();
                }
        }

        /**
         * Build a property list entry from the given method on the entity
         */
        private <T> Optional<Map.Entry<String, PropertyListVO>> methodToPropertyListEntry(T entity, Method method) {
                try {
                        Object o = method.invoke(entity);
                        if (o == null) {
                                return Optional.empty();
                        }
                        if (!(o instanceof List)) {
                                throw new MappingException(
                                                String.format("Property list method %s::%s did not return a List.", entity, method));
                        }
                        AttributeGetter attributeMapping = getAttributeGetter(method.getAnnotations()).orElseThrow(
                                        () -> new MappingException(String.format(NO_MAPPING_DEFINED_FOR_METHOD_TEMPLATE, method)));
                        List<Object> entityObjects = (List) o;

                        PropertyListVO propertyVOS = new PropertyListVO();

                        propertyVOS.addAll(entityObjects.stream()
                                        .map(propertyObject -> {
                                                PropertyVO propertyVO = new PropertyVO();
                                                propertyVO.setValue(propertyObject);
                                                return propertyVO;
                                        })
                                        .toList());

                        return Optional.of(new AbstractMap.SimpleEntry<>(attributeMapping.targetName(), propertyVOS));
                } catch (IllegalAccessException | InvocationTargetException e) {
                        throw new MappingException(String.format(WAS_NOT_ABLE_INVOKE_METHOD_TEMPLATE, method, entity));
                }
        }

}



wistefan / ngsi-ld-java-mapping / #259

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous