Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

shorter method name in doc example 

Signed-off-by: Gavin King <gavin@hibernate.org>
This commit is contained in:
Gavin King 2024-10-24 13:59:51 +02:00
parent 743691e3b2
commit 7002ee8d0d
2 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
documentation/src/main/asciidoc/introduction/Introduction.adoc
View File

@ -498,8 +498,8 @@ Let's hit the code with our favorite thing, the Extract Method refactoring. We o
[source,java] [source,java]
---- ----
static List<Book> findBooksByTitleWithPagination(Session session, static List<Book> findBooksTitled(Session session,
String titlePattern, Page page) { String titlePattern, Page page) {
return session.createSelectionQuery("from Book where title like ?1 order by title", Book.class) return session.createSelectionQuery("from Book where title like ?1 order by title", Book.class)
.setParameter(1, titlePattern) .setParameter(1, titlePattern)
.setPage(page) .setPage(page)
@ -522,9 +522,9 @@ We need a place to put the annotation, so let's move our query method to a new c
query = "from Book where title like :title order by title") query = "from Book where title like :title order by title")
class Queries { class Queries {
static List<Book> findBooksByTitleWithPagination(Session session, static List<Book> findBooksTitled(Session session,
String titlePattern, Page page) { String titlePattern, Page page) {
return session.createNamedQuery(Queries_._findBooksByTitle_) //type safe reference to the named query return session.createQuery(Queries_._findBooksByTitle_) //type safe reference to the named query
.setParameter("title", titlePattern) .setParameter("title", titlePattern)
.setPage(page) .setPage(page)
.getResultList(); .getResultList();
@ -549,7 +549,7 @@ Whatever the case, the code which orchestrates a unit of work usually just calls
@Path("books/{titlePattern}") @Path("books/{titlePattern}")
public List<Book> findBooks(String titlePattern) { public List<Book> findBooks(String titlePattern) {
var books = sessionFactory.fromTransaction(session -> var books = sessionFactory.fromTransaction(session ->
Queries.findBooksByTitleWithPagination(session, titlePattern, Queries.findBooksTitled(session, titlePattern,
Page.page(RESULTS_PER_PAGE, page))); Page.page(RESULTS_PER_PAGE, page)));
return books.isEmpty() ? Response.status(404).build() : books; return books.isEmpty() ? Response.status(404).build() : books;
} }
@ -569,7 +569,7 @@ Suppose we simplify `Queries` to just the following:
---- ----
interface Queries { interface Queries {
@HQL("where title like :title order by title") @HQL("where title like :title order by title")
List<Book> findBooksByTitleWithPagination(String title, Page page); List<Book> findBooksTitled(String title, Page page);
} }
---- ----
@ -582,7 +582,7 @@ We can call it just like we were previously calling our handwritten version:
@Path("books/{titlePattern}") @Path("books/{titlePattern}")
public List<Book> findBooks(String titlePattern) { public List<Book> findBooks(String titlePattern) {
var books = sessionFactory.fromTransaction(session -> var books = sessionFactory.fromTransaction(session ->
Queries_.findBooksByTitleWithPagination(session, titlePattern, Queries_.findBooksTitled(session, titlePattern,
Page.page(RESULTS_PER_PAGE, page))); Page.page(RESULTS_PER_PAGE, page)));
return books.isEmpty() ? Response.status(404).build() : books; return books.isEmpty() ? Response.status(404).build() : books;
} }
@ -602,7 +602,7 @@ interface Queries {
EntityManager entityManager(); EntityManager entityManager();
@HQL("where title like :title order by title") @HQL("where title like :title order by title")
List<Book> findBooksByTitleWithPagination(String title, Page page); List<Book> findBooksTitled(String title, Page page);
} }
---- ----
@ -616,7 +616,7 @@ The `Queries` interface is now considered a _repository_, and we may use CDI to
@Path("books/{titlePattern}") @Path("books/{titlePattern}")
@Transactional @Transactional
public List<Book> findBooks(String titlePattern) { public List<Book> findBooks(String titlePattern) {
var books = queries.findBooksByTitleWithPagination(session, titlePattern, var books = queries.findBooksTitled(session, titlePattern,
Page.page(RESULTS_PER_PAGE, page)); Page.page(RESULTS_PER_PAGE, page));
return books.isEmpty() ? Response.status(404).build() : books; return books.isEmpty() ? Response.status(404).build() : books;
} }

4
documentation/src/main/asciidoc/introduction/Processor.adoc
View File

@ -572,7 +572,7 @@ This lets us declare which associations of `Book` should be pre-fetched by annot
// ---- // ----
// interface Queries { // interface Queries {
// @HQL("from Book where title like :title order by title offset :start fetch first :max rows only") // @HQL("from Book where title like :title order by title offset :start fetch first :max rows only")
// List<Book> findBooksByTitleWithPagination(String title, int max, int start); // List<Book> findBooksTitled(String title, int max, int start);
// } // }
// ---- // ----
// //
@ -583,7 +583,7 @@ This lets us declare which associations of `Book` should be pre-fetched by annot
// [source,java] // [source,java]
// ---- // ----
// List<Book> books = // List<Book> books =
// Queries_.findBooksByTitleWithPagination(entityManager, titlePattern, // Queries_.findBooksTitled(entityManager, titlePattern,
// RESULTS_PER_PAGE, page*RESULTS_PER_PAGE); // RESULTS_PER_PAGE, page*RESULTS_PER_PAGE);
// ---- // ----