Skip to content
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-3573 Use consistent naming for hits and projections #1972

Merged
merged 8 commits into from May 14, 2019

Conversation

yrodiere
Copy link
Member

@yrodiere yrodiere commented May 9, 2019

HSEARCH-3573: Use consistent naming for hits and projections

Based on #1971 , which should be merged first. => Done

This is strictly about method and generic type parameter names. There's a lot of changes, but very few of them are significant. I just need to know if the idea seems sound: maybe you can determine that from the commit messages? I don't want to force you to go through the entire diff...

The only significant change is the renaming of the object() projection to entity(), to be consistent with the wording of asEntity() when creating a query.

@yrodiere yrodiere added the Waiting for other pull request Based on another PR that should be merged first label May 9, 2019
@yrodiere
Copy link
Member Author

Jenkins, retest this please

@coveralls
Copy link

coveralls commented May 13, 2019

Pull Request Test Coverage Report for Build 6

  • 106 of 107 (99.07%) changed or added relevant lines in 46 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-0.002%) to 88.688%

Changes Missing Coverage Covered Lines Changed/Added Lines %
engine/src/main/java/org/hibernate/search/engine/search/dsl/projection/spi/DelegatingSearchProjectionFactoryContext.java 1 2 50.0%
Totals Coverage Status
Change from base Build 239: -0.002%
Covered Lines: 17381
Relevant Lines: 19598

💛 - Coveralls

Copy link
Contributor

@fax4ever fax4ever left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.
I'm very happy about having now a consist use of the letters for marking generics.
I've just few comments.

@@ -176,7 +176,7 @@ such as `SearchPredicateFactory` or `FieldSortBuilder`.

Note that the APIs implemented by the engine include ways for the mapper to wrap the resulting search query
(`SearchQueryWrappingDefinitionResultContext#asWrappedQuery`).
Also, the SPIs implemented by backends allow mappers to inject an "object loader" (see `SearchQueryBuilderFactory.asObject`)
Also, the SPIs implemented by backends allow mappers to inject an "entity loader" (see `SearchQueryBuilderFactory.asObject`)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should expose in our documentation in a very clear way what we meant for an entity.
Maybe it is just a first class object to handle indexes and
not necessarily an Hibernate ORM Entity nor an Entity Bean.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a TODO to explain that where we explain the concept of "mapping".

@yrodiere
Copy link
Member Author

Thanks! I addressed your comments. Waiting for CI...

@fax4ever
Copy link
Contributor

@yrodiere +1 to merge. May I do it after the CI finishes?

@yrodiere
Copy link
Member Author

@fax4ever Sorry I didn't see you message. Well, I'm here now, I'll merge. Thanks!

@yrodiere yrodiere merged commit 0593e87 into hibernate:master May 14, 2019
@fax4ever
Copy link
Contributor

@yrodiere it's the same. Thank you

@yrodiere yrodiere deleted the HSEARCH-3573 branch May 24, 2019 06:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants