Revize b539ef29

Added path
- searching and highlighting text
- returning list of found catalog items

re #9490

backend/docker-compose.yml

@@ -28 +28 @@
       - SPRING_DATASOURCE_URL=jdbc:postgresql://db:5432/test # overwrites application.properties datasource url to connect to the database
 
   frontend:
-    # Since our Dockerfile for web-server is located in react-app foler, our build context is ./react-app
+#     Since our Dockerfile for web-server is located in react-app folder, our build context is ./react-app
     build: ../frontend
     container_name: frontend
     image: schwobik/frontend-app:1.2

backend/pom.xml

@@ -23 +23 @@
         </dependency>
 
         <dependency>
-            <groupId>org.projectlombok</groupId>
-            <artifactId>lombok</artifactId>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-configuration-processor</artifactId>
             <optional>true</optional>
         </dependency>
+
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-test</artifactId>
             <scope>test</scope>
         </dependency>
 
-        <dependency>
-            <groupId>com.h2database</groupId>
-            <artifactId>h2</artifactId>
-            <scope>test</scope>
-        </dependency>
-
-        <dependency>
-            <groupId>org.postgresql</groupId>
-            <artifactId>postgresql</artifactId>
-            <scope>runtime</scope>
-        </dependency>
-
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-data-jpa</artifactId>
@@ -64 +53 @@
             <groupId>org.springframework.security</groupId>
             <artifactId>spring-security-test</artifactId>
             <scope>test</scope>
+            <version>5.6.2</version>
+        </dependency>
+
+        <dependency>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
+            <optional>true</optional>
+            <version>1.18.22</version>
+        </dependency>
+
+        <dependency>
+            <groupId>com.h2database</groupId>
+            <artifactId>h2</artifactId>
+            <scope>test</scope>
+            <version>2.1.210</version>
+        </dependency>
+
+        <dependency>
+            <groupId>org.postgresql</groupId>
+            <artifactId>postgresql</artifactId>
+            <scope>runtime</scope>
+            <version>42.3.3</version>
         </dependency>
 
         <dependency>
@@ -75 +86 @@
         <dependency>
             <groupId>com.auth0</groupId>
             <artifactId>java-jwt</artifactId>
-            <version>3.19.0</version>
+            <version>3.19.1</version>
         </dependency>
 
         <dependency>
@@ -84 +95 @@
             <version>31.1-jre</version>
         </dependency>
 
-        <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-configuration-processor</artifactId>
-            <version>2.6.5</version>
-            <optional>true</optional>
-        </dependency>
-
         <dependency>
             <groupId>org.springdoc</groupId>
             <artifactId>springdoc-openapi-ui</artifactId>
-            <version>1.6.6</version>
+            <version>1.6.7</version>
         </dependency>
     </dependencies>
 

backend/src/main/java/cz/zcu/kiv/backendapi/alternativename/AlternativeNameServiceImpl.java

@@ -1 @@
-package cz.zcu.kiv.backendapi.alternativename;
-
-import lombok.RequiredArgsConstructor;
-import org.springframework.stereotype.Service;
-import org.springframework.transaction.annotation.Transactional;
-
-/**
- * Alternative name service implementation
- */
-@Service
-@Transactional
-@RequiredArgsConstructor
-public class AlternativeNameServiceImpl implements IAlternativeNameService {
-
-    /**
-     * Alternative name repository
-     */
-    private final AlternativeNameRepository alternativeNameRepository;
-}

backend/src/main/java/cz/zcu/kiv/backendapi/alternativename/IAlternativeNameService.java

@@ -1 @@
-package cz.zcu.kiv.backendapi.alternativename;
-
-/**
- * Alternative name service interface
- */
-public interface IAlternativeNameService {
-}

backend/src/main/java/cz/zcu/kiv/backendapi/bibliography/BibliographyServiceImpl.java

@@ -1 @@
-package cz.zcu.kiv.backendapi.bibliography;
-
-import lombok.RequiredArgsConstructor;
-import org.springframework.stereotype.Service;
-import org.springframework.transaction.annotation.Transactional;
-
-/**
- * Bibliography service implementation
- */
-@Service
-@Transactional
-@RequiredArgsConstructor
-public class BibliographyServiceImpl implements IBibliographyService {
-    /**
-     * Bibliography repository
-     */
-    private final BibliographyRepository bibliographyRepository;
-}

backend/src/main/java/cz/zcu/kiv/backendapi/bibliography/IBibliographyService.java

@@ -1 @@
-package cz.zcu.kiv.backendapi.bibliography;
-
-/**
- * Bibliography service interface
- */
-public interface IBibliographyService {
-}

backend/src/main/java/cz/zcu/kiv/backendapi/catalog/CatalogController.java

@@ -76 +76 @@
      * @param id ID
      * @return catalog item with given ID
      */
-    @RequestMapping(value = "/{id}", method = RequestMethod.GET, produces = "application/json")
+    @GetMapping(value = "/{id}")
     @Operation(summary = "returns catalog item with given ID")
     public CatalogItemDto getCatalogItem(@PathVariable UUID id) {
         return catalogService.getCatalogItem(id);

backend/src/main/java/cz/zcu/kiv/backendapi/catalog/CatalogItemDto.java

@@ -28 +28 @@
     private String name;
 
     /**
-     * Certainty
+     * Alternative names
      */
-    private int certainty;
+    private Set<String> alternativeNames = Collections.emptySet();
 
     /**
-     * Longitude
+     * Written forms
      */
-    private double longitude;
+    private Set<String> writtenForms = Collections.emptySet();
 
     /**
-     * Latitude
+     * Types
      */
-    private double latitude;
+    private Set<String> types = Collections.emptySet();
 
     /**
-     * Bibliography
+     * Countries
      */
-    private Set<String> bibliography = Collections.emptySet();
+    private Set<String> countries = Collections.emptySet();
 
     /**
-     * Countries
+     * Bibliography
      */
-    private Set<String> countries = Collections.emptySet();
+    private Set<String> bibliography = Collections.emptySet();
 
     /**
-     * Written forms
+     * Longitude
      */
-    private Set<String> writtenForms = Collections.emptySet();
+    private double longitude;
 
     /**
-     * Alternative names
+     * Latitude
      */
-    private Set<String> alternativeNames = Collections.emptySet();
+    private double latitude;
 
     /**
-     * Types
+     * Certainty
      */
-    private Set<String> types = Collections.emptySet();
+    private int certainty;
 
 }

backend/src/main/java/cz/zcu/kiv/backendapi/catalog/CatalogItemRepository.java

@@ -4 +4 @@
 import org.springframework.data.jpa.repository.Query;
 import org.springframework.stereotype.Repository;
 
+import java.util.List;
 import java.util.Set;
 import java.util.UUID;
 
@@ -29 +30 @@
             "AND (?2 = '' OR UPPER(c.name) LIKE UPPER(?2)) " +
             "AND (?3 = '' OR UPPER(t.type) LIKE UPPER(?3))")
     Set<CatalogItem> filterCatalog(String name, String country, String type);
+
+    /**
+     * Selects catalog items with given name (alternative name)
+     *
+     * @param name name
+     * @return list of catalog items with given name
+     */
+    @Query("SELECT DISTINCT a.catalogItem FROM AlternativeName a WHERE ?1 = a.name")
+    List<CatalogItem> getItemsByName(String name);
 }

backend/src/main/java/cz/zcu/kiv/backendapi/catalog/CatalogItemServiceImpl.java

@@ -4 +4 @@
 import cz.zcu.kiv.backendapi.bibliography.Bibliography;
 import cz.zcu.kiv.backendapi.country.Country;
 import cz.zcu.kiv.backendapi.exception.ApiRequestException;
+import cz.zcu.kiv.backendapi.path.PathDto;
 import cz.zcu.kiv.backendapi.type.ITypeService;
 import cz.zcu.kiv.backendapi.type.Type;
 import cz.zcu.kiv.backendapi.writtenform.WrittenForm;
@@ -13 +14 @@
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
 
+import java.util.ArrayList;
 import java.util.List;
 import java.util.Set;
 import java.util.UUID;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 import java.util.stream.Collectors;
 
 /**
@@ -41 +45 @@
      */
     private static final String WILDCARD_CHARACTERS_REGEX = "\\*";
 
+    /**
+     * Regex for finding punctuation at the start of word
+     */
+    private static final String START_PUNCTUATION_REGEX = "^[\\p{Punct}\\p{IsPunctuation}]+";
+
+    /**
+     * Regex for finding punctuation at the end of word
+     */
+    private static final String END_PUNCTUATION_REGEX = "[\\p{Punct}\\p{IsPunctuation}]+$";
+
+    /**
+     * Pattern for finding punctuation at the start of word
+     */
+    private static final Pattern START_PUNCTUATION_PATTERN = Pattern.compile(START_PUNCTUATION_REGEX);
+
+    /**
+     * Pattern for finding punctuation at the end of word
+     */
+    private static final Pattern END_PUNCTUATION_PATTERN = Pattern.compile(END_PUNCTUATION_REGEX);
+
     /**
      * Regex for any number of arbitrary characters in string used in SQL language
      */
@@ -51 +75 @@
      */
     private static final String CATALOG_ITEM_NOT_FOUND = "Catalog item not found";
 
+    /**
+     * Threshold for comparing doubles
+     */
+    private static final double DOUBLE_THRESHOLD = 0.001;
+
     /**
      * Catalog repository
      */
@@ -111 +140 @@
 
     @Override
     public CatalogItemDto getCatalogItem(UUID id) {
-        var catalogItem = catalogItemRepository.findById(id).orElseThrow(() -> {
+        CatalogItem catalogItem = catalogItemRepository.findById(id).orElseThrow(() -> {
             log.error(CATALOG_ITEM_NOT_FOUND);
             throw new ApiRequestException(CATALOG_ITEM_NOT_FOUND, HttpStatus.NOT_FOUND);
         });
@@ -119 +148 @@
         return convertEntityToDto(catalogItem);
     }
 
+    @Override
+    public PathDto getPath(String text) {
+        PathDto pathDto = new PathDto();
+        StringBuilder highlightedText = new StringBuilder();
+        List<List<CatalogItemDto>> foundCatalogItems = new ArrayList<>();
+
+        Set<String> types = typeService.getAllTypesAsString();
+
+        String[] tokens = text.split("\\s+");
+        for (String token : tokens) {
+            Matcher matcherStart = START_PUNCTUATION_PATTERN.matcher(token);
+            Matcher matcherEnd = END_PUNCTUATION_PATTERN.matcher(token);
+            String prefix = "";
+            String suffix = "";
+            String textToFind;
+            int startTextIndex = 0;
+            int endTextIndex = token.length();
+
+            if (matcherStart.find()) {
+                int start = matcherStart.start();
+                startTextIndex = matcherStart.end();
+                prefix = token.substring(start, startTextIndex);
+            }
+            if (matcherEnd.find()) {
+                endTextIndex = matcherEnd.start();
+                int end = matcherEnd.end();
+                suffix = token.substring(endTextIndex, end);
+            }
+
+            textToFind = token.substring(startTextIndex, endTextIndex);
+
+            if (types.contains(textToFind)) {
+                textToFind = "<b>" + textToFind + "</b>";
+            } else {
+                List<CatalogItem> foundItems = catalogItemRepository.getItemsByName(textToFind);
+                if (!foundItems.isEmpty()) {
+                    if (foundItems.stream().anyMatch(c -> Math.abs(c.getLatitude()) > DOUBLE_THRESHOLD && Math.abs(c.getLongitude()) > DOUBLE_THRESHOLD)) {
+                        textToFind = "<span style='color:green'>" + textToFind + "</span>";
+                    } else {
+                        textToFind = "<span style='color:red'>" + textToFind + "</span>";
+                    }
+                    foundCatalogItems.add(foundItems.stream().map(this::convertEntityToDto).collect(Collectors.toList()));
+                }
+            }
+            highlightedText.append(prefix).append(textToFind).append(suffix).append(" ");
+        }
+        highlightedText.setLength(highlightedText.length() - 1);
+
+        pathDto.setText(highlightedText.toString());
+        pathDto.setFoundCatalogItems(foundCatalogItems);
+        return pathDto;
+    }
+
     /**
      * Saves catalog entity to database
      *

backend/src/main/java/cz/zcu/kiv/backendapi/catalog/ICatalogItemService.java

@@ -1 +1 @@
 package cz.zcu.kiv.backendapi.catalog;
 
+import cz.zcu.kiv.backendapi.path.PathDto;
+
 import java.util.List;
 import java.util.UUID;
 
@@ -54 +56 @@
      */
     CatalogItemDto getCatalogItem(UUID id);
 
+    /**
+     * Returns highlighted searched text and searched items
+     *
+     * @param text text
+     * @return highlighted searched text and searched items
+     */
+    PathDto getPath(String text);
+
 }

backend/src/main/java/cz/zcu/kiv/backendapi/config/DataInitiator.java

@@ -21 +21 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.io.InputStream;
 import java.nio.charset.Charset;
 import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
@@ -65 +66 @@
 
     private List<CatalogItem> loadCatalog() {
         List<CatalogItem> catalogEntities = new ArrayList<>();
-        var csvData = getClass().getClassLoader().getResourceAsStream("AssyrianProject-AllNoDupl-22-03-28.csv");
+        InputStream csvData = getClass().getClassLoader().getResourceAsStream("AssyrianProject-AllNoDupl-22-03-28.csv");
 //        File csvData = new File("AssyrianProject-AllNoDupl-22-03-28.csv");
         CSVParser parser;
         try {

backend/src/main/java/cz/zcu/kiv/backendapi/country/CountryServiceImpl.java

@@ -1 @@
-package cz.zcu.kiv.backendapi.country;
-
-import lombok.RequiredArgsConstructor;
-import org.springframework.stereotype.Service;
-import org.springframework.transaction.annotation.Transactional;
-
-/**
- * Country service implementation
- */
-@Service
-@Transactional
-@RequiredArgsConstructor
-public class CountryServiceImpl implements ICountryService {
-
-    /**
-     * Country repository
-     */
-    private final CountryRepository countryRepository;
-}

backend/src/main/java/cz/zcu/kiv/backendapi/country/ICountryService.java

@@ -1 @@
-package cz.zcu.kiv.backendapi.country;
-
-/**
- * Country service interface
- */
-public interface ICountryService {
-}

backend/src/main/java/cz/zcu/kiv/backendapi/path/PathController.java

@@ +1 @@
+package cz.zcu.kiv.backendapi.path;
+
+import cz.zcu.kiv.backendapi.catalog.ICatalogItemService;
+import lombok.RequiredArgsConstructor;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+/**
+ * Controller for paths
+ */
+@RestController
+@RequiredArgsConstructor
+@RequestMapping("/path")
+public class PathController {
+
+    /**
+     * Catalog item service
+     */
+    private final ICatalogItemService catalogItemService;
+
+    /**
+     * Returns path with highlighted text and found catalog items
+     *
+     * @param pathDto catalog DTO with text to be searched
+     * @return path DTO with highlighted text and found catalog items
+     */
+    @GetMapping("")
+    public PathDto getPath(@RequestBody PathDto pathDto) {
+        return catalogItemService.getPath(pathDto.getText());
+    }
+}

backend/src/main/java/cz/zcu/kiv/backendapi/path/PathDto.java

@@ +1 @@
+package cz.zcu.kiv.backendapi.path;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import cz.zcu.kiv.backendapi.catalog.CatalogItemDto;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.util.List;
+
+/**
+ * Class representing DTO for path
+ */
+@Data
+@AllArgsConstructor
+@NoArgsConstructor
+public class PathDto {
+    /**
+     * Text to be searched / highlighted text
+     */
+    private String text;
+
+    /**
+     * List of lists of found catalog items
+     */
+    @JsonProperty(access = JsonProperty.Access.READ_ONLY)
+    private List<List<CatalogItemDto>> foundCatalogItems;
+}

backend/src/main/java/cz/zcu/kiv/backendapi/type/ITypeService.java

@@ -1 +1 @@
 package cz.zcu.kiv.backendapi.type;
 
 import java.util.Optional;
+import java.util.Set;
 
 /**
  * Type service interface
@@ -21 +22 @@
      * @return type by name (optional)
      */
     Optional<Type> getTypeByName(String type);
+
+    /**
+     * Returns set of all types as string
+     *
+     * @return set of all types as string
+     */
+    Set<String> getAllTypesAsString();
 }

backend/src/main/java/cz/zcu/kiv/backendapi/type/TypeServiceImpl.java

@@ -5 +5 @@
 import org.springframework.transaction.annotation.Transactional;
 
 import java.util.Optional;
+import java.util.Set;
+import java.util.stream.Collectors;
 
 /**
  * Type service implementation
@@ -28 +30 @@
         return typeRepository.findById(type);
     }
 
+    @Override
+    public Set<String> getAllTypesAsString() {
+        return typeRepository.findAll().stream().map(Type::getType).collect(Collectors.toSet());
+    }
+
 
 }

backend/src/main/java/cz/zcu/kiv/backendapi/writtenform/IWrittenFormService.java

@@ -1 @@
-package cz.zcu.kiv.backendapi.writtenform;
-
-/**
- * Written form service interface
- */
-public interface IWrittenFormService {
-}

backend/src/main/java/cz/zcu/kiv/backendapi/writtenform/WrittenFormServiceImpl.java

@@ -1 @@
-package cz.zcu.kiv.backendapi.writtenform;
-
-import lombok.RequiredArgsConstructor;
-import org.springframework.stereotype.Service;
-import org.springframework.transaction.annotation.Transactional;
-
-/**
- * Written form service implementation
- */
-@Service
-@Transactional
-@RequiredArgsConstructor
-public class WrittenFormServiceImpl implements IWrittenFormService {
-
-    /**
-     * Written form repository
-     */
-    private final WrittenFormRepository writtenFormRepository;
-}