Você está na página 1de 40

Manual Demoiselle Wizard CETEC/CTCTA

Manual Demoiselle Wizard CETEC

Histrico de Verses
Data 07/05/2009 24/06/2009 25/06/2009 30/06/2009 12/01/10 07/05/10 Verso 0.1 0.2 1.0 1.1 1.1.1 1.1.1 Descrio Criao do documento Correo da URL do update site Incluso de exemplo de aplicao Finalizao do exemplo de aplicao Reviso para verso 1.1.1 do Wizard Atualizao de URLs conforme reestruturao aps unificao dos projetos. Autor Mrio Costa Flvio Lisboa Flvio Lisboa Flvio Lisboa Emerson S. Saito Rodrigo HJORT Revisor Flvio Lisboa Aprovado por

Manual Demoiselle Wizard CETEC

Sumrio
1.Viso Geral........................................................................................................................................4 1.1. Pr-requisitos............................................................................................................................4 1.1.1. Do usurio.........................................................................................................................4 1.1.2. Do ambiente......................................................................................................................4 1.2. Instalao..................................................................................................................................4 1.3. Criar Projeto com Maven (m2Eclipse).......................................................................................4 1.3.1. Criar Projeto sem plugin Maven. .......................................................................................5 1.3.2. Exemplo de Estrutura do Projeto ......................................................................................6 1.4. Estrutura de Pacotes e Arquivos de Configurao...................................................................6 2.Configurar Projeto.............................................................................................................................9 2.1. Aba Configurao.....................................................................................................................9 2.1.1. Descrio dos Campos...................................................................................................10 2.1.2. Descrio das Alteraes................................................................................................10 2.2. Configuraes do Hibernate ...................................................................................................10 2.2.1. Descrio dos Campos...................................................................................................11 2.2.2. Descrio das alteraes................................................................................................12 2.3. JPA (Java Persistence API)....................................................................................................12 2.3.1. Descrio dos campos....................................................................................................13 2.3.1. Descrio das alteraes................................................................................................14 2.4. Cadastro de Mensagens.........................................................................................................14 2.4.1. Descrio dos Campos...................................................................................................15 2.4.2. Descrio das Alteraes................................................................................................15 3. Editar Projeto..................................................................................................................................16 3.1. Gerao de DAOs...................................................................................................................16 3.1.1. Descrio dos Campos...................................................................................................17 3.1.2. Descrio das Alteraes................................................................................................18 3.2. Gerao de Business Controllers...........................................................................................20 3.2.1. Descrio dos Campos...................................................................................................21 3.2.2. Descrio das Alteraes................................................................................................21 3.3. Gerao de Regras de Navegao.......................................................................................22 3.3.1. Descrio dos Campos...................................................................................................23 3.3.2. Descrio das Alteraes................................................................................................23 3.4. Gerao de Managed Beans..................................................................................................24 3.4.1. Descrio dos Campos...................................................................................................25 3.4.2. Descrio das Alteraes................................................................................................26 3.5. Gerao de Fachadas............................................................................................................27 3.5.1. Descrio dos Campos...................................................................................................28 3.5.2. Descrio das Alteraes................................................................................................28 3.6. Gerao de Testes Unitrios..................................................................................................30 3.6.1. Descrio dos Campos...................................................................................................31 3.6.2. Descrio das Alteraes................................................................................................31 3.7. Criar pginas...........................................................................................................................32 3.7.1. Descrio dos Campos...................................................................................................32 3.7.2. Cadastro da Pgina de Listagem....................................................................................33 3.7.2.1. Descrio dos Campos............................................................................................34 3.7.2.2. Descrio das Alteraes........................................................................................35 3.7.3. Cadastro da Pgina de Visualizao..............................................................................35 3.7.3.1. Descrio dos Campos............................................................................................36 3.7.3.2. Descrio das Alteraes........................................................................................37
3

Manual Demoiselle Wizard CETEC

3.7.4. Cadastro da Pgina de Edio.......................................................................................37 3.7.4.1. Descrio dos Campos............................................................................................37 3.7.4.2. Descrio das Alteraes........................................................................................38

Manual Demoiselle Wizard CETEC

1 1.Viso Geral Demoiselle Wizard uma ferramenta que visa auxiliar o desenvolvimento de aplicao WEB que utilizam o Demoiselle Framework. A ideia do Wizard apoiar na configurao, procurando gerar o cdigo bsico comum de partes da aplicao, deixando o foco do desenvolvedor nas regras de negcio. 1.1. Pr-requisitos Como toda ferramenta de software, o Demoiselle Wizard est baseado em alguns conceitos e produtos que no sero abordados neste manual.
1.1.1. Do usurio

Conhecimento no uso da plataforma Eclipse (http://www.eclipse.org/). Desenvolvimento JEE (http://java.sun.com/javaee/). Padres de projeto em Java (http://java.sun.com/blueprints/corej2eepatterns/Patterns/index.html)

1.1.2. Do ambiente

JDK 1.5 ou superior (http://java.sun.com/javaee/downloads/index.jsp). Eclipse IDE, verso 3.4.2 ou superior (http://www.eclipse.org/downloads/). AspectJ Development Tools for Eclipse (http://download.eclipse.org/tools/ajdt/34/update) Recomendados:

Maven Integration for Eclipse (http://m2eclipse.sonatype.org/update/) JBoss Tools (http://download.jboss.org/jbosstools/updates/stable)

1.2. Instalao A instalao e atualizao do Demoiselle Wizard ser atravs de um updatesite do Eclipse disponibilizado no site: http://demoiselle.sourceforge.net/wizard/updatesite/

Eclipse 3.4.x Menu: Help Software Updates Available Software Add Site Eclipse 3.5.x Menu: Help Install New Software Add...

1 1.3. Criar Projeto com Maven (m2Eclipse) Nesta opo, o projeto ser criado pelo plugin Maven (ver manual do Demoiselle: http://demoiselle.svn.sourceforge.net/viewvc/demoiselle/trunk/docs/others/tutorial/Demoiselle -Tutorial-Modulo01-Arquitetura-Laboratorio.pdf). O projeto ir conter um conjunto de classes, pacotes, diretrios e arquivos de configurao e um arquivo de configurao do Maven, o pom.xml. Este arquivo ir prover informaes das bibliotecas que o projeto depender.
5

Manual Demoiselle Wizard CETEC

Ao finalizar a operao, o plugin Maven ir criar o projeto com a estrutura bsica da aplicao. O Wizard d opo para o usurio de transformar um projeto java em uma aplicao do tipo Demoiselle. Atravs do item de menu "Demoiselle - Adicionar/Remover caractersticas do Demoiselle Framework", o usurio adiciona ou remove as caractersticas necessrias para identificar a aplicao como uma aplicao Demoiselle. Mesmo atravs do M2Eclipse, o desenvolvedor dever reconhecer este projeto como um projeto Demoiselle: Selecionar o projeto e clicar com o boto direito do mouse para ativar o menu suspenso, depois em "Demoiselle Adicionar/remover caractersticas do Demoiselle".

Figura 1.3 Adicionando caractersticas do Demoiselle Framework

IMPORTANTE: O usurio s tem acesso as demais funcionalidades do Wizard se a aplicao que ele estiver editando possuir caractersticas de uma aplicao Demoiselle. Utilize esta funcionalidade para adicionar estas caractersticas. U 1 1.3.1. Criar Projeto sem plugin Maven. Caso opte por no utilizar o plugin Maven, que recomendado pelo Demoiselle, possvel criar um projeto Java no ambiente Eclipse e depois transform-lo em um projeto Demoiselle para utilizao do Wizard.

Neste link est um exemplo: http://demoiselle.svn.sourceforge.net/viewvc/demoiselle/trunk/docs/others/tutorial/De moiselle-Tutorial-Modulo01-Arquitetura-Anexo-I.pdf

M Manual Demoiselle Wizard CETEC 1.3.2. Exemplo de Estrutura do Projeto

Figura 1.6 Projeto Criado

Manual Demoiselle Wizard CETEC

11.4. Estrutura de Pacotes e Arquivos de Configurao br.gov.demoiselle.projeto.bean Pacote onde sero armazenadas as classes dos POJOs da aplicao. br.gov.demoiselle.projeto.business Pacote onde sero armazenadas as interfaces dos Business Controllers da aplicao. br.gov.demoiselle.projeto.business.implementation Pacote onde sero armazenadas as implementaes dos Business Controllers da a aplicao. br.gov.demoiselle.projeto.config Pacote onde sero armazenadas as classes de configurao br.gov.demoiselle.projeto.constant Pacote onde sero armazenadas as classes de constantes da aplicao. br.gov.demoiselle.projeto.message Pacote onde sero armazenadas as classes de mensagens da aplicao. br.gov.demoiselle.projeto.persistence.dao Pacote onde sero armazenadas as interfaces dos DAOs da aplicao. br.gov.demoiselle.projeto.persistence.dao.filter Pacote onde sero armazenadas as classes dos filtros de dados da aplicao. br.gov.demoiselle.projeto.persistence.dao.implementation Pacote onde sero armazenadas as implementaes dos DAOs da aplicao. br.gov.demoiselle.projeto.view.managedbean Pacote onde sero armazenadas as implementaes dos Managed Beans da aplicao. b br.gov.demoiselle.projeto.view.report Pacote onde sero armazenadas as implementaes dos relatrios da aplicao. A seguir a descrio de alguns diretrios e arquivos de configurao da aplicao. Nome do Arquivo/Diretrio framework.properties Descrio Este arquivo contm variveis de configurao do projeto, ele pode ser editado atravs do wizard "Configurar projeto" do Wizard. Finalidade Arquivo de configurao do projeto

Nome do Arquivo/Diretrio src/main/resources/hibernate.cfg.xml Descrio

Finalidade Arquivo de configurao do Hibernate


8

Manual Demoiselle Wizard CETEC

Este arquivo contm as variveis de configurao do Hibernate, ele tambm ser editado atravs do wizard "Configurar projeto" do Wizard. Nome do Arquivo/Diretrio src/main/resources/hbm Descrio Este diretrio ir armazenar os arquivos de mapeamento HBM do Hibernate, isso se a aplicao utilizar HBM, caso contrrio este diretrio no ser utilizado. Nome do Arquivo/Diretrio Descrio Este arquivo contm todas as informaes sobre os Managed Beans e as regras de navegao. Ser editado ao longo da fase "Editar projeto". Finalidade Finalidade Diretrio de configurao do Hibernate

src/main/webapp/WEB-INF/faces-config.xml Arquivo de configurao JSF

Nome do Arquivo/Diretrio src/main/webapp/WEB-INF/web.xml Descrio

Finalidade Arquivo de configurao da aplicao WEB

Este arquivo possui informaes de como a aplicao Web dever se comportar, ele j vem pr configurado e recomenda-se somente aos usurios mais experiente alter-lo. Nome do Arquivo/Diretrio .demoiselle.xml Descrio Este arquivo possui informaes de configurao do Wizard. Finalidade Arquivo de configurao do Wizard

Nome do Arquivo/Diretrio pom.xml Descrio

Finalidade Arquivo de configurao do Maven

Este arquivo possui informaes de configurao do Maven.

Manual Demoiselle Wizard CETEC

2.Configurar Projeto
Neste Item do Wizard o usurio poder escolher e editar as configuraes bsicas do projeto, as informaes para a conexo do Hibernate e cadastrar as mensagens do projeto. Segue adiante a explicao deste mecanismo de funcionamento do Wizard e em seguida links para as explicaes de ambas as telas. A funcionalidade ativada pelo menu de projeto do Eclipse, selecionando o projeto e clicando com o boto direito do mouse. Demoiselle Configurar projeto.

10

Manual Demoiselle Wizard CETEC

22.1. Aba Configurao. C O Framework Demoiselle oferece ao desenvolvedor mecanismos que facilitam a manuteno de variveis de configurao da aplicao. Para auxiliar, o Wizard oferece suporte na criao e edio destas variveis (exceto as variveis de sistema). O Wizard busca no projeto as classes que implementam a interface IConfig (vide manual do Demoiselle) e disponibiliza para alterao as variveis destas classes.

Figura 2.1 - Tela de Configurao das variveis do projeto


2.1.1. Descrio dos Campos

Classes de configurao: O campo indica qual classe que implementa IConfig ter suas variveis editadas. Propriedades: A tabela propriedades lista todas as variveis da classe que esto anotadas por @ConfigKey. Clicando duas vezes na linha referente a propriedade, o usurio pode alterar o valor desta varivel.

2.1.2. Descrio das Alteraes

Ao final das operaes, o Plugin ir criar ou alterar as propriedades nos arquivos xml ou properties.

11

Manual Demoiselle Wizard CETEC

2.2. Configuraes do Hibernate

Ir criar ou configurar os arquivos necessrios para uso do Hibernate como camada de persistncia.

Figura 2.2 - Tela de Configurao do Hibernate 2.2.1. Descrio dos Campos

Conexo: O campo tipo de conexo define o modo que a aplicao ir acessar o banco de dados, existe dois tipos de acesso, via Data Source e via Driver, os demais campos da aplicao estaro disponveis conforme a escolha deste. Show SQL: O campo Show SQL indica se o Hibernate deve logar ou no os SQLs executados no banco. Format SQL: O campo Format SQL indica se o Hibernate deve formatar ou no os SQLs executados no banco. Banco de Dados: O campo Banco de Dados indica qual o banco ser acessado pelo Hibernate. Os tipos so pr-definidos, caso o usurio deseje incluir algum outro deve contatar a equipe responsvel pelo Demoiselle. Nome do Data Source: O campo Nome do Data Source indica o Alias do Data
12

Manual Demoiselle Wizard CETEC

Source que ser utilizado. Este campo s estar disponvel se o tipo de conexo for Data Source. Dialect: O campo Dialect indica qual o dialeto ser utilizado para acessar o banco de dados. Este campo somente leitura, ele ser preenchido de acordo com o Banco de Dados selecionado. URL: Tambm disponvel somente no tipo Driver, a URL indica o caminho do banco de dados da aplicao. Para cada banco de dados cadastrado existe uma URL padro na qual o usurio deve trocar os campos: BD_APLICACAO e localhost (se no for acessar um banco local). Usurio: O campo usurio define o login da aplicao no banco de dados. Somente para o tipo driver. Senha: O campo senha define a senha do usurio da aplicao no banco de dados. Somente para o tipo driver. Auto update HBM: O campo auto update indica se o Hibernate ir atualizar automaticamente o banco de dados de acordo com mudanas no mapeamento cadastrado. Tabela de mapeamento de Hibernate: H dois tipos de mapeamento do Hibernate, um via HBM e outro via anotaes nos POJOs. O primeiro modo aparece automaticamente todas as opes na tabela, devendo o usurio marcar os HBMs necessrios. Os POJOs devem ser inseridos atravs do boto Adicionar POJO. Para remover qualquer item basta retirar o check da primeira coluna.

2.2.2. Descrio das alteraes

Ao salvar as alteraes o Wizard ir editar o arquivo de configurao do Hibernate com as alteraes feitas pelo usurio.

13

Manual Demoiselle Wizard CETEC

32.3. JPA (Java Persistence API) A tela de configurao do JPA dividida em trs partes, so elas: Lista de Persistence Units j cadastradas; os botes adicionar, remover e editar; e a rea de edio da Persistence Unit. Clicando em algum item da lista de Pus, o usurio poder observar, na rea de edio, os dados da Persistence Unit selecionada e caso tenha a necessidade de alterar algo dever iniciar a edio deste clicando no boto Editar. A adio e remoo de Persistence Units so feitas atravs dos botes Adicionar e Remover respectivamente. aps o trmino da adio/edio/remoo das Persistence Units o usurio dever salvar as alteraes (boto Salvar da rea de edio) ou cancelar (boto Cancelar da rea de edio). e

Figura 2.3 - Tela de Configurao do JPA 2.3.1. Descrio dos campos


Nome O campo nome indica o nome da Persistence Unit a ser criada/editada. Provider O campo Provider abre as opes de implementao JPA para a Persistence Unit a ser criada/editada. O Wizard prove suporte aos seguintes Providers: "JPA Provider", Hibernate Provider e "Oracle Toplink Provider"
14

Manual Demoiselle Wizard CETEC

Tipo O campo tipo indica o tipo da Persistence Unit a ser criada/editada. As opes so: JTA ou Recurso Local Data Source O campo Data Source (opcional) indica o nome do Data Source associado a Persistence Unit a ser criada/editada. O no preenchimento deste campo indicar que a PU no possui Data Source. Propriedades A Tabela Propriedades indica todas as tuplas chave, valor das propriedades que sero cadastradas para cada PU. Tabela de mapeamento de Hibernate H dois tipos de mapeamento do JPA, um via resources e outro via classes Pojos anotadas. O primeiro modo aparece automaticamente todas as opes na tabela, devendo o usurio marcar os recursos necessrios. Os Pojos devem ser inseridos atravs do boto Adicionar Pojo. Para remover qualquer item basta retirar o check da primeira coluna.

2.3.1. Descrio das alteraes

Ao salvar as alteraes, o Wizard ir editar o arquivo de configurao do JPA com as alteraes feitas pelo usurio.

15

Manual Demoiselle Wizard CETEC

42.4. Cadastro de Mensagens As mensagens da aplicao so armazenadas em classes do tipo enum. Existem trs tipos de mensagens: de Erro; Informao; ou de Erro Fatal. Para cada tipo, existir uma classe associada e todas as mensagens do tipo sero armazenadas nesta classe. A figura 2.3 exibe a tela de cadastro.

Figura 2.4 Tela de Cadastro de Mensagens Conforme podemos observar na figura 2.4, a tela de Mensagem dividida em trs partes, so elas: Lista das Mensagens j cadastradas; os botes adicionar, remover e editar; e a rea de edio da Mensagem. Clicando em algum item da lista de Mensagens, o usurio poder observar, na rea de edio, os dados da Mensagem selecionada e caso tenha a necessidade de alterar algo dever iniciar a edio desta clicando no boto Editar. A adio e remoo de Excees so feitas atravs dos botes Adicionar e Remover, respectivamente. Aps o trmino da adio/edio das Excees, o usurio dever salvar as alteraes (boto Salvar da rea de edio) ou cancelar (boto Cancelar da rea de edio). O campo pacote indicar onde o pacote onde sero criadas as classes que iro armazenar as mensagens. Como sugesto, o framework traz o pacote: br.gov.demoiselle.projeto.message". IMPORTANTE : Todas as alteraes feitas s sero aplicadas aps o usurio clicar no
16

Manual Demoiselle Wizard CETEC

boto aplicar da tela principal ou no boto Finish do wizard. Aps a edio das Mensagens, a seguinte mensagem dever aparecer na tela: "Mensagens cadastradas com sucesso.

2.4.1. Descrio dos Campos

Nome O campo nome serve para identificar a mensagem na classe.


Mensagem O campo mensagem o contedo da mensagem. Tipo O campo tipo da mensagem identifica qual a severidade da mensagem (ERROR; FATAL; ou INFO).

2.4.2. Descrio das Alteraes

Ao salvar as alteraes, o Plugin ir criar ou editar a(s) classe(s) que possui(em) alguma mensagem associada. As classes tero os seguintes nomes: ErrorMessage, FatalMessage e InfoMessage e sempre implementam a interface IMessage.

17

Manual Demoiselle Wizard CETEC

3. Editar Projeto
Esta funcionalidade auxilia na edio do projeto permitindo desenvolver as camadas da aplicao de acordo com o padro Demoiselle. O processo comea na camada DAO e passa pelo Business Controller, Managed Bean, Regras de Navegao, as Fachadas at chegar aos testes unitrios.

Ativando o Meno de Edio do Projeto. 3.1. Gerao de DAOs Aps a configurao do projeto e a criao dos POJOs e mapeamentos (ver Manual do Framework), o usurio est apto a cadastrar as classes da camada DAO (Data Access O Object).

Figura 3.1 Tela de Criao de DAOs


18

Manual Demoiselle Wizard CETEC

Conforme podemos observar na figura acima, a tela de DAO dividida em trs partes, so elas: Lista de DAOs j cadastrados; os botes adicionar, remover e editar; e a rea de edio do DAO. Clicando em algum item da lista de DAOs, o usurio poder observar, na rea de edio, os dados do DAO selecionado e caso tenha a necessidade de alterar algo dever iniciar a edio deste clicando no boto Editar. A adio e remoo de DAOs so feitas atravs dos botes Adicionar e Remover, respectivamente. Aps o trmino da adio/edio/remoo dos DAOs, o usurio dever salvar as alteraes (boto Salvar da rea de edio) ou cancelar (boto Cancelar da rea de edio). IMPORTANTE : Todas as alteraes feitas s sero aplicadas aps o usurio clicar no boto aplicar da tela principal ou no boto Finish do Wizard. Aps a edio dos DAOs, a seguinte mensagem dever aparecer na tela: "DAOs editados com sucesso."

3.1.1. Descrio dos Campos

Pacote Para selecionar o pacote que o DAO ser criado o usurio deve clicar no boto Pesquisar e selecion-lo na tela de seleo de pacotes similar a exibida na figura 3.2.

Figura 3.2 Seleo de Pacote


19

Manual Demoiselle Wizard CETEC

POJO Para selecionar o POJO que o DAO utilizar ser criado o usurio deve clicar no boto Pesquisar e selecion-lo na tela de seleo de POJOs similar a exibida na figura 3.3.

Figura 3.3 Seleo de POJO

Tipo O campo tipo ir definir o tipo de implementao do DAO, as opes so: Hibernate, JDBC e Adabas.

3.1.2. Descrio das Alteraes

Ao salvar as alteraes o Plugin ir criar as interfaces e implementaes dos DAOS editados/criados de acordo com o tipo selecionado.

20

Manual Demoiselle Wizard CETEC

Figura 3.4 Interface gerada para o POJO Aluno

Figura 3.5 Implementao gerada para o POJO Aluno e tipo Hibernate

21

Manual Demoiselle Wizard CETEC

3.2. Gerao de Business Controllers Aps a configurao do projeto, a criao dos POJOs e mapeamentos (ver Manual do Demoiselle) e a criao dos DAOs do projeto, o usurio est apto a cadastrar as classes da camada Business Controller.

Figura 3.6 Tela de Cadastro de Business Controllers Conforme podemos observar na figura 3.6, a tela de Business Controller dividida em trs partes, so elas: Lista de Business Controllers j cadastrados; os botes adicionar, remover e editar; e a rea de edio do Business Controller. Clicando em algum item da lista de Business Controllers ,o usurio poder observar, na rea de edio, os dados do Business Controller selecionado e caso tenha a necessidade de alterar algo dever iniciar a edio deste clicando no boto Editar. A adio e remoo de Business Controllers so feitas atravs dos botes Adicionar e Remover respectivamente. aps o trmino da adio/edio/remoo dos Business Controllers, o usurio dever salvar as alteraes (boto Salvar da rea de edio) ou c cancelar (boto Cancelar da rea de edio). IMPORTANTE : Todas as alteraes feitas s sero aplicadas aps o usurio clicar no
22

Manual Demoiselle Wizard CETEC

boto aplicar da tela principal ou no boto Finish do wizard. Aps a edio dos Business Controllers, a seguinte mensagem dever aparecer na tela: "Business Controllers editados com sucesso."
3.2.1. Descrio dos Campos

Pacote de constantes: Este campo identifica o pacote onde ser gravado a classe (AliasNavigationRule.java) que conter o conjunto de constantes que, identifica todos os casos de navegao existentes. Estas constantes sero utilizadas no cadastro dos mtodos do Managed Bean. Identificador da Regra de Navegao: Este campo identifica o conjunto de casos de navegao cadastrados nos campos abaixo. Casos de Navegao: O grupo Casos de navegao ir definir todas as possveis pginas de sada para a regra. Identificador: Este campo o identificador do caso de navegao, atravs dele que o framework identifica qual caso de navegao foi selecionado nas aes do usurio. Pgina de Destino: O campo pgina de destino define qual a pgina que ser executada se o caso de navegao for selecionado aps a execuo da regra de Navegao.

3.2.2. Descrio das Alteraes

Ao salvar as alteraes, o Plugin ir editar o arquivo de configurao JSF na rea de Regras de Navegao.

23

Manual Demoiselle Wizard CETEC

3.3. Gerao de Regras de Navegao. A tela de Navegao dividida em trs partes, so elas: Lista das Regras de Navegao j cadastradas; os botes adicionar, remover e editar; e a rea de edio das Regras. Clicando em algum item da lista, o usurio poder observar, na rea de edio, os dados da Regra selecionada e caso tenha a necessidade de alterar algo dever iniciar a edio deste clicando no boto Editar. A adio e remoo das Regras de Navegao so feitas atravs dos botes Adicionar e Remover respectivamente. aps o trmino da adio/edio/remoo das Regras de Navegao, o usurio dever salvar as alteraes (boto Salvar da rea de edio) ou cancelar (boto Cancelar da rea de edio)

Tela de Cadastro de Regras de Navegao IMPORTANTE : Todas as alteraes feitas s sero aplicadas aps o usurio clicar no boto aplicar da tela principal ou no boto Finish do wizard. Aps a edio das Regras de Navegao, a seguinte mensagem dever aparecer na tela: "Regras de Navegao cadastradas com sucesso."

24

Manual Demoiselle Wizard CETEC

3.3.1. Descrio dos Campos

Pacote de constantes Este campo identifica o pacote onde ser gravado a classe (AliasNavigationRule.java) que conter o conjunto de constantes que identificam todos os casos de navegao existentes. Estas constantes sero utilizadas no cadastro dos mtodos do Managed Bean.

Identificador da Regra de Navegao Este campo identifica o conjunto de casos de navegao cadastrados nos campos abaixo. Casos de Navegao O grupo Casos de navegao ir definir todas as possveis pginas de sada para a regra.

Identificador Este campo o identificador do caso de navegao, atravs dele que o framework identifica qual caso de navegao foi selecionado nas aes do usurio. Pgina de Destino O campo pgina de destino define qual a pgina que ser executada se o caso de navegao for selecionado aps a execuo da regra de Navegao.

3.3.2. Descrio das Alteraes Ao salvar as alteraes, o Plugin ir editar o arquivo de configurao JSF na rea de Regras de Navegao.

25

Manual Demoiselle Wizard CETEC

3.4. Gerao de Managed Beans Aps a criao dos Business Controllers e das Regras de navegao, o usurio est apto a cadastrar as classes da camada Managed Bean.

Figura 3.4 - Tela de Cadastro de Managed Beans Conforme podemos observar na figura 3.4, a tela de Managed Bean dividida em trs partes, so elas: Lista de Managed Beans j cadastrados; os botes adicionar, remover e editar; e a rea de edio do Managed Bean. Clicando em algum item da lista de Managed Beans o usurio poder observar, na rea de edio, os dados do Managed Bean selecionado e caso tenha a necessidade de alterar algo dever iniciar a edio deste clicando no boto Editar. A adio e remoo de Managed Beans so feitas atravs dos botes Adicionar e Remover respectivamente. aps o trmino da adio/edio/remoo dos Managed Beans o usurio dever salvar as alteraes (boto Salvar da rea de edio) ou cancelar (boto Cancelar da rea de edio).
26

Manual Demoiselle Wizard CETEC

IMPORTANTE : Todas as alteraes feitas s sero aplicadas aps o usurio clicar no boto aplicar da tela principal ou no boto Finish do wizard. Aps a edio dos Managed Beans, a seguinte mensagem dever aparecer na tela: "Managed Beans editados com sucesso."

3.4.1. Descrio dos Campos


Nome: O campo nome indica o nome do Managed Bean a ser criado/editado. Pacote: Para selecionar o pacote que o Managed Bean ser criado o usurio deve clicar no boto Pesquisar e selecion-lo na tela de seleo de pacotes similar a exibida na figura 3.8. Nome da varivel O campo nome da varivel indica a varivel que ser criada e colocada no escopo para o Managed Bean ser utilizado nas pginas da aplicao. Escopo O campo escopo indica o tipo de escopo do Managed Bean, as opes so: application, request e session. Business Controller O campo Business Controller indicar qual a Interface BC que o Managed Bean ir acessar. Este campo opcional. POJOs Para selecionar e inserir os POJOs que o Managed Bean utilizar, o usurio deve clicar no boto Pesquisar, selecion-lo na tela de seleo de POJOs similar a exibida na figura 3.9 e depois incluir o POJO. Para remover algum POJO basta selecion-lo e clicar no boto Remover. Aes: Para inserir, editar e remover as aes do Managed Beans basta clicar nos botes de controle ao lado da tabela e selecionar o nome da ao e o retorno desta no popup que ir abrir na tela.

Figura 3.8 Seleo de Pacote


27

Manual Demoiselle Wizard CETEC

Figura 3.9 Seleo de POJO


3.4.2. Descrio das Alteraes

Ao aplicar as alteraes o Plugin ir editar o arquivo de configurao JSF na rea de managed beans com as alteraes feitas pelo usurio. Alm disso o plugin criar as classes dos Managed Beans editados/criados.

Figura 3.10 Classe gerada para o POJO Aluno


28

Manual Demoiselle Wizard CETEC

3.5. Gerao de Fachadas Aps a criao dos Business Controllers, o usurio tambm estar apto a cadastrar classes do tipo Fachada.

Figura 3.11 Tela de Cadastro de Fachadas Conforme podemos observar na figura acima, a tela de Fachadas dividida em trs partes, sendo elas: Lista de Fachadas j cadastrados; os botes adicionar, remover e editar; e a rea de edio da fachada. Clicando em algum item da lista de Fachadas o usurio poder observar, na rea de edio, os dados da Fachada selecionado e caso tenha a necessidade de alterar algo dever iniciar a edio deste clicando no boto Editar. A adio e remoo de Fachadas so feitas atravs dos botes Adicionar e Remover respectivamente. aps o trmino da adio/edio/remoo dos Fachadas o usurio dever salvar as alteraes (boto Salvar da rea de edio) ou cancelar (boto Cancelar da rea de edio).
29

Manual Demoiselle Wizard CETEC

IMPORTANTE : Todas as alteraes feitas s sero aplicadas aps o usurio clicar no boto aplicar da tela principal ou no boto Finish do wizard. Aps a edio das Fachada, a seguinte mensagem dever aparecer na tela: "Fachada editadas com sucesso."

3.5.1. Descrio dos Campos


Nome : O campo nome indica o nome da classe Fachada a ser criada/editada. Pacote: Para selecionar o pacote onde a Fachada ser criado o usurio deve clicar no boto Pesquisar e selecion-lo na tela de seleo de pacotes similar a exibida na figura 3.12.

Figura 3.12 Seleo de Pacote

Business Controller: O campo Business Controller indicar qual a interface BC que a Fachada ir acessar. Este campo opcional.

3.5.2. Descrio das Alteraes

Ao aplicar as alteraes o Plugin ir criar as classes das Fachadas editadas/criadas.

30

Manual Demoiselle Wizard CETEC

Figura 3.13 Fachada gerada para o BC Aluno

31

Manual Demoiselle Wizard CETEC

3.6. Gerao de Testes Unitrios Aps a configurao do projeto, a criao dos Pojos e mapeamentos (ver Manual do Demoiselle) e a criao das diversas camadas da aplicao, o usurio deve desenvolver os Testes Unitrios para estas diversas classes do sistema. Para isso o Wizard prove uma funcionalidade que ir gerar estes testes de acordo com a Interface da camada a ser testada no padro do componente Junit (http://www.junit.org/).

Tela de Cadastro de Testes Unitrios Conforme podemos observar na figura acima, a tela de Testes Unitrios dividida em trs partes, so elas: Lista de Testes Unitrios j cadastrados; os botes adicionar e remover; e a rea de edio do Teste Unitrio. Clicando em algum item da lista de Testes Unitrios o usurio poder observar, na rea de edio, os dados do Teste Unitrio selecionado. A adio e remoo de Testes Unitrios so feitas atravs dos botes Adicionar e Remover respectivamente, aps o trmino da adio/remoo dos Testes Unitrios o usurio dever salvar as alteraes (boto Salvar da rea de edio) ou cancelar (boto Cancelar da rea de edio).

32

Manual Demoiselle Wizard CETEC

3.6.1. Descrio dos Campos

Tipo de Interface O campo tipo de Interface indica qual a camada alvo para a criao dos testes. As opes so: DAO, Busines Controller, Managed Bean e Faade

Classe Alvo para gerao dos testes Selecionar, atravs do boto pesquisar qual Interface servir de base para a gerao da classe de testes.

3.6.2. Descrio das Alteraes

Ao salvar as alteraes, o Plugin ir criar as classes no diretrio padro de testes (src/test/java) com a mesma estrutura de pacote da classe base.

33

Manual Demoiselle Wizard CETEC

3.7. Criar pginas A criao das pginas da aplicao tem dois requisitos: Os POJOs que sero utilizados e o Managed Bean da entidade. O wizard possui dois passos, o primeiro, o usurio seleciona o local das pginas e quais os tipos de pginas que sero cadastradas, no segundo passo o usurio dever preencher os diversos campos de cada pgina antes de ger-las. A seguir, na figura 3.14 a primeira tela do wizard e as caixas de opes links para as demais. Aps o segundo passo, o usurio dever clicar no boto Finish para criar as pginas ou em Cancelar, para cancelar a operao sem nenhuma alterao.
3.7.1. Descrio dos Campos

Diretrio: Para selecionar o diretrio onde as pginas sero criadas o usurio deve clicar no boto Pesquisar e selecion-lo na tela de seleo de diretrios similar a exibida na figura 3.15. Modelos: Selecionar os tipos de pginas que sero criadas, as opes so: Pgina de listagem, Pgina de visualizao, Pgina de edio. O usurio deve selecionar pelo menos um modelo para continuar a criao das pginas.

Figura 3.14 Tela de seleo das pginas

34

Manual Demoiselle Wizard CETEC

Figura 3.15 Seleo de Diretrio


3.7.2. Cadastro da Pgina de Listagem

Ao selecionar na tela inicial o modelo "Listagem" e passar para a prxima tela, esta possuir uma aba para o cadastro da pgina de Listagem, vide figura 3.16. O usurio dever definir o Managed Bean e o nome da pgina (campos obrigatrios), este ltimo dever possuir a extenso ".jsp". Os demais itens no so obrigatrios mas devero ser preenchidos para o correto funcionamento da pgina que ser criada.

35

Manual Demoiselle Wizard CETEC

Figura 3.16 Tela de Cadastro da Pgina de Listagem


3.7.2.1. Descrio dos Campos

Nome do arquivo: O campo nome do arquivo dever conter uma sequencia de caracteres vlidos para nome de arquivo, se a extenso no for informada ser assumido ".xhtml". Managed Bean : Para selecionar o managed bean que a pgina estar associada basta clicar no boto Pesquisar e selecion-lo. POJO: O campo POJO indica qual a varivel ser utilizada na iterao da pgina. Filtros: O grupo Filtros definir quais campos dos objetos do Managed Bean sero filtros da pesquisa. Campo : Nome do campo que ser filtro. Rtulo: Rtulo que aparecer na pgina identificando o filtro. Tipo: Tipo do campo, as opes so: calendar: Campo de edio seguido de um boto que exibe um calendrio para o usurio selecionar a data. inputText: Campo de edio. inputHidden: Campo oculto. selectOneMenu: Combo com vrios itens para o usurio selecionar um. selectOneRadio: Grupo de itens para o usurio selecionar
36

Manual Demoiselle Wizard CETEC

um. selectManyCheckbox: Grupo de itens para o usurio selecionar vrios. outputText: Campo de visualizao. graphicImage: Imagem.

Colunas: O grupo Colunas definir quais as aes e os campos dos objetos do Managed Bean sero colunas na listagem de objetos que satisfizeram a pesquisa. Ao(Caixa de seleo): Indica se a coluna uma Ao (ex.: Exibir, alterar ou excluir) ou se um Campo vindo do Managed Bean. Ao: Nome da ao que representa a coluna. Somente quando a coluna for uma ao. Campo: Nome do campo que ser coluna. Somente quando a coluna no for uma ao. Rtulo: Rtulo que aparecer na tela identificando a coluna.

3.7.2.2. Descrio das Alteraes

Ao salvar as alteraes(boto Finish) o Plugin ir criar a pgina de listagem bem como as demais pginas selecionadas. 3 3.7.3. Cadastro da Pgina de Visualizao Ao selecionar na tela inicial o modelo "Visualizao" e passar para a prxima tela, esta possuir uma aba para o cadastro da pgina de Visualizao, vide figura 3.17. O usurio dever definir o Managed Bean e o nome da pgina (campos obrigatrios). Os demais itens no so obrigatrios, mas devero ser preenchidos para o correto funcionamento da pgina que ser criada.

37

M Manual Demoiselle Wizard CETEC

Figura 3.17 Tela de Cadastro da Pgina de Visualizao


3.7.3.1. Descrio dos Campos

Nome do arquivo O campo nome do arquivo dever conter uma sequencia de caracteres seguido da extenso ".jsp". Managed Bean Para selecionar o managed bean que a pgina estar associada basta clicar no boto Pesquisar e selecion-lo. Tipo de campo O Tipo do campo indica se todos os campos da tela sero do tipo OutPut (campo de visualizao) ou se ser do tipo InPut (campo de edio do tipo somente leitura) Campos O grupo Campos definir quais campos do objeto do Managed Bean sero exibidos na pgina. Campo Nome do campo que ser exibido. Rtulo Rtulo que aparecer na pgina identificando o campo. Detalhes O grupo Detalhes definir quais PropertyHelpers do Managed Bean tero um relacionamento de Mestre X Detalhe na pgina. Boto Remover Detalhe Remove o detalhe selecionado na tabela. Boto Editar Detalhe Para editar o detalhe selecionado na tabela, deve-se clicar neste boto, abrir uma tela para a seleo dos campos, colunas e detalhes do detalhe.

38

Manual Demoiselle Wizard CETEC

3.7.3.2. Descrio das Alteraes

Ao salvar as alteraes(boto Finish) o Plugin ir criar a pgina de visualizao bem como as demais pginas selecionadas.
3.7.4. Cadastro da Pgina de Edio

Ao selecionar na tela inicial o modelo "Edio" e passar para a prxima tela, esta possuir uma aba para o cadastro da pgina de Edio, vide figura 3.18. O usurio dever definir o Managed Bean e o nome da pgina (campos obrigatrios). Os demais itens no so obrigatrios mas devero ser preenchidos para o correto funcionamento da pgina que ser criada.

Figura 3.18 Tela de Cadastro da Pgina de Edio


3.7.4.1. Descrio dos Campos

Nome do arquivo O campo nome do arquivo dever conter uma sequencia de caracteres seguido da extenso ".jsp". Managed Bean Para selecionar o managed bean que a pgina estar associada basta clicar no boto Pesquisar e selecion-lo. Campos O grupo Campos definir quais campos do objeto do Managed Bean sero exibidos na pgina. Campo Nome do campo que ser exibido. Rtulo Rtulo que aparecer na pgina identificando o campo. Tipo Tipo do campo, as opes so: calendar: Campo de edio seguido de um boto que exibe um calendrio para o usurio selecionar a data.
39

Manual Demoiselle Wizard CETEC

inputText: Campo de edio. inputHidden: Campo oculto. selectOneMenu: Combo com vrios itens para o usurio selecionar um. selectOneRadio: Grupo de itens para o usurio selecionar um. selectManyCheckbox: Grupo de itens para o usurio selecionar vrios. outputText: Campo de visualizao. graphicImage: Imagem.

Detalhes O grupo Detalhes definir quais PropertyHelpers do Managed Bean tero um relacionamento de Mestre X Detalhe na pgina. Boto Remover Detalhe Remove o detalhe selecionado na tabela. Boto Editar Detalhe Para editar o detalhe selecionado na tabela, deve-se clicar neste boto, abrir uma tela para a seleo dos campos, colunas e detalhes do detalhe.

3.7.4.2. Descrio das Alteraes

Ao salvar as alteraes(boto Finish) o Plugin ir criar a pgina de edio bem como as demais pginas selecionadas.

4 Tutorial para uso No link link abaixo est disponvel um tutorial que demonstra o uso do Wizard para apoio ao desenvolvimento de uma aplicao no padro Demoiselle. http://www.frameworkdemoiselle.gov.br/menu/framework/manuais-e-tutoriais

40