From 7002ee8d0daf15989dcc4893bfaf317332aab74b Mon Sep 17 00:00:00 2001 From: Gavin King Date: Thu, 24 Oct 2024 13:59:51 +0200 Subject: [PATCH] shorter method name in doc example Signed-off-by: Gavin King --- .../asciidoc/introduction/Introduction.adoc | 20 +++++++++---------- .../main/asciidoc/introduction/Processor.adoc | 4 ++-- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/documentation/src/main/asciidoc/introduction/Introduction.adoc b/documentation/src/main/asciidoc/introduction/Introduction.adoc index e511794d0b..c50ed96bcb 100644 --- a/documentation/src/main/asciidoc/introduction/Introduction.adoc +++ b/documentation/src/main/asciidoc/introduction/Introduction.adoc @@ -498,8 +498,8 @@ Let's hit the code with our favorite thing, the Extract Method refactoring. We o [source,java] ---- -static List findBooksByTitleWithPagination(Session session, - String titlePattern, Page page) { +static List findBooksTitled(Session session, + String titlePattern, Page page) { return session.createSelectionQuery("from Book where title like ?1 order by title", Book.class) .setParameter(1, titlePattern) .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") class Queries { - static List findBooksByTitleWithPagination(Session session, - String titlePattern, Page page) { - return session.createNamedQuery(Queries_._findBooksByTitle_) //type safe reference to the named query + static List findBooksTitled(Session session, + String titlePattern, Page page) { + return session.createQuery(Queries_._findBooksByTitle_) //type safe reference to the named query .setParameter("title", titlePattern) .setPage(page) .getResultList(); @@ -549,7 +549,7 @@ Whatever the case, the code which orchestrates a unit of work usually just calls @Path("books/{titlePattern}") public List findBooks(String titlePattern) { var books = sessionFactory.fromTransaction(session -> - Queries.findBooksByTitleWithPagination(session, titlePattern, + Queries.findBooksTitled(session, titlePattern, Page.page(RESULTS_PER_PAGE, page))); return books.isEmpty() ? Response.status(404).build() : books; } @@ -569,7 +569,7 @@ Suppose we simplify `Queries` to just the following: ---- interface Queries { @HQL("where title like :title order by title") - List findBooksByTitleWithPagination(String title, Page page); + List 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}") public List findBooks(String titlePattern) { var books = sessionFactory.fromTransaction(session -> - Queries_.findBooksByTitleWithPagination(session, titlePattern, + Queries_.findBooksTitled(session, titlePattern, Page.page(RESULTS_PER_PAGE, page))); return books.isEmpty() ? Response.status(404).build() : books; } @@ -602,7 +602,7 @@ interface Queries { EntityManager entityManager(); @HQL("where title like :title order by title") - List findBooksByTitleWithPagination(String title, Page page); + List 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}") @Transactional public List findBooks(String titlePattern) { - var books = queries.findBooksByTitleWithPagination(session, titlePattern, + var books = queries.findBooksTitled(session, titlePattern, Page.page(RESULTS_PER_PAGE, page)); return books.isEmpty() ? Response.status(404).build() : books; } diff --git a/documentation/src/main/asciidoc/introduction/Processor.adoc b/documentation/src/main/asciidoc/introduction/Processor.adoc index ca34346851..8c42e0ba40 100644 --- a/documentation/src/main/asciidoc/introduction/Processor.adoc +++ b/documentation/src/main/asciidoc/introduction/Processor.adoc @@ -572,7 +572,7 @@ This lets us declare which associations of `Book` should be pre-fetched by annot // ---- // interface Queries { // @HQL("from Book where title like :title order by title offset :start fetch first :max rows only") -// List findBooksByTitleWithPagination(String title, int max, int start); +// List 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] // ---- // List books = -// Queries_.findBooksByTitleWithPagination(entityManager, titlePattern, +// Queries_.findBooksTitled(entityManager, titlePattern, // RESULTS_PER_PAGE, page*RESULTS_PER_PAGE); // ----