Figura C13.1. Diagrama de Casos de Uso para UC004 Registrar Proventos e Descontos!.

Transcrição

1 A6Implementando o Padrão "Manter Coleção" Capítulo 13 Implementação o Caso de Uso UC004 Registrar Proventos e Descontos! - Analisando a Especificação Analisando o estereótipo do Caso de Uso da especificação da Erro! Fonte de referência não encontrada. vemos que, como no caso anterior, neste também desenvolveremos uma solução de manutenção de nível secundário, ou seja, voltada para a manutenção de objetos que participam como Detalhes em uma Agregação, mas não são persistidos na mesma transação que o objeto Raiz/Mestre. Neste caso específico, deveremos manter objetos da classe ProventoDesconto, que por sua vez participa da Agregação de Funcionario. Esta classe Raiz e outras da sua Agregação foram mantidas pelo Caso de Uso Padrão primário "Manter Agregação Mestre/Detalhe", no capítulo 8. Figura C13.1. Diagrama de Casos de Uso para UC004 Registrar Proventos e Descontos!. No caso anterior, optamos por separar a manutenção das classes Uf e Municipio em dois Casos de Uso Padrões para reutilizar as vantagens de caching e da entrada tabular do padrão Manter Classe - porque a população da classe Raiz/Mestre Uf era pequena e estável. Neste novo caso, as motivações são outras:

2 Capítulo C13 o o Os proventos e descontos do Funcionário são eventos registrados por pessoas distintas (Ator FolhaPagamento ) e em momentos distintos. A entrada de dados de descontos e proventos é realizada em lote, através de digitadores que partem de um pré-registro em papel, contendo o CPF de um funcionário, o número de dias trabalhados, valores de proventos e descontos extras, no período (mês) de trabalho. Perceba que projetar ProventoDesconto como uma composição Mestre/Detalhe seria possível, mas implicaria em uma associação OneToMany perigosa e desnecessária entre Funcionario" e ProventoDesconto. Esta associação implicaria em uma navegação que provocaria uma recuperação progressivamente maior de objetos de ProventoDesconto, ao longo do tempo, quando recuperássemos Funcionário. A especificação de ProventoDesconto sem o estereótipo plcdetalhe tem objetivo claro de evitar este risco - ela reforça a característica unidirecional de navegação, de ProventoDesconto para Funcionario. Por todos estes motivos, o projetista optou por indicar o uso de um outro padrão de manutenção também secundário, mas diferente do anterior, chamado Manter Coleção. - Obtendo Classes de Domínio em Java A classe ProventoDesconto e pode ser obtida do diretório jcompany_documentacao/rhtutorial/proventodesconto. Copie-as para o diretório de entidades no projeto rhtutorial_comuns criando um novo pacote em src/main/java/com/empresa/rhtutorial/entity/proventodesconto. - Gerando Mapeamento para Classe - Objeto-Relacional V 1. Edite a classe ProventoDesconto.java e aperte Control+N para acionar as opções de plugins. 2. Selecione 01 Mapeamento Objeto-Relacional. As informações importantes para o caso do mapeamento de ProventoDesconto se encontram na Figura C13.2. Figura C13.2. Mapeamento Objeto-Relacional para ProventoDesconto. #1. Informe o estereótipo "Tabular" neste caso para a classe de ProventoDesconto. Ela na verdade deve tem estereótipo conceitual <<plccolecao>> mas o plugin de geração de mapeamento tem funcionamento similar ao "Tabular". #2. O tamanho para nossa data será 8, para incluir os 7 (sete) caracteres MM/AAAA e ainda prover um espaço adicinoal para uma melhor visualização. (Pode-se utilizar exatamente 7 e verificar como se comporta, ajustando o CSS se necessário). #3. Note que o primeiro campo do tipo String é assumido como o campo de referência (tostring) da classe. Ele deve ter 40 caracteres. #4. Lembre-se de informar 8 em naturezaproventodesconto, uma vez que os valores de Enumeração que usamos tem um máximo de 8 caracteres. #5. Um valor com casas decimais pode ser informado em campos BigDecimal como "valor".

3 Implementando o Padrão Manter Coleção - Implementando Validações Invariáveis de Domínio Validação de Entrada IV Após a geração do mapeamento Objeto-Relacional, devemos implementar as restrições invariáveis. 1. anomesreferencia: A primeira é a restrição invariável em nível do Domínio para anomesreferencia. Esta data deve agora respeitar a máscara MM/AAAA (somente parte mês e ano visível para usuários) e, por este motivo, também não ter complemento temporal. Deve ainda ser igual ou menor que a data atual (no passado). O anomesreferencia será coletado apenas com a sua parte "mês" e "ano" no formulário, graças ao atributo riausa que utilizaremos. Porém, quando chegar à Entidade, já estará convertido para uma data válida completa, do tipo "java.util.date", com "01" assumido no dia. Ex.: um valor informado 02/2008 chegará como data com valor 01/02/ :00: Por este motivo, não faria sentido validar máscara para esta data na Entidade - ela sempre seria correta. Mas em alguns casos pode-se julgar compensador validar se o dia é realmente "01". Há cenários onde pode ser importante ter o dia exatamente registrado como "01", e não como um aleatório qualquer, e esta validação pode ser uma garantia dupla quanto a eventuais erros em componentes visuais. Em casos como este, cujos tratamentos são para erros potenciais de programação, é recomendável que se encapsule a regra na implementação concreta da Entidade ( ProventoDescontoEntity ), e não na abstração de negócio ( ProventoDesconto ). Deixamos a mensagem também sem i18n neste caso, como exemplo (pode ser aceitável por ser um erro "interno"). Veja exemplo na Figura C13.3. Figura C13.3. Validação de mais "baixo nível", incluída na implementação concreta. Agora, garanta quanto à validação de "data no passado" e parte temporal, com as anotações que já vimos anteriormente. Figura C13.4. Data no passado sem parte temporal (horas). 2. Proventos/Descontos calculados: Poderíamos usar uma assertiva de validação na classe de domínio para a restrição de que o usuário não deva informar um proventodesconto para os tipos IR e SF. Porém, desta forma, mesmo o cálculo automático que faremos seria impedido de preenchê-los. O que precisamos aqui é de impedir que o usuário informe valores para estes tipos, mas permitir que o sistema os calcule. Como proceder neste caso? o o Uma saída seria programar esta regra em classes de Controle ou Serviço, como uma validação "variável", ou seja, que depende "do Caso de Uso", ao contrários da validações "invariáveis", que não dependem e estão em nível "do Domínio". Mas deste modo deslocamos algumas regras para classes de controle e outras para classes de domínio - e também não teremos condições de usar o padrão Bean Validation (BV) que atua no nível das entidades. Uma técnica é criar uma variável transiente na entidade, para informar para esta classe quem está realizando o cálculo e utilizá-la na validação. Defina uma propriedade transiente "calculofolha", do tipo boolean, iniciada com false. Esta propriedade terá somente "setter" para que a rotina do cálculo da folha a modifique quando estiver atuando. Veja como fica então a declaração e a assertiva, que pode desta vez ficar no ancestral abstrato "ProventoDesconto" (pois é uma regra de negócio):

4 Capítulo C13 Figura C13.5. Declaração de auxiliar transiente (deve ter apenas um setter). Figura C13.6. Assertiva de validação com uso de transiente e mensagem respectiva 3. Máximo de Valor para um tipo de Provento/Desconto. A última restrição invariável é uma condicional. O valor não pode ser maior que uma constante (que vale 22,00) caso a natureza seja DT (Dias Trabalhados). Para este caso, não há novidades, precisaremos programar outra assertiva como na Figura C13.7. Figura C13.7. Validação de valor máximo para natureza DT. - Gerando Artefatos para Colaboração plccrudtabular Para produzir uma Colaboração que implemente o Caso de Uso do tipo Manter Coleção, precisaremos partir de uma implementação do tipo Manter Classe e fazer ajustes manuais, já que não há ainda gerador específico para este padrão. 1. Chame o roteiro Cheat-Sheet para Manter Classe e preencha o assistente como nas figuras que se seguem. Obs.: perceba que é assumido "proventodesconto" (sem maiúsculas) para a URL, pois uso de "case sensitive" não é considerado uma boa prática para este caso. Já no caso do diretório, é assumido o conhecido "camel case" (iniciais das segundas palavras em maísculos) do Java. Figura C13.8. Primeiro passo do Assistente de Criação Manter Classe para ProventoDesconto (Selecionar a classe ProventoDescontoEntity caso tenha gerado com descendente, caso contrário escolha ProventoDesconto).

5 Implementando o Padrão Manter Coleção Figura C13.9. Segundo passo do Assistente de Criação Manter Classe para ProventoDesconto. Figura C Terceiro passo do Assistente de Criação Manter Classe para ProventoDesconto. - Ajustando a página de detalhes para o novo padrão 1. Edite a página "proventodesconto.xhtml" e verifique sua estrutura, similar à que geramos para "uf.xhtml", utilizando o leiaute básico "PlcGeralTemplate.xhtml", conforme a Figura C Figura C Conferindo página XHTML produzida para Proventos e Descontos. Para este padrão, teremos apenas que modificar esta página para conter uma seção de argumentos.

6 Capítulo C13 - Criando página de argumentos manualmente Edição de Camada Visão VI Agora, vamos definir uma nova seção de argumento que vai nos permitir informar cpf e anomesreferencia em um cabeçalho, de modo a evitar repetirmos estes valoers em cada linha de entrada. Um argumento trará o nome do funcionário a partir do seu CPF informado, como definido no projeto de interface da Figura C Para isso, a melhor maneira será partir de uma página existente que contenha uma seção de argumentos, como funcionariosel.xhtml. Copie uma linha da seção de argumentos (envolta por um "div" cujo id tem sufixo "Arg" e cole no início de proventodesconto.xhtml, após a tag '<ui:define name="plc-corpo-formulario">' como ponto de partida. 2. Feche as tags de linha, tabela e div e modifique os argumentos manualmente, usando um "plcf:vinculado" para o "cpf", conforme exemplo da Figura C Figura C Página para formulário "Ctb <<plccrudtabular>>" do Caso de Uso Manter Coleção. #1. Este padrão de formulário é implementado em página única que contém um cabeçalho e uma lista de itens. #2. Substitua o título de argumentos por um texto mais significativo #3. Componente vinculado utilizado para cpf e nome do funcionário. Este componente foi utilizado porque possui a facilidade de recuperação de um objeto a partir da digitação de valor para qualquer propriedade da classe vinculada, tal como o cpf. Ele nos atenderá para o caso do cpf recuperando o funcionário, bastando que declaremos a "autorecuperacaopropriedade" e também o "idtamanho", conforme a Erro! Fonte de referência não encontrada.. Importante também notar que declaramos um objeto para argumento com nome "proventodescontoarg", cujo método de criação teremos que declarar no ProventoDescontoMB, pois o mesmo não é utilizado no padrão "Manter Classe" utilizado para geração. #4. Componente de data com riausa utilizado para definir a máscara M9/Y999 e declaração de converter que converte o mês/ano para o formato da data (basicamente concatenando "01/" no dia). Este converter do jcompany também pode ser utilizado para formatos de ano com 2 dígitos, além dos 4 dígitos do exemplo. Importante: Note que também explicitamos o 'required="true"' nos dois campos de argumento. Neste caso eles são obrigatórios de serem informados pois seus valores são replicados (automaticamente) para os itens de manutenção 3. Para que a obrigatoriedade da informação dos campos de argumento funcione corretamente, o botão de pesquisa deve ser sobrescrito com a tag ui:define na pagina proventodesconto.xhtml, exemplo da Figura C

7 Implementando o Padrão Manter Coleção Figura C Botão pesquisar que será sobrescrito na pagina "proventodesconto.xhtml". Após ter modificado as páginas do caso de uso ProventoDesconto nós vamos inserir as chaves no arquivo "ApplicationResources_pt_BR.properties". A mensagem de título é exibida na Figura C Informe as demais de modo apropriado. Figura C Exemplo de mensagem i18n no arquivo "ApplicationResources_pt_BR.properties" - Modificando o padrão do formulário Vamos agora editar o metadado definido em ProventoDescontoMB para o padrão de formulário "Ctb" (CRUDTABULAR), utilizado no padrão de caso de uso "Manter Coleção" e também para conter tanto uma coleção de objetos (para serem gravados) quanto uma instância de objeto para servir de argumento. 1. Procure pelo arquivo ProventoDescontoMB.java em com.empresa.rhtutorial.controller.jsf.proventodesconto e modifique-o conforme a Figura C Figura C Alteração do padrão via metadado (anotação). #1. Trocar o padrão de formulário para "Ctb" (CRUDTABULAR). #2. Declarar as duas propriedades de argumento ou cabeçalho, na anotação "ctbheaderproperties". #3. Incluir também o produtor para Entidades auxiliares de argumento/cabeçalho. - Manipulando Formulários Dinamicamente - Javascript I Fizemos validações em nível das entidades de domínio, mas ainda assim é desejável implementar uma garantia em nível do formulário de que o usuário não irá informar valores para as naturezas IR e SALARIO. Esta validação local evitará que o mesmo realize submeta trabalhos inválidos para serem posteriormente validados no servidor. Vamos com isso aproveitar então para realizar uma primeira programação em Javascript...

8 Capítulo C13 1. Implemente o evento "onchange" do "comboestatico" da natureza, declarando uma chamada a uma função (ainda inexistente), passando índice do ítem (linha) do formulário, conforme abaixo. Figura C Declaração de evento Javascript com chamada para função local. 2. Em seguida declare uma seção script local à página (mas fora do laço de plcf:iteracao ), conforme a Figura C Figura C Função javascript que modifica o formulário dinamicamente. #1. Seção Javascript, fora do laço iteracao. #2. Declaração de função Javascript, recebendo a linha corrente. #3. Uso de função getvalorjsf, passando id do campo e a linha corrente. Esta função facilita a montagem do nome padrão do campo gerado em HTML pelo Apache Trinidad, especialmente quando usando iterações. Por exemplo, neste caso, o nome em HTML teria a seguinte anatomia padrão, para o campo naturezaproventodesconto na primeira linha: corpo:plclogicaitens:0:naturezaproventodesconto Ela também já devolve o valor informado no campo. #4. A função getobjetojsf trabalha de forma similar à anterior, mas devolve uma referência ao campo de formulário HTML, permitindo alterações de estilo dinamicamente. Em nosso caso, estamos escondendo os campos valor e descricao". Perceba a possibilidade ilimitada que se tem em mãos, podendo-se manipular estilos CSS dinamicamente. #5. A função setvalorjsf é análoga à getvalorjsf, mas para alterar um valor de um campo dinamicamente. #6. Neste caso, definimos uma mensagem internacionalizada, como exemplo de seu uso em Javascript. Lembre-se de incluir a mensagem abaixo no arquivo ApplicationResources.properties : rhtutorial.natureza.calculada=não informe lançamentos para esta natureza, pois ela é calculada automaticamente. #7. A última condição é para assumir valores default para descricao" e valor, se o usuário selecionar natureza DT. - Atualizando Esquema Relacional Geração de DDL IV 1. Faça agora uma liberação com reinício e vamos atualizar a nossa DDL.

9 Implementando o Padrão Manter Coleção 2. Retire os trechos de FK a desprezar, deixando somente os exibidos na Figura C Figura C Esquema DDL de atualização para ProventoDesconto. 3. Submeta a modificação. - Entendendo o que foi produzido Usabilidade XI 1. Chame a nova opção Proventos e Descontos. Ela nos enviará para um formulário com a aparência da Figura C Figura C Formulário para entrada de Proventos e Descontos, padrão Ctb" ou "<<plccrudtabular>>. 2. O primeiro campo de argumento recebe o CPF e recupera o nome do funcionário, utilizando a nossa NamedQuery. O segundo argumento recebe o período no formato MM/yyyy. Perceba que, embora o formulário tenha semelhança com o leiaute cabeçalho e itens de formulários Mestre/Detalhe, neste caso há algumas diferenças sutis, mas importantes: o A classe Raiz ( Funcionario, no exemplo) não é mantida, o que é característica dos Casos de Uso de Manutenção Secundários. Mas ela é recuperada sem que se saia do formulário. Sua referência é copiada para todos os itens ( ProventoDesconto ), automaticamente. o Outros argumentos que não compõem a classe Raiz, mas que são comuns a todos os itens, podem ser utilizados no cabeçalho e também são replicados automaticamente para estes itens. É o caso do anomesreferencia. Note que os valores de Proventos e Descontos, tal como em Detalhes, podem ser entrados em lote, sem uso de mouse, de forma bastante produtiva para usuários. 3. Altere a naturezaproventodesconto para valores IR ou SF. Nosso Javascript atua alterando dinamicamente e impedindo preenchimento dos demais campos, além de apresentar a mensagem, como mostra a Figura C13.20.

10 Capítulo C13 Figura C Javascript atuando. #1. Ao selecionar "Dias Trabalhados", os valores à direita são automaticamente preenchidos. #2. Ao tentar selecionar "Salário Final Calculado" ou "Imposto de Renda Calculado", valores eventualmente preenchidos nos campos à direita são limpos. Os campos em si são escondidos e uma mensagem também alerta o usuário. 4. Após preencher os dados corretamente e gravar, veja que os dados de cabeçalho são mantidos, mas novos detalhes são criados para facilitar entradas de dados para novos argumentos. Este é o comportamento padrão quando utilizamos a opção entradaemlote=true para a Colaboração. Se não a tivéssemos utilizado, os dados recém gravados de itens permaneceriam visíveis na página após a gravação. 5. Tente agora clicar em Limpar e/ou limpe os campos de argumento e clique em " Gravar". Veja que os campos de argumento estão sendo devidamente validados. Nos próximos tutoriais, utilizaremos os valores gerados nesta entrada de dados para a rotina de Cálculo da Folha.

11 Implementando o Padrão Manter Coleção Sumário Neste capítulo, implementamos um segundo tipo de Caso de Uso Padrão de Manutenção Secundário, assim considerado por manter objetos de classes que compõem uma Agregação, mas que não são mantidas juntamente com objetos da classe Raiz. No caso específico do padrão Manter Coleção, vimos que ele se caracteriza por possibilitar a entrada em lote e em formulário tabular (desnormalizada, para vários objetos simultaneamente), semelhante em termos de GUI ao padrão Manter Classe, porém com foco em classes com grande população de objetos.