Obter o JAR da API do BOUML

Por: António Casqueiro | Publicado em: 2008/04/06

Mudar língua:

Introdução

Recentemente tive necessidade de desenhar diagramas de classe, para acelerar a aprendizagem do domínio do sistema no qual me encontro a trabalhar.
Procurei uma ferramenta com as seguintes características:

Levezinho, para não ficar frustrado com a lentidão da ferramenta durante o desenho e consulta dos diagramas
Multi-plataforma, para poder partilhar o meu trabalho com os amantes do Windows ou do Linux

Procurava ainda que a tivesse uma API Java, para eu poder fazer um reverse engineering personalizado das classes.
Encontrei o BOUML!
À primeira vista era a ideal, mas não encontrava o link para fazer download da API.

Assim, uma vez que o programa permite fazer o forward engineering, resolvi eu próprio criar o JAR e é esse procedimento que pretendo partilhar com o Mundo :)

Requisitos

JDK 1.5 ou superior (foi testado com JDK 1.6.0_03)
BOUML (foi testado com a versão 4.2)

Criar o JAR da API do BOUML passo a passo

Abrir o Empty Project "Project->Open"
No Kubunto este encontra-se em "/usr/lib/bouml/empty/"
Ao abrir o projecto, o BOUML força que este seja gravado
Gravar o projecto num directório (ex: /home/<my_home>/temp/) e dar-lhe o nome "bouml_api".
Definir o directório onde serão geradas as classes
- Clicar com o botão direito do rato sobre a raiz do projecto e escolher a opção "Edit generation settings"
- Na tab "Directory", indicar o directório para onde devem ser geradas as classes no textfield "java root dir"
Gerar a API
- Clicar com o botão direito do rato sobre a raiz do projecto e escolher a opção "Generate"->"Java".
  Os ficheiros da API são gerados.
Gerar JAR
- Ir para o directório para onde foram gerados os ficheiros com o código fonte Java
```
cd /home/<my_home>/temp/bouml_jar
```
- Mover o ficheiro de template de plug-out "Main.java" para outro directório
```
mv Main.java ..
```
- Compilar
```
javac *.java
```
- Criar JAR com sources e classes
```
jar cvf bouml-api.jar *
```

Notas

As classes geradas da API do BOUML não estão dentro de nenhum package
Caso se pretenda que estas sejam geradas no package "bouml", após ter definido o "java root dir", deve-se fazer o seguinte:
1. Gravar o projecto.
2. Abrir novamente o projecto, pois deve existir um bug no BOUML e só depois de abrir novamente o projecto é que é possível indicar o package das classes que serão geradas.
3. Para cada um dos packages "API BASE"+"Settings"+"Com"+"Diagram",e "API USER"+"Diagram", definir "bouml" como o nome do package Java.
Devem de ocorrer alguns erros na compilação pois o BOUML coloca o definição do package após os imports.
Assim, esses teram de ser corrigidos manualmente para compilar com sucesso.

Procedimento para gerar JAR, com API BOUML dentro de um package
- Ir para o directório para onde foram gerados os ficheiros com o código fonte Java
```
cd /home/<my_home>/temp/bouml_jar
```
- Mover o ficheiro de template de plug-out "Main.java" para outro directório
```
mv Main.java ..
```
- Corrigir package das classes que deram erro. Na versão 4.3.1 são
  - CppSettings.java
  - IdlSettings.java
  - JavaSettings.java
  - UmlBaseClass.java
  - UmlBaseItem.java
  - UmlCom.java
- Compilar
```
javac *.java
```
- Criar diréctorio do package
```
mkdir bouml
```
- Mover as classes para o package
```
mv *.* bouml/
```
- Criar JAR com sources e classes
```
jar cvf bouml-api.jar *
```
Exemplo parcial de utilização:
- Classe "Main.java"
- Classe "BoumlControl.java" que usa a API BOUML para importar classes e as suas relações
Atenção: Gerar um JAR da API não é a forma aconselhada/padrão de desenvolver plug-outs.
O autor do BOUML aconselha utilizar o próprio BOUML.
No entanto, nesse caso não se poderá tirar partido do auto-complete ou debugging de um IDE como o Eclipse.

Agradecimentos

Bruno Pagès, pelo ter desenvolvido o BOUML
À minha família por ter passado alguns fins de semana e feriados sem mim...