Criando o arquivo de engenharia reversa do Hibernate

Se quiser utilizar os arquivos de mapeamento Hibernate e POJOs de um assistente de banco de dados, primeiro é necessário criar um arquivo de engenharia reversa hibernate.reveng.xml. Os arquivos de mapeamento Hibernate e POJOs de um assistente de banco de dados precisa de hibernate.reveng.xml e hibernate.cfg.xml.

O arquivo de engenharia reversa permite ter maior controle sobre a estratégia de mapeamento do banco de dados. O assistente para engenharia reversa do Hibernate cria um arquivo de engenharia reversa com uma configuração padrão que pode ser editada no editor XML.

Para criar o arquivo de engenharia reversa do Hibernate, realize as etapas seguintes.

1. Clique com o botão direito do mouse no nó Pacotes de código-fonte na janela Projetos e escolha Novo > Outro para abrir o assistente para Novo arquivo.
2. Selecione o assistente para engenharia reversa do Hibernate na categoria Hibernate. Clique em Avançar.
3. Especifique hibernate.reveng como o Nome do arquivo e src/java para a Pasta. Clique em Próximo.
4. Selecione hibernate.cfg.xml na lista suspensa Arquivo de configuração, caso não esteja selecionado.
5. Selecione as tabelas seguintes em Tabelas disponíveis e clique em Adicionar para adicionar as tabelas a Tabelas selecionadas.
   • actor
   • category
   • film
   • film_actor
   • film_category
   • language

   Clique em Terminar.

   

O assistente gera um arquivo de engenharia reversa hibernate.reveng.xml e abre o arquivo no editor. É possível fechar o arquivo de engenharia reversa porque não será necessário editar o arquivo.

Para obter detalhes sobre como trabalhar com o arquivo hibernate. reveng.xml, consulte o Capítulo 5. Controlando a engenharia reversa no Guia de referência das ferramentas do Hibernate.

Criando arquivos de mapeamento do Hibernate e POJOs

É possível utilizar os Arquivos de mapeamento do Hibernate e POJOs obtidos de um assistente de banco de dados para gerar arquivos. O assistente pode gerar um POJO e um arquivo de mapeamento correspondente para cada tabela que você selecionar no assistente. Os arquivos de mapeamento são arquivos XML que contêm dados sobre como as colunas das tabelas são mapeadas para os campos nos POJOs. Você precisa possuir os arquivos hibernate.reveng.xml e hibernate.cfg.xml para utilizar o assistente.

Para criar POJOS e arquivos de mapeamento utilizando um assistente, efetue as etapas a seguir.

1. Clique com o botão direito do mouse no nó Pacotes de código-fonte na janela Projetos e escolha Novo > Outro para abrir o assistente para Novo arquivo.
2. Selecione Arquivos de mapeamento do Hibernate e POJOs provenientes de um banco de dados na categoria Hibernate. Clique em Próximo.
3. Certifique-se de que os arquivos hibernate.cfg.xml e hibernate.reveng.xml estejam selecionados nas listas suspensas.
4. Selecione Recursos da linguagem JDK sob as opções Configurações gerais.
5. Verifique se as opções Código de domínio e Mapeamentos XML do Hibernate estão selecionadas.
6. Selecione dvdrental para o Nome do pacote. Clique em Terminar.
   

Quando você clica em Terminar, o IDE gera POJOs e arquivos de mapeamento do Hibernate com os campos mapeados para as colunas especificadas em hibernate.reveng.xml. O IDE também adiciona entradas de mapeamento em hibernate.cfg.xml. É possível expandir o pacote dvdrental para ver os arquivos gerados pelo assistente.

É possível utilizar o assistente para mapeamento do Hibernate se quiser criar um arquivo de mapeamento do Hibernate que mapeie uma tabela específica para uma classe específica.

Para mais detalhes sobre como trabalhar com o arquivo hibernate.reveng.xml, consulte o Capítulo 5. Mapeamento O/R básico na Documentação de referência do Hibernate.

Criando a classe

Nesta seção, o assistente Novo arquivo é utilizado para criar a classe assistente FilmHelper.java no pacote dvdrental. Você criará uma sessão do Hibernate, chamando getSessionFactory em HibernateUtil.java e alguns métodos assistentes para criar as consultas para recuperar dados do banco de dados. Você chamará os métodos do helper a partir de páginas JSP.

1. Clique com o botão direito do mouse no nó do pacote de códigos-fonte dvdrental e selecione Novo > Classe Java para abrir o assistente para Novo arquivo.
2. Digite FilmHelper como nome da classe.
3. Verifique se o Pacote é dvdrental. Clique em Terminar.
4. Adicionando o código seguinte (em negrito) para criar uma sessão do Hibernate.

   public class FilmHelper {
   
       Session session = null;
   
       public FilmHelper() {
           this.session = HibernateUtil.getSessionFactory().getCurrentSession();
       }
   
   }

5. Corrija as importações (org.hibernate.Sessione) e salve as alterações.

Agora você modificará FilmHelper.java para adicionar métodos do que consultam o BD.

Enumerando títulos de filme e recuperando atores utilizando uma consulta HQL

Neste exercício, você criará uma consulta Hibernate Query Language (HQL) que consulta o banco de dados para recuperar uma lista de filmes da tabela Film. A seguir, adicionará um método que consulta as tabelas Actor e Film_actor para procurar os atores que atuam em um filme específico.

A tabela Filme possui 1000 registros, de modo que o método para recuperar a lista de filmes deveria ser capaz de recuperar os registros com base na chave primária filmId. O editor HQL será utilizado para construir e testar a consulta HQL. Depois de ter criado a consulta correta, você adicionará o método à classe que pode gerar a consulta apropriada.

1. Clique com o botão direito do mouse em hibernate.cfg.xml na janela Projetos e escolha Executar consulta HQL para abrir o editor de consultas HQL.
2. Selecione hibernate.cfg na lista suspensa na barra de ferramentas.
3. Teste a conexão, digitando o seguinte no editor e clicando no botão Executar consulta HQL (  ) na barra de ferramentas.

   from Film

   Quando clica em Executar consulta HQL, você pode ver os resultados da consulta na janela inferior do editor de consultas HQL.

   

   Se clicar no botão SQL, você pode ver a consulta SQL equivalente.

   select film0_.film_id as col_0_0_ from sakila.film film0_

4. Digite a consulta seguinte para recuperar os registros na tabela Filme, onde o id do filme está entre 100 e 200.

   from Film as film where film.filmID between 100 and 200

   A janela de resultado exibe uma lista de registros. Agora que a consulta testada retorna os resultados desejados, utilize a consulta na classe assistente.

5. Adicione o método seguinte getFilmTitles a FilmHelper.java para recuperar os filmes, onde o id do filme está entre um certo intervalo especificado pelas variáveis startID e endID.

   public List getFilmTitles(int startID, int endID) {
       List<Film> filmList = null;
       try {
           org.hibernate.Transaction tx = session.beginTransaction();
           Query q = session.createQuery ("from Film as film where film.filmId between '"+startID+"' and '"+endID+"'");
           filmList = (List<Film>) q.list();
       } catch (Exception e) {
           e.printStackTrace();
       }
       return filmList;
   }

6. Adicione o método a seguir getActorsByID que recupera os atores de um filme específico. O método constrói a consulta utilizando filmId como a variável de entrada.

   public List getActorsByID(int filmId){
       List<Actor> actorList = null;
       try {
           org.hibernate.Transaction tx = session.beginTransaction();
           Query q = session.createQuery ("from Actor as actor where actor.actorId in (select filmActor.actor.actorId from FilmActor as filmActor where filmActor.film.filmId='" + filmId + "')");
           actorList = (List<Actor>) q.list();
   
       } catch (Exception e) {
           e.printStackTrace();
       }
   
       return actorList;
   }

7. Corrija as importações e salve as alterações.

   Quando corrige suas importações, você escolhe java.util.List e org.hibernate.Query.

Adicionando métodos adicionais do helper

Agora você adicionará métodos adicionais ao assistente que criam consultas com base em uma variável de entrada. É possível verificar as consultas no editor de consultas HQL.

1. Adicione o método seguinte para recuperar uma lista de categorias de acordo com filmId.

   public Category getCategoryByID(int filmId){
       List<Category> categoryList = null;
       try {
           org.hibernate.Transaction tx = session.beginTransaction();
           Query q = session.createQuery("from Category as category where category.categoryId in (select filmCat.category.categoryId from FilmCategory as filmCat where filmCat.film.filmId='" + filmId + "')");
           categoryList = (List<Category>) q.list();
   
       } catch (Exception e) {
           e.printStackTrace();
       }
   
       return categoryList.get(0);
   }

2. Adicione o método seguinte para recuperar um único filme de acordo com o filmId.

   public Film getFilmByID(int filmId){
   
       Film film = null;
   
       try {
           org.hibernate.Transaction tx = session.beginTransaction();
           Query q = session.createQuery("from Film as film where film.filmId=" + filmId);
           film = (Film) q.uniqueResult();
       } catch (Exception e) {
           e.printStackTrace();
       }
   
       return film;
   }

3. Adicione o método seguinte para recuperar o idioma do filme de acordo com o filmId.

   public String getLangByID(int langId){
   
       Language language = null;
   
       try {
           org.hibernate.Transaction tx = session.beginTransaction();
           Query q = session.createQuery("from Language as lang where lang.languageId=" + langId);
           language = (Language) q.uniqueResult();
       } catch (Exception e) {
           e.printStackTrace();
       }
   
       return language.getName();
   }

Criando template.xhtml

Primeiro, você criará o modelo Facelets JSF template.xhtml utilizado na composição das páginas index.xhtml e browse.xhtml.

1. Clique com o botão direito do mouse em DVDStore na janela Projetos e escolha Novo > Outro.
2. Selecione Modelo Facelets na categoria JavaServer Faces. Clique em Avançar.
3. Digite template em Nome do arquivo e escolha o primeiro estilo de layout CSS.
4. Clique em Terminar.

   Quando você clica em Terminar, o arquivo template.xhtml é aberto no editor. O modelo contém o código padrão seguinte.

   <h:body>
   
       <div id="top" class="top">
           <ui:insert name="top">Top</ui:insert>
       </div>
   
       <div id="content" class="center_content">
           <ui:insert name="content">Content</ui:insert>
       </div>
   
   </h:body>

5. Modifique o elemento <ui:insert> para alterar o nome gerado padrão para "corpo".

   <div id="content" class="center_content">
           <ui:insert name="body">Content</ui:insert>
   </div>

6. Salve as alterações.

O conteúdo dentro do elemento <ui:define name="body"> em index.xhtml e browse.xhtml será inserido no local identificado com <ui:insert name="body">Content</ui:insert> no modelo.

Modificando index.xhtml

Quando você criou o aplicativo da Web, o IDE gerou automaticamente a página index.xhtml. Neste exercício, você modifica a página para exibir uma lista de títulos de filmes. A página JSF chama os métodos no Bean gerenciado JSF FilmController para recuperar a lista de filmes e exibir uma tabela com títulos e descrições dos filmes.

1. Expanda a pasta Páginas da Web na janela Projetos e abra index.xhtml no editor.

   O assistente para novo projeto gerou a seguinte página index.xhtml padrão.

   <html xmlns="http://www.w3.org/1999/xhtml"
         xmlns:h="http://java.sun.com/jsf/html">
   <h:head>
           <title>Facelet Title</title>
       </h:head>
       <h:body>
           Hello from Facelets
       </h:body>
   </html>

2. Modifique a página para que utilize os elementos JSF <ui:composition> e <ui:define> e adicione um elemento <h:form>.

   <html xmlns="http://www.w3.org/1999/xhtml"
     xmlns:h="http://java.sun.com/jsf/html"
     xmlns:ui="http://java.sun.com/jsf/facelets">
       <ui:composition template="./template.xhtml">
           <ui:define name="body">
               <h:form>
   
               </h:form>
           </ui:define>
       </ui:composition>
   </html>

   Quando você começa a digitar as marcas, o IDE adiciona a declaração da biblioteca de marcas xmlns:ui="http://java.sun.com/jsf/facelets".

   Os elementos <ui:composition> e <ui:define> são utilizados em combinação com o modelo de página que você criará. O elemento <ui:composition> faz referência à localização do modelo que será utilizado por essa página. O elemento <ui:define> faz referência à posição no modelo que o código ocupará.

3. Adicione os seguintes links de navegação que chamam os métodos previous e next no Bean gerenciado JSF.

       <ui:define name="body">
               <h:form>
                   <h:commandLink action="#{filmController.previous}" value="Previous #{filmController.pageSize}" rendered="#{filmController.hasPreviousPage}"/> 
                   <h:commandLink action="#{filmController.next}" value="Next #{filmController.pageSize}" rendered="#{filmController.hasNextPage}"/> 
               </h:form>
       </ui:define>

4. Adicione o seguinte elemento dataTable (em negrito) para gerar a tabela para exibir os itens recuperados.

               <h:form styleClass="jsfcrud_list_form">
                   <h:commandLink action="#{filmController.previous}" value="Previous #{filmController.pageSize}" rendered="#{filmController.hasPreviousPage}"/> 
                   <h:commandLink action="#{filmController.next}" value="Next #{filmController.pageSize}" rendered="#{filmController.hasNextPage}"/> 
                   <h:dataTable value="#{filmController.filmTitles}" var="item" border="0" cellpadding="2" cellspacing="0" rowClasses="jsfcrud_odd_row,jsfcrud_even_row" rules="all" style="border:solid 1px">
                       <h:column>
                           <f:facet name="header">
                               <h:outputText value="Title"/>
                           </f:facet>
                           <h:outputText value="#{item.title}"/>
                       </h:column>
                       <h:column>
                           <f:facet name="header">
                               <h:outputText value="Description"/>
                           </f:facet>
                           <h:outputText value="#{item.description}"/>
                       </h:column>
                       <h:column>
                           <f:facet name="header">
                               <h:outputText value=" "/>
                           </f:facet>
                           <h:commandLink action="#{filmController.prepareView}" value="View"/>
                       </h:column>
                   </h:dataTable>
                   <br/>
               </h:form>
   

5. Salve as alterações.

A página de índice exibirá agora uma lista de títulos de filmes no banco de dados. Cada linha da tabela inclui um link "Visualizar" que chama o método prepareView no bean gerenciado. O método prepareView retorna "browse" e abrirá o browse.xhtml.

Quando você digitar a marca <f:facet>, o IDE adicionará a declaração da biblioteca de marcas xmlns:f="http://java.sun.com/jsf/core.

Criando browse.xhtml

Agora você criará a página browse.xhtml para exibir os detalhes do filme selecionado. É possível utilizar o assistente Cliente de modelo Facelets para criar a página com base no modelo Facelets JSF template.xhtml que você criou.

1. Clique com o botão direito do mouse em DVDStore na janela Projetos e escolha Novo > Outro.
2. Selecione Cliente de modelo Facelets na categoria JavaServer Faces. Clique em Avançar.
   
3. Digite browse para o Nome do arquivo
4. Localize o modelo da página clicando em Procurar para abrir a caixa de diálogo Procurar arquivos.
5. Expanda a pasta Páginas da Web e selecione template.xhtml. Clique em Selecionar arquivo.
   
6. Selecione <ui:composition> em Marcação de raiz gerada. Clique em Terminar.

   Quando você clica em Terminar, o arquivo browse.xhtml se abre no editor com o código seguinte.

   <ui:composition xmlns:ui="http://java.sun.com/jsf/facelets"
       template="./template.xhtml">
   
       <ui:define name="top">
           top
       </ui:define>
   
       <ui:define name="body">
           body
       </ui:define>
   
   </ui:composition>

   É possível ver que o novo arquivo especifica o arquivo template.xhtml e que a marcação <ui:define> possui a propriedade name="body"

7. Adicione o código seguinte (em negrito) entre as marcas <ui:define> para criar o formulário e chamar os métodos no Bean gerenciado FilmController para recuperar os dados e preencher o formulário.

   <ui:composition xmlns:ui="http://java.sun.com/jsf/facelets"
       template="./template.xhtml"
       xmlns:h="http://java.sun.com/jsf/html"
       xmlns:f="http://java.sun.com/jsf/core">
   
           <ui:define name="top">
               top
           </ui:define>
   
           <ui:define name="body">
           
               <h:form>
                   <h:panelGrid columns="2">
                       <h:outputText value="Title:"/>
                       <h:outputText value="#{filmController.selected.title}" title="Title"/>
                       <h:outputText value="Description"/>
                       <h:outputText value="#{filmController.selected.description}" title="Description"/>
                       <h:outputText value="Genre"/>
                       <h:outputText value="#{filmController.category}"/>
   
                       <h:outputText value="Cast"/>
                       <h:outputText value="#{filmController.actors}"/>
   
   
                       <h:outputText value="Film Length"/>
                       <h:outputText value="#{filmController.selected.length} min" title="Film Length"/>
   
                       <h:outputText value="Language"/>
                       <h:outputText value="#{filmController.language}" title="Film Length"/>
   
                       <h:outputText value="Release Year"/>
                       <h:outputText value="#{filmController.selected.releaseYear}" title="Release Year">
                           <f:convertDateTime pattern="MM/dd/yyyy" />
                       </h:outputText>
                       <h:outputText value="Rental Duration"/>
                       <h:outputText value="#{filmController.selected.rentalDuration}" title="Rental DUration"/>
                       <h:outputText value="Rental Rate"/>
                       <h:outputText value="#{filmController.selected.rentalRate}" title="Rental Rate"/>
                       <h:outputText value="Replacement Cost"/>
                       <h:outputText value="#{filmController.selected.replacementCost}" title="Replacement Cost"/>
                       <h:outputText value="Rating"/>
                       <h:outputText value="#{filmController.selected.rating}" title="Rating"/>
                       <h:outputText value="Special Features"/>
                       <h:outputText value="#{filmController.selected.specialFeatures}" title="Special Features"/>
                       <h:outputText value="Last Update"/>
                       <h:outputText value="#{filmController.selected.lastUpdate}" title="Last Update">
                           <f:convertDateTime pattern="MM/dd/yyyy HH:mm:ss" />
                       </h:outputText>
                   </h:panelGrid>
                   <br/>
                   <br/>
                   <h:commandLink action="#{filmController.prepareList}" value="View All List"/>
                   <br/>
               </h:form>
   
           </ui:define>
       </ui:composition>
   </html>

   É possível ver que browse.xhtml e index.xhtml utilizarão o mesmo modelo de página.

8. Salve as alterações.