Skip to content
Snippets Groups Projects
Unverified Commit fc4e3bb6 authored by Martin Weise's avatar Martin Weise
Browse files

Created doxygen

parent 8c6771f1
No related branches found
No related tags found
3 merge requests!81New stable release,!43Merge dev to master,!36Resolve "Test AMQP"
Show whitespace changes
Inline Side-by-side
Showing
with 113 additions and 14 deletions
docker-compose.yml
+ 10
− 0
View file @ fc4e3bb6
......@@ -99,6 +99,8 @@ services:
depends_on:
fda-discovery-service:
condition: service_healthy
fda-authentication-service:
condition: service_healthy
fda-broker-service:
condition: service_healthy
fda-metadata-db:
......@@ -127,6 +129,8 @@ services:
depends_on:
fda-discovery-service:
condition: service_healthy
fda-authentication-service:
condition: service_healthy
fda-metadata-db:
condition: service_healthy
logging:
......@@ -178,6 +182,8 @@ services:
condition: service_healthy
fda-container-service:
condition: service_healthy
fda-authentication-service:
condition: service_healthy
fda-table-service:
condition: service_healthy
fda-metadata-db:
......@@ -209,6 +215,8 @@ services:
condition: service_healthy
fda-discovery-service:
condition: service_healthy
fda-authentication-service:
condition: service_healthy
fda-broker-service:
condition: service_healthy
fda-database-service:
......@@ -235,6 +243,8 @@ services:
depends_on:
fda-metadata-db:
condition: service_healthy
fda-authentication-service:
condition: service_healthy
fda-discovery-service:
condition: service_healthy
fda-query-service:
......
fda-query-service/.gitignore
+ 6
− 0
View file @ fc4e3bb6
......@@ -4,6 +4,12 @@ target/
!**/src/main/**/target/
!**/src/test/**/target/
# Documentation
docs/*.html
docs/css/
docs/images/
# Docker
ready
### STS ###
......
fda-query-service/Dockerfile
+ 1
− 0
View file @ fc4e3bb6
......@@ -15,6 +15,7 @@ COPY ./rest-service ./rest-service
COPY ./services ./services
COPY ./report ./report
COPY ./api ./api
COPY ./docs ./docs
# Make sure it compiles
RUN mvn -q clean package -DskipTests > /dev/null
......
fda-query-service/api/pom.xml
+ 0
− 2
View file @ fc4e3bb6
......@@ -16,6 +16,4 @@
<jacoco.version>0.8.7</jacoco.version>
</properties>
<dependencies />
</project>
\ No newline at end of file
fda-query-service/docs/pom.xml 0 → 100644
+ 39
− 0
View file @ fc4e3bb6
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<artifactId>fda-query-service</artifactId>
<groupId>at.tuwien</groupId>
<version>0.0.1-SNAPSHOT</version>
</parent>
<artifactId>docs</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>fda-query-service-docs</name>
<properties>
<jacoco.version>0.8.7</jacoco.version>
</properties>
<build>
<plugins>
<plugin>
<groupId>com.soebes.maven.plugins</groupId>
<artifactId>doxygen-maven-plugin</artifactId>
<version>1.1.0</version>
<executions>
<execution>
<id>docs</id>
<phase>verify</phase>
<goals>
<goal>report</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
\ No newline at end of file
fda-query-service/pom.xml
+ 44
− 1
View file @ fc4e3bb6
......@@ -12,7 +12,24 @@
<artifactId>fda-query-service</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>fda-query-service</name>
<description>Demo project for Spring Boot</description>
<description>
The query service provides an interface to insert data into the tables created by the table service. It
also allows for view-only (possibly paginated and versioned) query execution to the raw data and consumes
messages in the message queue from the Broker Service.
</description>
<url>https://dbrepo.ossdip.at</url>
<developers>
<developer>
<name>Martin Weise</name>
<email>martin.weise@tuwien.ac.at</email>
<organization>TU Wien</organization>
</developer>
<developer>
<name>Moritz Staudinger</name>
<email>moritz.staudinger@tuwien.ac.at</email>
<organization>TU Wien</organization>
</developer>
</developers>
<packaging>pom</packaging>
<modules>
......@@ -20,6 +37,7 @@
<module>services</module>
<module>report</module>
<module>api</module>
<module>docs</module>
</modules>
<properties>
......@@ -33,6 +51,7 @@
<jacoco.version>0.8.7</jacoco.version>
<opencsv.version>5.4</opencsv.version>
<hibernate-c3po.version>5.6.3.Final</hibernate-c3po.version>
<maven-report.version>3.0.0</maven-report.version>
</properties>
<dependencies>
......@@ -248,6 +267,30 @@
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<version>3.7.1</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-project-info-reports-plugin</artifactId>
<version>3.0.0</version>
<!-- <configuration>-->
<!-- <outputDirectory>docs</outputDirectory>-->
<!-- </configuration>-->
</plugin>
<plugin>
<groupId>com.soebes.maven.plugins</groupId>
<artifactId>doxygen-maven-plugin</artifactId>
<version>1.1.0</version>
<configuration>
<haveDot>false</haveDot>
<quiet>false</quiet>
<projectName>This is a Test Project (basicReportTest)</projectName>
<outputDirectory>docs</outputDirectory>
</configuration>
</plugin>
</plugins>
</build>
......
fda-query-service/services/pom.xml
+ 2
− 1
View file @ fc4e3bb6
......@@ -10,13 +10,14 @@
</parent>
<artifactId>services</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>fda-query-service-services</name>
<dependencies>
<dependency>
<groupId>at.tuwien</groupId>
<artifactId>api</artifactId>
<version>0.0.1-SNAPSHOT</version>
<scope>compile</scope>
</dependency>
</dependencies>
......
fda-query-service/services/src/main/java/at/tuwien/service/CommaValueService.java
+ 11
− 10
View file @ fc4e3bb6
......@@ -2,7 +2,6 @@ package at.tuwien.service;
import at.tuwien.api.database.table.TableCsvDto;
import at.tuwien.exception.*;
import org.springframework.core.io.InputStreamResource;
public interface CommaValueService {
......@@ -17,6 +16,7 @@ public interface CommaValueService {
* @throws TableNotFoundException Table with id not found.
* @throws DatabaseNotFoundException Database with id not found.
* @throws FileStorageException File could not be processed.
* @throws ContainerNotFoundException The container with id is not found.
*/
TableCsvDto read(Long containerId, Long databaseId, Long tableId, String location) throws TableNotFoundException,
DatabaseNotFoundException, FileStorageException, ContainerNotFoundException;
......@@ -30,13 +30,14 @@ public interface CommaValueService {
* @param location The location.
* @param separator Data separator.
* @param skipLines Skip first n lines.
* @param nullElement The element representing {@link null}.
* @param falseElement The element representing {@link false}.
* @param trueElement The element representing {@link true}.
* @param nullElement The element representing null.
* @param falseElement The element representing false.
* @param trueElement The element representing true.
* @return The data from the location.
* @throws TableNotFoundException Table with id not found.
* @throws DatabaseNotFoundException Database with id not found.
* @throws FileStorageException File could not be processed.
* @throws ContainerNotFoundException The container with id not found.
*/
TableCsvDto read(Long containerId, Long databaseId, Long tableId, String location, Character separator, Long skipLines, String nullElement,
String falseElement, String trueElement) throws TableNotFoundException, DatabaseNotFoundException, FileStorageException, ContainerNotFoundException;
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment