Merge branch 'develop' into renovate/antora-cli-3.x

Author: JohannesRabauer

.github/workflows/antora-build.yml

@@ -35,7 +35,7 @@ jobs:
         run: npx antora docs/antora-playbook.yml
 
       - name: Setup Pages
-        uses: actions/configure-pages@v4
+        uses: actions/configure-pages@v5
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3

CHANGELOG.md

@@ -1,6 +1,8 @@
 # 1.0.4
 
 * Added possibility to use multiple storages
+* Added Lazy support
+* Updated EclipseStore to version 1.3.1
 
 # 1.0.3
 

docs/modules/ROOT/nav.adoc

@@ -2,5 +2,6 @@
 * xref:installation.adoc[Installation]
 * xref:configuration.adoc[Configuration]
 * xref:working-copies.adoc[Working Copies]
+* xref:lazies.adoc[Lazy References]
 * xref:migration.adoc[Migration]
 * xref:known-issues.adoc[Known issues]

docs/modules/ROOT/pages/known-issues.adoc

@@ -1,13 +1,5 @@
 = Known issues
 
-== Lazy references
-
-One of the core features of EclipseStore is its https://docs.eclipsestore.io/manual/storage/loading-data/lazy-loading/index.html[Lazy references].
-Unfortunately this requires our library to implement some kind of proxy.
-That's something that takes a lot of effort to implement in our {product-name}.
-
-We created https://github.com/xdev-software/spring-data-eclipse-store/issues/31[an issue] for that but right now we *do not support Lazy references*.
-
 == Query annotations
 
 In Spring-Data-JPA you can write a Query over methods of repositories like this:

docs/modules/ROOT/pages/lazies.adoc

@@ -0,0 +1,40 @@
+= Lazy References
+
+Lazy Loading is an essential part of EclipseStore.
+The basic mechanism is best explained in the https://docs.eclipsestore.io/manual/storage/loading-data/lazy-loading/index.html[EclipseStore-Docs]. +
+In essence java objects which are wrapped in a *Lazy-Reference are not loaded with the startup of the EclipseStore-Storage but only if ``get()`` is called* on them.
+
+Lazy References are essential for big data sets that can't get loaded into memory.
+Since {product-name} operates with xref:working-copies.adoc[working copies] using the EclipseStore-Lazy-References is not possible. +
+If you are using the EclipseStore-Lazy-References, all references would be resolved and loaded into memory as soon as a working copy is created, because the ``get()``-Method is called to create a full working copy.
+
+That's why we implemented ``SpringDataEclipseStoreLazy``. +
+The usage is the same as with the EclipseStore-Lazies, but they are handled very differently.
+
+Simply wrap any kind of java object in the SpringDataEclipseStoreLazy-Wrapper and the wrapped object has a lazy loading behaviour.
+
+CAUTION: Lazy-References are not only loaded when needed, but also https://docs.eclipsestore.io/manual/storage/loading-data/lazy-loading/clearing-lazy-references.html#automatically[*cleared when they are no longer needed*]!
+
+Example: ``SpringDataEclipseStoreLazy.build(new HashMap<String, Pet>())``
+
+[source,java,title="https://github.com/xdev-software/spring-data-eclipse-store/tree/develop/spring-data-eclipse-store-demo/src/main/java/software/xdev/spring/data/eclipse/store/demo/complex/owner/Owner.java[Example from complex demo]"]
+----
+package software.xdev.spring.data.eclipse.store.demo.complex.owner;
+//...
+import software.xdev.spring.data.eclipse.store.repository.lazy.SpringDataEclipseStoreLazy;
+
+public class Owner extends Person
+{
+	private String address;
+
+	private Lazy<List<Pet>> pets = SpringDataEclipseStoreLazy.build(new ArrayList<>());
+	//...
+----
+
+== Internas
+
+SpringDataEclipseStoreLazies work as a proxy for the EclipseStore-Lazies.
+As far as EclipseStore is concerned, a SpringDataEclipseStoreLazy-Object is a normal Java object that contains a Lazy-Reference.
+
+But when {product-name} creates the working copy, *the SpringDataEclipseStoreLazy-Reference is not resolved* but instead only a reference to the original Lazy-Object in EclipseStore is loaded.
+As soon as ``get()`` is called on the SpringDataEclipseStoreLazy, a *new working copy of the lazy object* is created.

docs/package.json

@@ -4,6 +4,6 @@
   },
   "devDependencies": {
     "@antora/cli": "3.1.7",
-    "@antora/site-generator": "3.1.4"
+    "@antora/site-generator": "3.1.7"
   }
 }

spring-data-eclipse-store-demo/src/main/java/software/xdev/spring/data/eclipse/store/demo/complex/ComplexDemoApplication.java

@@ -103,6 +103,17 @@ public void run(final String... args)
 					);
 				}
 			);
+		
+		LOG.info("----Owner-Lazy Pet loading----");
+		this.ownerRepository.findAll().forEach(
+			o -> o.getPets().forEach(
+				pet -> LOG.info(String.format(
+					"Pet %s has owner %s %s",
+					pet.getName(),
+					o.getFirstName(),
+					o.getLastName()))
+			)
+		);
 	}
 
 	private static Visit createVisit()

spring-data-eclipse-store-demo/src/main/java/software/xdev/spring/data/eclipse/store/demo/complex/owner/Owner.java

@@ -19,10 +19,12 @@
 import java.util.List;
 import java.util.Optional;
 
+import org.eclipse.serializer.reference.Lazy;
 import org.springframework.core.style.ToStringCreator;
 import org.springframework.util.Assert;
 
 import software.xdev.spring.data.eclipse.store.demo.complex.model.Person;
+import software.xdev.spring.data.eclipse.store.repository.lazy.SpringDataEclipseStoreLazy;
 
 
 public class Owner extends Person
@@ -33,7 +35,7 @@ public class Owner extends Person
 
 	private String telephone;
 
-	private final List<Pet> pets = new ArrayList<>();
+	private Lazy<List<Pet>> pets = SpringDataEclipseStoreLazy.build(new ArrayList<>());
 
 	public String getAddress()
 	{
@@ -52,7 +54,12 @@ public String getTelephone()
 
 	public List<Pet> getPets()
 	{
-		return this.pets;
+		return this.pets.get();
+	}
+	
+	public void setPets(final List<Pet> pets)
+	{
+		this.pets = SpringDataEclipseStoreLazy.build(pets);
 	}
 
 	public void addPet(final Pet pet)

spring-data-eclipse-store-demo/src/main/java/software/xdev/spring/data/eclipse/store/demo/complex/owner/OwnerRepository.java

@@ -15,6 +15,8 @@
  */
 package software.xdev.spring.data.eclipse.store.demo.complex.owner;
 
+import java.util.List;
+
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.Pageable;
 import org.springframework.data.repository.Repository;
@@ -28,5 +30,7 @@ public interface OwnerRepository extends Repository<Owner, Integer>
 
 	Page<Owner> findAll(Pageable pageable);
 
+	List<Owner> findAll();
+	
 	void deleteAll();
 }

spring-data-eclipse-store-jpa/src/test/java/software/xdev/spring/data/eclipse/store/jpa/integration/repository/PersonToTestInEclipseStoreRepository.java

@@ -3,6 +3,7 @@
 import software.xdev.spring.data.eclipse.store.repository.interfaces.EclipseStoreListCrudRepository;
 
 
-public interface PersonToTestInEclipseStoreRepository extends EclipseStoreListCrudRepository<PersonToTestInEclipseStore, String>
+public interface PersonToTestInEclipseStoreRepository
+	extends EclipseStoreListCrudRepository<PersonToTestInEclipseStore, String>
 {
 }