Configurando Transformações de C# em UML

Para especificar as informações que a transformação utiliza para gerar a saída que você espera, utilize o Novo assistente de configuração de transformação e o editor de configuração de transformação, que o orientará através da configuração.
Por Que e Quando Desempenhar Esta Tarefa

Uma configuração de transformação possui .tc como uma extensão de nome de arquivo e contém as informações que a transformação utiliza para gerar a saída esperada. Uma configuração de transformação também contém informações específicas para um determinado tipo de transformação. Para editar uma configuração de transformação existente, em uma visualização que mostra os recursos da área de trabalho, dê um clique duplo no arquivo de configuração da transformação, que abre o editor de configuração de transformação.

Para simplificar o trabalho com o arquivo de configuração de transformação, salve o arquivo de configuração no projeto que contém os elementos para transformar.

Para configurar uma transformação de C# em UML:

  1. Clique em Arquivo > Novo > Outro > Transformações > Configuração de Transformação.
  2. Especifique os detalhes da configuração. No Novo Assistente de Configuração de Transformação , na página Especifique um Nome e uma Transformação de Configuração, conclua as seguintes etapas:
    1. No campo Nome, especifique um nome para a configuração.
    2. No campo Destino do arquivo de configuração, especifique o destino do arquivo de configuração da transformação. O destino é um caminho relativo em seu espaço de trabalho atual. É possível especificar um nome de projeto ou nome de pasta completo. Se você especificar uma pasta em um projeto, deverá iniciar o nome da pasta com uma barra (/).
    3. A partir da lista Transformação , selecione uma transformação.
      Nota: Para exibir as transformações que estão instaladas, mas não ativadas, clique em Mostrar todas as transformações. Uma transformação deve ser ligada a um recurso para aparecer nesta lista.
  3. Na seção Protocolo, especifique o protocolo de modelagem, que também é chamado de design contract management protocol (DCMP). O valor selecionado determina se a origem e o destino da transformação devem ser sincronizados.
    • Se o modelo de origem for o artefato de engenharia primária, selecione Conceitual. Quaisquer alterações no modelo de origem são propagadas para o modelo de destino.
    • Se a arquitetura que os artefatos de origem representam evoluir independentemente do destino, selecione Reconciliada. Selecionar essa opção possibilita a transformação reversa, que você pode utilizar para comprara a origem e o destino e reconciliar alterações. Você também pode selecionar essa opção se diferentes equipes implementarem, desenvolverem ou mantiverem a arquitetura.
      Nota: Ao selecionar essa opção, propriedades adicionais se tornam disponíveis na seção "Transformação reversa" da páginaPrincipal. Para algumas transformações, páginas adicionais se tornam disponíveis noeditor de configuração de transformação. Para obter informações sobre como configurar a transformação reversa, consulte o link relacionado a seguir.
  4. Clique em Avançar.
  5. Especifique os elementos de origem e destino para a transformação. Para obter uma lista de elementos de origem e destino válidos, consulte o tópico de conceito relacionado para essa transformação. Na página Origem e Destino, complete as seguintes etapas:
    1. No painel Origem selecionada, selecione o elemento de origem para a transformação ser realizada.
    2. No painel Destino selecionado, selecione o destino da saída da transformação. Para criar um novo destino para a saída, clique em Criar contêiner de destino.
  6. Clique em Concluir. O editor de configuração de transformação é aberto, e o conteúdo da configuração é exibido.
  7. Opcional: Especifique a documentação sobre a configuração de transformação. Esse campo é útil para comunicar informações sobre uma configuração compartilhada por vários usuários. Na página Principal, no campo Documentação , especifique as informações adicionais sobre a configuração da transformação.
  8. Opcional: Para especificar o tipo de coleta C# que a transformação gera para cada tipo de coleta UML no projeto de origem, clique na guia Coletas. Uma coleta representa um grupo dos elementos do modelo. O tipo de coleta C# que você seleciona determina se elementos de modelo duplicados podem existir na coleta ou se os elementos de modelo são ordenados. O tipo de coleta UML é determinado pelas propriedades isOrdered e isUnique dos elementos de modelo.
  9. Para configurar como o código-fonte C# é transformado em um modelo, clique na guia Opções Adicionais de C# em UML e, em seguida, selecione qualquer uma das seguintes opções:
    • Para gerar operações de UML no modelo de destino para cada método getter ou setter no código, selecione Gerar operações de UML para cada método C# getter/setter.
    • Para salvar automaticamente o modelo de destino e o modelo de mapeamento (se especificado por meio da configuração de UML em C#), depois de ter executado uma transformação de C# em UML, selecione Salvar modelos automaticamente depois de executar a transformação de C# em UML.
    • Para gerar relacionamentos de generalização de todas as classes UML que representam as classes C# para montar a classe System.Object, selecione Criar generalizações para System.Object.
  10. Opcional: Se a transformação configurada suporta mapeamento, é possível especificar nomes alternativos para os artefatos que a transformação gera criando um modelo de mapeamento. Para utilizar um modelo de mapeamento novo ou existente, conclua as seguintes etapas:
    1. No editor de configuração de transformação, na página Mapeamento, selecione a caixa de opção Ativar a funcionalidade de mapeamento para essa configuração.
    2. No campo Nome do arquivo de modelo de mapeamento, especifique o nome de um modelo de mapeamento novo ou existente.
  11. Opcional: Para gerar informações sobre depuração, na página Principal, selecione a caixa de opção Gerar um log de depuração. Na próxima vez em que você executar a transformação, o arquivo de log será gerado como um arquivo XML na pasta em que você especificar nas preferências de transformações. Se você não especificar um local para os arquivos de log, a transformação gera o arquivo de log na pasta .metadata em sua área de trabalho.
    Dica: Para configurar as preferências para as transformações, clique em Janela > Preferências; em seguida, expanda Modelagem e clique em Transformações.

    O arquivo de log fornece informações sobre os elementos de origem, os elementos de destino e as regras que a transformação aplica para transformar os elementos de origem. Se a transformação transformar vários elementos, poderá ocorrer uma redução no desempenho enquanto a transformação gerar o arquivo de log; portanto, você só deverá gerar um arquivo de log para propósitos de depuração.

  12. Opcional: Para evitar que novas caixas de diálogo sejam abertas enquanto uma transformação é executada, na página Principal, selecione a caixa de opção Executar a transformação de encaminhamento silenciosamente.

    A execução de uma transformação no modo silencioso suprime todas as caixas de diálogo geradas pela transformação. A transformação aplica regras e comportamento padrão, o que pode gerar uma saída de transformação inesperada ou incorreta. Você só deve executar uma transformação no modo silencioso para validar a execução da transformação, em vez de validar a saída da transformação. Por exemplo, você poderia executar uma transformação no modo silencioso como parte de um conjunto de tarefas automatizadas ou testes automatizados.

    A configuração da transformação para executar em modo silencioso substitui as opções de substituição de arquivo que você especifica, e então sobrescreve os arquivos se necessário.

    Se a transformação de UML em C# estiver disponível, você pode selecionar a caixa de opção Executar a transformação reversa de forma silenciosa. Especificar que a transformação de UML em C# ou reversa é executada no modo silencioso suprime o editor de fusão. Se ocorrer um conflito durante a fusão, a transformação pára e você deve executar novamente a transformação com as opções de silenciosa desmarcadas.

  13. Opcional: Para criar um relacionamento rastreável entre a origem e o destino de transformação, na página Principal, selecione a caixa de opção Criar relacionamentos de rastreio. Essa caixa de opção será ativada apenas se você selecionar os protocolos Modelagem Combinada ou Modelagem Reconciliada.

    Você pode utilizar os relacionamentos de rastreio e as ferramentas de desenvolvimento visual para entender os relacionamentos entre os elementos de modelo de origem e a saída da transformação. Essa função é útil em projetos grandes que podem conter vários modelos e configurações de transformação. A transformação não altera o modelo de origem.

  14. Opcional: Para exibir os erros que ocorreram quando a transformação foi executada, na página Principal, selecione a caixa de opção Abrir a caixa de diálogo Relatório quando a transformação estiver concluída. A seleção dessa caixa de opção exibe apenas os erros gerados. As mesmas informações também são gravadas no log de erros, que você pode visualizar clicando em Janela > Mostrar Visualização > Log de Erros.

    Para exibir os avisos que ocorreram quando a transformação foi executada, selecione a caixa de opção Mostrar avisos na caixa de diálogo Relatório.

  15. Opcional: Crie um arquivo que defina a associação entre elementos C# e elementos UML de destino. Essa funcionalidade é útil para definir os relacionamentos entre elementos C# e UML cujo escopo está fora da transformação configurada e que pode estar localizado em diferentes projetos. Para criar um arquivo de associação, na página Associações de C# em UML, execute uma das seguintes etapas:
    • Clique em Novo, e especifique um nome e local para o arquivo.
    • Para usar um arquivo de associação existente, navegue até ele e o selecione.
    • Clique em Incluir Associação e selecione Qualquer uma na área de janela à esquerda e o elemento de modelo na área de janela à direita. Ambas as entradas são exibidas na tabela Associações de Origem para Modelo.
  16. Clique em Arquivo > Salvar.
Resultados
As opções serão aplicadas na próxima vez em que você executar a transformação.

Feedback