Projeto Físico Guia Rápido Do Desenvolvedor Powerlogic UNIP Unidade de Projetos Versão 1.0 1
1. Histórico de Revisões Atualizado por Data de Atualização Revisado por Data de Revisão 1 Karen Ramalho Sousa dos Santos 29/04/2009 Emily Esch 30/04/2009 2 Karen Ramalho Sousa dos Santos 30/04/2009 Isamara Santos 30/04/2009 3 4 5 Powerlogic UNIP Unidade de Projetos Versão 1.0 2
Indice Introdução... 4 Forma de Recebimento dos Artefatos... 5 Visão Geral do Diagrama... 6 Detalhamento do Diagrama... 6 Visualização de dados Adicionais de Usuários... 7 Visualização de Detalhamento de Interface... 8 Detalhamento CRUD... 8 Detalhamento Tabular... 9 Detalhamento Mestre-Detalhe e Mantém-Detalhe... 10 Detalhamento Mestre-Detalhe-SubDetalhe e Mantém-Detalhe-SubDetalhe... 11 Detalhamento Consulta e Seleção... 12 Visualização do Mapeamento OO-ER... 12 Visualização do Diagrama de Classes... 13 Visualização dos Dados da Colaboração... 14 Visualização dos Dados do Evento e Regras Relacionadas ao Evento... 17 Visualização de Dados de Interface Externa... 18 Visualização de Dados de Requisitos Não Funcionais... 18 Powerlogic UNIP Unidade de Projetos Versão 1.0 3
Introdução O que é o projeto fisico? O projeto físico é a descrição completa do projeto a ser implementado numa visão técnica. Qual o objetivo do projeto fisico? O objetivo do projeto físico é ser um guia para o desenvolvimento, facilitando a leitura da documentação, padronizando os artefatos recebidos e incluindo informações que não constam na especificação ou constam, mas de forma implícita ou indireta causando dupla interpretação da mesma informação. Visa também diminuir as lacunas que existem entre a o artefato funcional recebido (ERSW) e o que será desenvolvido. Quais são as Vantagens de se utilizar este artefato? Padronização da documentação facilitando e agilizando a leitura da documentação pelo desenvolvedor. Reestruturação e detalhamento de regras Diminuição do número de erros por desinformação Melhora o entendimento Antecipa problemas e conseqüentemente a solução dos mesmos Torna especificação do cliente mais aderente aos padrões estabelecidos pelo Framework. Propicia maior objetividade e clareza Powerlogic UNIP Unidade de Projetos Versão 1.0 4
Forma de Recebimento dos Artefatos O projeto físico a principio será recebido em formato html. Para visualização do projeto fisico abra o arquivo index.html. Será exibida uma página conforme exibido abaixo: Para visualizar o diagrama principal do projeto físico clique no diagrama que contém este símbolo. Feito isso será exibido o diagrama principal do projeto físico conforme mostrado abaixo. composite structure <ID Caso de Uso> - Nome do Caso de Uso «Eventos» Event1 «plc5tabular» Collaboration1 «plc5gui» Screen1 «Eventos» Event12 «Interface Externa» Interface3 Actor1 «Eventos» Event3 Requisitos Não-Funcionais «plc5tabular» Collaboration3 «plc5gui» Screen1 «Eventos» Event1 «Eventos» Event12 «plc5gui» Screen2 «Eventos» Event1 «Eventos» Event12 «Eventos» Event3 Powerlogic UNIP Unidade de Projetos Versão 1.0 5
Visão Geral do Diagrama Detalhamento do Diagrama O diagrama principal do projeto físico é composto dos elementos necessários a implementação do caso de uso. Nele podemos encontrar os atores que possuem permissão para acessá-lo, as principais colaborações, regras gerais de renderização de interface, detalhamento das interfaces relacionadas a cada colaboração e detalhamento dos eventos relacionados a cada interface. Além do mapeamento OO-ER (Objeto Relacional) e um diagrama contendo as classes acessadas na colaboração. Nesta seção iremos detalhar cada um dos itens que compõem o diagrama. Visualização de Regras de Renderização de Interface As regras de renderização de interface ou regras gerais estarão sempre representadas pelo seguinte símbolo. Para acessar tais regras basta clicar sobre o objeto e será exibido documento contendo tais regras conforme mostrado abaixo: Powerlogic UNIP Unidade de Projetos Versão 1.0 6
O documento é composto pelas seguintes informações: Regras Nível de Indica o categoria da regra. Regras podem ser a nível de Atributo, Perfil, Classe, Objeto ou Domínio. (Para mais informações a respeito dos tipos de Regras ver seção Nível de Regras) Id da regra Número que identifica a regra de forma única dentro de determinado processo. Tipo de Regra Indica se a regra estava implícita ou explicita dentro do fluxo. Classe - Classe que deve ser utilizada para implementação da regra. Atributo - Atributo que será manipulado e /ou alterado em função da regra. Descrição da Regra - Descreve como a regra deve ser implementada, deve conter referências a classes, atributos ou banco de dados quando for necessário. Dentro deste descritivo podem ser lançadas validações ou exceções que impliquem no retorno de mensagens descritas no item posterior. Msg. Informativa - Mensagens utilizadas para informar o usuário que determinada ação foi ou será tomada em virtude de um evento acionado. Msg. De Confirmação - Mensagem de confirmação de um evento. Exemplo: Ao acionar o comando excluir deve ser exibida mensagem de confirmação: Deseja realmente excluir o registro? Msg. Sucesso Mensagem que deve ser exibida caso a regra seja executada com sucesso. Msg. Falha Mensagem que deve ser exibida caso a regra não seja executada por falha ou problemas na validação. Geralmente regras de renderização de interface estão relacionadas a campos específicos da interface e podem ser encontradas no detalhamento destas no campo Regras Relacionadas no qual é citado o ID da regra. Visualização de dados Adicionais de Usuários Para visualizar os dados adicionais do usuário clique sobre o ator e será exibida a descrição do mesmo caso exista. Powerlogic UNIP Unidade de Projetos Versão 1.0 7
Visualização de Detalhamento de Interface Para visualização do detalhamento das interfaces clique sobre o ícone referente a tela, de acordo com a lógica identificada na colaboração o documento exibido poderá vir de forma diferente conforme mostrado abaixo: Detalhamento CRUD Powerlogic UNIP Unidade de Projetos Versão 1.0 8
Detalhamento Tabular Powerlogic UNIP Unidade de Projetos Versão 1.0 9
Detalhamento Mestre-Detalhe e Mantém-Detalhe Powerlogic UNIP Unidade de Projetos Versão 1.0 10
Detalhamento Mestre-Detalhe-SubDetalhe e Mantém-Detalhe-SubDetalhe Powerlogic UNIP Unidade de Projetos Versão 1.0 11
Detalhamento Consulta e Seleção Visualização do Mapeamento OO-ER Para visualizar o Mapeamento OO-ER clique na colaboração (Ícone ) referente a manutenção do caso de uso conforme mostrado na figura abaixo: Assim do lado direito serão exibidas três abas Tagged Values, Linked Document e Other Links. Clique na aba Linked Document, dessa forma será exibido o mapeamento: Powerlogic UNIP Unidade de Projetos Versão 1.0 12
Neste documento estarão todas as informações necessárias para que seja realizado o mapeamento físico. Visualização do Diagrama de Classes Para visualizar o diagrama de classes basta clicar sob a colaboração de manutenção referente ao caso de uso. O simbolo ( ) indica que há diagrama para visualização. Neste diagrama estarão representadas todas as classes acessadas pelo caso de uso. Powerlogic UNIP Unidade de Projetos Versão 1.0 13
Visualização dos Dados da Colaboração Para visualizar demais detalhes clique na colaboração (Ícone ) referente a manutenção do caso de uso conforme mostrado na figura abaixo: Feito isto, serão exibidos na aba Tagged Values informações do tipo : Assistente Não Values: Sim,Não Default: Não Description: Utiliza lógica de "assistente"? Classe DAO CobrancaTaxaDAO Description: Classe DAO Classe de Controle CobrancaTaxaAction Description: Classe Action Classe de Modelo CobrancaTaxaManager Description: Classe Manager Classes Associadas ParametrosGerais, Servico Description: Classes associadas Entrada em Lote Não Values: Sim,Não Default: Não Description: Utiliza modalidade de entrada de dados em lote? Estereótipo da Colaboração Mantém-Detalhe Description: Estereótipo da Colaboração (Padrão JCompany) Id do Caso de Uso CDU002007 Description: Identificador do Caso de Uso Identificador da Colaboracao Raiz Normal Description: Tipo de Colaboracao Powerlogic UNIP Unidade de Projetos Versão 1.0 14
Menu Manter -> Prazo -> Comando Novo ou Editar Description: Localizacao do Caso de Uso no menu Nome Aba Não utiliza abas. Default: Sim Description: Nome das Abas Número de Detalhes 1 Default: 1 Description: Número de detalhes da colaboração. Permissão de Acesso Administrador Description: Perfis que possuam acesso a Colaboração Posição dos Rotulos Topo Values: Topo,Linha Default: Sim Projeto JCompany infoscip Description: Nome do Projeto JCompany Subdiretorio CDU002007 Description: Subdiretório para armazenamento das páginas JSP. Tecnologia Camada Controle JSF Values: JSF,Struts Default: JSF Description: Tecnologia utilizada pelo jcompany 5 para geração Tecnologia Camada Modelo POJO Values: EJB,POJO Default: POJO Description: Tecnologia utilizada pelo jcompany 5 para geração tipoexclusao Física Values: Física,Lógica Default: Física Description: Tipo de exclusão dos registros da tabela. Titulo Cadastro de Cobrança de Taxa Description: Título da colaboracao URL Consulta (con) cobrancataxacon Description: URl de consulta URL Manutenção (man) cobrancataxaman Description: URl de Manutenção URL Seleção (sel) cobrancataxasel Description: URl de seleção Utiliza Abas Powerlogic UNIP Unidade de Projetos Versão 1.0 15
Powerlogic UNIP Unidade de Projetos Versão 1.0 16
Visualização de Dados de Colaborações do Tipo Relatório Quando se tratar de uma colaboração do tipo Relatório os dados exibidos serão outros, conforme mostrado a seguir: Configurações: Orientação, Tipo do relatório Configurações de Margens : Margem Superior, Margem Inferior, Margem Esquerda, Margem Direita, Margem - Observações. Configurações de Rodapé : Rodapé Itens, Rodapé Fonte, Rodapé - Tam.Fonte, Rodapé Alinhamento, Rodapé - Observações Configurações do Corpo do Relatório: Corpo do Rel. Fonte, Corpo do Rel. - Tam.Fonte, Corpo do Rel. Alinhamento, Corpo do Rel. - Larg. Linha Borda, Exibe Filtros? Configurações do Cabeçalho do Relatório: Cabeçalho do Rel. Fonte, Cabeçalho do Rel. - Tam.Fonte, Cabeçalho do Rel. Alinhamento, Cabeçalho do Rel. - Larg. Linha Borda Configurações Cabeçalho da Página : Cabeçalho Pag.- Fonte, Cabeçalho Pag.- Tam.Fonte, Cabeçalho Pag.- Alinhamento, Cabeçalho Pag.- Exibição, Cabeçalho Pag.- Imagem, Cabeçalho Pag.- Imagem Dir. Configurações do Titulo : Titulo, Titulo Fonte, Titulo - Tam.Fonte, Titulo - Fonte em Negrito, Titulo - Fonte Sublinhada, Titulo - Fonte Itálico, Titulo - Alinhamento Visualização dos Dados do Evento e Regras Relacionadas ao Evento Para visualizar os dados adicionais do evento basta clicar sobre o mesmo do lado direito da tela que os dados serão exibidos na aba Tagged Values. Para visualizar as regras executados no evento basta clicar no ícone acessar a aba Linked Documents. no diagrama ou Powerlogic UNIP Unidade de Projetos Versão 1.0 17
Visualização de Dados de Interface Externa Para visualizar os dados adicionais da interface externa basta clicar sobre o mesmo do lado direito da tela, que os dados serão exibidos na aba Tagged Values. Dados referentes a regras da interface estarão descritos na aba Linked Document. Visualização de Dados de Requisitos Não Funcionais Para visualizar os dados adicionais dos requsitos não funcionais basta clicar sobre o mesmo do lado direito da tela, que os dados serão exibidos na aba Tagged Values. Powerlogic UNIP Unidade de Projetos Versão 1.0 18