Data MicroProfile example.

Signed-off-by: Tomáš Kraus <[email protected]>

Author: Tomáš Kraus

etc/checkstyle-suppressions.xml

@@ -45,4 +45,8 @@
               files="examples/openapi-tools/"/>
     <suppress checks="MethodName"
               files="examples/data/"/>
+    <suppress checks="MethodName"
+              files="examples/declarative/data/"/>
+    <suppress checks="MethodName"
+              files="examples/microprofile/data/"/>
 </suppressions>

examples/data/mysql/src/main/java/io/helidon/examples/data/mysql/package-info.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 /**
- * This package contains the main application classes for demonstrating the usage of Helidon Data
+ * This package contains an application classes for demonstrating the usage of Helidon Data
  * with a MySQL database.
  * <p>
  * The application provides REST services for managing pokémon data.

examples/data/oracle/src/main/java/io/helidon/examples/data/oracle/package-info.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 /**
- * This package contains the main application classes for demonstrating the usage of Helidon Data
+ * This package contains an application classes for demonstrating the usage of Helidon Data
  * with an Oracle database.
  * <p>
  * The application provides REST services for managing pokémon data.

examples/declarative/data/README.md

@@ -4,8 +4,6 @@ Helidon Data SE Declarative Example
 This example demonstrates a Java SE declarative application that utilizes Helidon Data, WebServer,
 and a MySQL database.
 
-There are 3 repository interfaces in the example:
-
 There are 2 repository interfaces in the example:
 
 - `PokemonRepository`
@@ -32,8 +30,8 @@ docker run --name mysql \
 ### Database Schema and Content
 
 The application's Jakarta Persistence API implementation automatically creates the database schema
-using the `resources/init.sql` script. The schema consists of three main entities: `Pet`, `Owner`
-and `Breed`. The initialization script populates the database with a basic set of records.
+using the `resources/init.sql` script. The schema consists of two main entities: `Pokemon` and `Type`.
+The initialization script populates the database with a basic set of records.
 
 ## Build and Run
 

examples/declarative/data/src/main/java/io/helidon/examples/declarative/data/package-info.java

@@ -15,14 +15,15 @@
  */
 
 /**
- * This package contains the main application classes for demonstrating the usage of Helidon Data
+ * This package contains an application classes for demonstrating the usage of Helidon Data
  * in a Java SE declarative application.
  * <p>
- * The application provides REST services for managing pet, owner, and breed data.
+ * The application provides REST services for managing pokémon data.
  * <p>
  * The main entry point for the application is the {@link io.helidon.examples.declarative.data.Main} class.
  *
- * @see io.helidon.examples.declarative.data.Main
- * @see io.helidon.examples.declarative.data.service
+ * @see io.helidon.examples.declarative.data.PokemonService
+ * @see io.helidon.examples.declarative.data.PokemonRepository
+ * @see io.helidon.examples.declarative.data.TypeRepository
  */
 package io.helidon.examples.declarative.data;

examples/microprofile/data/README.md

@@ -1,20 +1,13 @@
 Helidon Data MP Example
 ----
 
-This example demonstrates a Java MP application that utilizes Helidon Data, WebServer, Hikari
+This example demonstrates a Java MicroProfile application that utilizes Helidon Data, WebServer, Hikari
 connection pool DataSource and MySQL database.
 
-There are 3 repository interfaces in the example:
+There are 2 repository interfaces in the example:
 
-- `OwnerRepository`
-- `BreedRepository`
-- `PetRepository`
-
-All methods in `OwnerRepository` are defined as methods with queries defined by the @Data.Query
-annotation. There is no specific limitation on the names of those methods.
-
-All methods in `BreedRepository` and `PetRepository` are defined as methods with queries defined
-by the method name. Method names must follow the _Query by Method Name_ grammar.
+- `PokemonRepository`
+- `TypeRepository`
 
 > **NOTE:** Database tables are initialized with ID auto increment to supply primary key values
 >           by the database. MySQL database default String comparisons are case-insensitive.
@@ -27,7 +20,7 @@ configuration using the following Docker command:
 ```shell
 docker run --name mysql \
        -p 3306:3306 \
-       -e MYSQL_DATABASE='pets' \
+       -e MYSQL_DATABASE='pokemons' \
        -e MYSQL_RANDOM_ROOT_PASSWORD='yes' \
        -e MYSQL_USER='user' \
        -e MYSQL_PASSWORD='changeit' \
@@ -36,10 +29,9 @@ docker run --name mysql \
 
 ### Database Schema and Content
 
-The application's Jakarta Persistence API implementation automatically drops and creates the database
-schema using the `resources/drop.sql` and `resources/init.sql` scripts. The schema consists of three
-main entities: `Pet`, `Owner` and `Breed`. The initialization script populates the database with a basic
-set of records.
+The application's Jakarta Persistence API implementation automatically creates the database schema
+using the `resources/init.sql` script. The schema consists of two main entities: `Pokemon` and `Type`.
+The initialization script populates the database with a basic set of records.
 
 ## Build and Run
 
@@ -59,97 +51,29 @@ java -jar target/helidon-examples-microprofile-data.jar
 
 ## Test Example
 
-The application provides the following endpoints:
-- http://localhost:8080/pet - Pet entity endpoint
-- http://localhost:8080/owner - Owner entity endpoint
-- http://localhost:8080/breed - Breed entity endpoint
-
-### Pet Endpoint
-
-**Retrieve Pet entity endpoint information:**
-```shell
-curl http://localhost:8080/pet
-```
-
-**List all pets:**
-```shell
-curl http://localhost:8080/pet/all
-```
-
-**List all pets as pages:**
-```shell
-curl http://localhost:8080/pet/all/0
-curl http://localhost:8080/pet/all/1
-curl http://localhost:8080/pet/all/2
-```
-
-The last page will be empty with the initial set of `Pet` records. Additional records would fill it.
-
-**List all dogs:**
-```shell
-curl http://localhost:8080/pet/breed/Dog
-```
+The application provides `http://localhost:8080/pokemon` endpoint.
 
-**Retrieve a Pet by name (`Max`):**
+**List all pokémons:**
 ```shell
-curl http://localhost:8080/pet/get/Max
+curl http://localhost:8080/pokemon/all
 ```
 
-**Insert new pet:**
-```shell
-curl -i -X POST -H 'Content-type: application/json' -d '{"name":"Ken","weight":3.5,"birth":"2023-05-10","owner":"Betty","breed":"Dog"}' http://localhost:8080/pet
-```
-
-**Delete existing pet by ID (`20`):**
-```shell
-curl -i -X DELETE http://localhost:8080/pet/20
-```
-
-### Owner Endpoint
-
-**Retrieve Owner entity endpoint information:**
-```shell
-curl http://localhost:8080/owner
-```
-
-**List all owners:**
-```shell
-curl http://localhost:8080/owner/all
-```
-
-**List all names of owners who own a cat:**
-```shell
-curl http://localhost:8080/owner/names/Cat
-```
-
-**Insert new owner:**
-```shell
-curl -i -X POST http://localhost:8080/owner/Alice
-```
-
-**Delete existing owner by ID (`10`):**
-```shell
-curl -i -X DELETE http://localhost:8080/owner/10
-```
-
-### Breed Endpoint
-
-**Retrieve Breed entity endpoint information:**
+**List all normal type pokémons:**
 ```shell
-curl http://localhost:8080/breed
+curl http://localhost:8080/pokemon/type/Normal
 ```
 
-**List all breeds:**
+**Retrieve a pokémon by name (`Meowth`):**
 ```shell
-curl http://localhost:8080/breed/all
+curl http://localhost:8080/pokemon/get/Meowth
 ```
 
-**Insert new breed:**
+**Insert new pokémon:**
 ```shell
-curl -i -X POST http://localhost:8080/breed/Hamster
+curl -i -X POST -H 'Content-type: application/json' -d '{"name":"Charmander","type":"Fire"}' http://localhost:8080/pokemon
 ```
 
-**Delete existing breed by ID (`10`):**
+**Delete existing pokémon by ID (`20`):**
 ```shell
-curl -i -X DELETE http://localhost:8080/breed/10
+curl -i -X DELETE http://localhost:8080/pokemon/20
 ```

examples/microprofile/data/pom.xml

@@ -67,7 +67,6 @@
             <artifactId>helidon-logging-jul</artifactId>
             <scope>runtime</scope>
         </dependency>
-        <!-- TODO: Replace with helidon support -->
         <dependency>
             <groupId>org.hibernate.orm</groupId>
             <artifactId>hibernate-core</artifactId>

examples/microprofile/data/src/main/java/io/helidon/examples/microprofile/data/Pokemon.java

@@ -0,0 +1,118 @@
+/*
+ * Copyright (c) 2025 Oracle and/or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://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.
+ */
+package io.helidon.examples.microprofile.data;
+
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.GeneratedValue;
+import jakarta.persistence.GenerationType;
+import jakarta.persistence.Id;
+import jakarta.persistence.JoinColumn;
+import jakarta.persistence.ManyToOne;
+import jakarta.persistence.Table;
+
+/**
+ * Represents a pokémon entity with its associated properties.
+ * This class is annotated with JPA annotations to map its properties to a database table.
+ */
+@Entity
+@Table(name = "POKEMON")
+public class Pokemon {
+
+    @Id
+    @Column(name = "ID")
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    private Integer id;
+    @Column(name = "NAME", unique = true, nullable = false)
+    private String name;
+    @ManyToOne
+    @JoinColumn(name = "TYPE_ID", nullable = false)
+    private Type type;
+
+    /**
+     * Constructs a new {@link Pokemon} instance with the specified values.
+     *
+     * @param name the name of the pokémon
+     * @param type the type of the pokémon
+     */
+    public Pokemon(String name, Type type) {
+        this.id = null;
+        this.name = name;
+        this.type = type;
+    }
+
+    /**
+     * Constructs a new default {@link Pokemon} instance with default values.
+     */
+    public Pokemon() {
+        this(null, null);
+    }
+
+    /**
+     * Returns the unique identifier of the pokémon.
+     *
+     * @return the id of the pokémon
+     */
+    public Integer getId() {
+        return id;
+    }
+
+    /**
+     * Sets the unique identifier of the pokémon.
+     *
+     * @param id the new id of the pokémon
+     */
+    public void setId(Integer id) {
+        this.id = id;
+    }
+
+    /**
+     * Returns the name of the pokémon.
+     *
+     * @return the name of the pokémon
+     */
+    public String getName() {
+        return name;
+    }
+
+    /**
+     * Sets the name of the pokémon.
+     *
+     * @param name the new name of the pokémon
+     */
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    /**
+     * Returns the type of the pokémon.
+     *
+     * @return the type of the pokémon
+     */
+    public Type getType() {
+        return type;
+    }
+
+    /**
+     * Sets the type of the pokémon.
+     *
+     * @param type the new type of the pokémon
+     */
+    public void setType(Type type) {
+        this.type = type;
+    }
+
+}