-
Notifications
You must be signed in to change notification settings - Fork 244
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
HSEARCH-5235 WIP: draft of injecting field references #4451
Draft
marko-bekhta
wants to merge
1
commit into
hibernate:main
Choose a base branch
from
marko-bekhta:feat/HSEARCH-5235-Custom-annotations-and-binders-compatible-with-javacs-annotation-processor
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
43 changes: 43 additions & 0 deletions
43
.../hibernate/search/documentation/mapper/orm/binding/document/model/dsl/injection/Book.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * Copyright Red Hat Inc. and Hibernate Authors | ||
| */ | ||
| package org.hibernate.search.documentation.mapper.orm.binding.document.model.dsl.injection; | ||
|
|
||
| import jakarta.persistence.Convert; | ||
| import jakarta.persistence.Entity; | ||
| import jakarta.persistence.GeneratedValue; | ||
| import jakarta.persistence.Id; | ||
|
|
||
| import org.hibernate.search.documentation.testsupport.data.ISBN; | ||
| import org.hibernate.search.documentation.testsupport.data.ISBNAttributeConverter; | ||
| import org.hibernate.search.mapper.pojo.bridge.mapping.annotation.PropertyBinderRef; | ||
| import org.hibernate.search.mapper.pojo.mapping.definition.annotation.GenericField; | ||
| import org.hibernate.search.mapper.pojo.mapping.definition.annotation.Indexed; | ||
| import org.hibernate.search.mapper.pojo.mapping.definition.annotation.PropertyBinding; | ||
|
|
||
| @Entity | ||
| @Indexed | ||
| public class Book { | ||
|
|
||
| @Id | ||
| @GeneratedValue | ||
| @GenericField | ||
| private Integer id; | ||
|
|
||
| @Convert(converter = ISBNAttributeConverter.class) | ||
| @PropertyBinding(binder = @PropertyBinderRef(type = ISBNBinder.class)) | ||
| private ISBN isbn; | ||
|
|
||
| public Integer getId() { | ||
| return id; | ||
| } | ||
|
|
||
| public ISBN getIsbn() { | ||
| return isbn; | ||
| } | ||
|
|
||
| public void setIsbn(ISBN isbn) { | ||
| this.isbn = isbn; | ||
| } | ||
| } |
55 changes: 55 additions & 0 deletions
55
...cumentation/mapper/orm/binding/document/model/dsl/injection/DocumentModelDslInjectIT.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * Copyright Red Hat Inc. and Hibernate Authors | ||
| */ | ||
| package org.hibernate.search.documentation.mapper.orm.binding.document.model.dsl.injection; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.hibernate.search.util.impl.integrationtest.mapper.orm.OrmUtils.with; | ||
|
|
||
| import java.util.Arrays; | ||
| import java.util.List; | ||
|
|
||
| import jakarta.persistence.EntityManagerFactory; | ||
|
|
||
| import org.hibernate.search.documentation.testsupport.BackendConfigurations; | ||
| import org.hibernate.search.documentation.testsupport.DocumentationSetupHelper; | ||
| import org.hibernate.search.documentation.testsupport.data.ISBN; | ||
| import org.hibernate.search.mapper.orm.Search; | ||
| import org.hibernate.search.mapper.orm.session.SearchSession; | ||
|
|
||
| import org.junit.jupiter.api.BeforeEach; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.extension.RegisterExtension; | ||
|
|
||
| class DocumentModelDslInjectIT { | ||
| @RegisterExtension | ||
| public DocumentationSetupHelper setupHelper = DocumentationSetupHelper.withSingleBackend( BackendConfigurations.simple() ); | ||
|
|
||
| private EntityManagerFactory entityManagerFactory; | ||
|
|
||
| @BeforeEach | ||
| void setup() { | ||
| entityManagerFactory = setupHelper.start().setup( Book.class ); | ||
| } | ||
|
|
||
| @Test | ||
| void smoke() { | ||
| with( entityManagerFactory ).runInTransaction( entityManager -> { | ||
| Book book = new Book(); | ||
| book.setIsbn( ISBN.parse( "978-0-58-600835-5" ) ); | ||
| entityManager.persist( book ); | ||
| } ); | ||
|
|
||
| with( entityManagerFactory ).runInTransaction( entityManager -> { | ||
| SearchSession searchSession = Search.session( entityManager ); | ||
|
|
||
| List<Book> result = searchSession.search( Arrays.asList( Book.class ) ) | ||
| .where( f -> f.match().field( "isbn" ).matching( "978-0-58-600835-5" ) ) | ||
| .fetchHits( 20 ); | ||
|
|
||
| assertThat( result ).hasSize( 1 ); | ||
| } ); | ||
| } | ||
|
|
||
| } |
57 changes: 57 additions & 0 deletions
57
...nate/search/documentation/mapper/orm/binding/document/model/dsl/injection/ISBNBinder.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * Copyright Red Hat Inc. and Hibernate Authors | ||
| */ | ||
| package org.hibernate.search.documentation.mapper.orm.binding.document.model.dsl.injection; | ||
|
|
||
| import org.hibernate.search.documentation.testsupport.data.ISBN; | ||
| import org.hibernate.search.engine.backend.document.DocumentElement; | ||
| import org.hibernate.search.engine.backend.document.IndexFieldReference; | ||
| import org.hibernate.search.mapper.pojo.bridge.PropertyBridge; | ||
| import org.hibernate.search.mapper.pojo.bridge.binding.PropertyBindingContext; | ||
| import org.hibernate.search.mapper.pojo.bridge.mapping.programmatic.PropertyBinder; | ||
| import org.hibernate.search.mapper.pojo.bridge.runtime.PropertyBridgeWriteContext; | ||
| import org.hibernate.search.mapper.pojo.mapping.definition.annotation.KeywordField; | ||
|
|
||
| //tag::bind[] | ||
| public class ISBNBinder implements PropertyBinder { | ||
|
|
||
| @KeywordField(normalizer = "isbn") | ||
| IndexFieldReference<String> isbn; | ||
|
|
||
| IndexFieldReference<String> isbnNoAnnotation; | ||
|
|
||
| @Override | ||
| public void bind(PropertyBindingContext context) { | ||
| context.dependencies() | ||
| .useRootOnly(); | ||
|
|
||
| context.bridge( // <6> | ||
| ISBN.class, // <7> | ||
| new ISBNBridge( isbn ) // <8> | ||
| ); | ||
| } | ||
| //end::bind[] | ||
|
|
||
| //tag::write[] | ||
| private static class ISBNBridge implements PropertyBridge<ISBN> { | ||
|
|
||
| private final IndexFieldReference<String> fieldReference; | ||
|
|
||
| private ISBNBridge(IndexFieldReference<String> fieldReference) { | ||
| this.fieldReference = fieldReference; | ||
| } | ||
|
|
||
| @Override | ||
| public void write(DocumentElement target, ISBN bridgedElement, PropertyBridgeWriteContext context) { | ||
| String indexedValue = /* ... (extraction of data, not relevant) ... */ | ||
| //end::write[] | ||
| bridgedElement.getStringValue(); | ||
| //tag::write[] | ||
| target.addValue( this.fieldReference, indexedValue ); // <1> | ||
| } | ||
| } | ||
| //end::write[] | ||
| //tag::bind[] | ||
| } | ||
| //end::bind[] | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Interestingly, if we found a way to declare dependencies through annotations too... we could get rid of the binder altogether, and declare everything directly in the bridge.
In fact if we do that, I wonder if there's even any reason to keep binders when using annotations to configure the binding? They might only be useful for the old, very-dynamic API, which we'll probably want to deprecate anyway.