Skip to main content.

This page’s menu:

Pré-requis

Pour pouvoir utiliser ce logiciel vous aurez besoin d'installer d'abord un jre Java (à partir de la version 5) et Java3d (à partir de la version 1.5.0).

Cette version a été développée sous Windows, son apparence et son comportement peuvent varier sur d'autres plateformes. En cas de problème, veuillez me contacter à l'adresse figurant sur la page "Contact".

Configuration

Pour faciliter son utilisation, les projets analysés avec Relief sont décrits dans un fichier de configuration.

Ce fichier est écrit en XML standard, projet.xml nous servira d'exemple : 

<parser name="JavaParser">
  <driver>org.workingfrog.relief.plugins.java.JavaConfigHandler
  <projects default="monProjet">
    <project name="monProjet">
      <jrePath jreVersion="1.4">C:\Program Files\Java\j2re1.4.2_06</jrePath>
      <basedir>C:\chemin\vers\le\repertoire\racine\de\mon\projet</basedir>
      <blackbox />
      <build>bin</build>
      <src>
        <path>src</path>
        <path>test</path>
      </src>
      <lib show="false">
        <path>unePremiereLibrairie.jar</path>
        <fullpath>C:\chemin\complet\vers\uneAutreLibrairie.jar</fullpath>
      </lib>
    </project>
    <project name="unAutreProjet">
      <jrePath jreVersion="1.6">C:\Program Files\Java\jdk1.6.0_01\jre</jrePath>
      <basedir>C:\chemin\vers\le\repertoire\racine\de\mon\autre\projet</basedir>
      <build>bin</build>
      <src>src</src>
      <lib>
        <path>uneLibrairie.jar</path>
      </lib>
    </project>
  </projects>
</parser>
Les balises parser et driver sont obligatoires et ne doivent pas être modifiées.

L'attribut default dans la balise projects définit quel projet analyser si aucun n'est précisé sur la ligne de commande.

La balise jrePath défini le runtime java employé par le projet. Si un jdk est utilisé, le chemin doit finir par son répertoire "jre", examinez les deux exemples au dessus. L'attribut jreVersion a pour valeur "1.3", "1.4", "1.5", "5", "1.6" ou "6" : il s'agit de la version du code source.

blackbox conditionne la façon d'analyser le projet (focus sur l'API ou l'implémentation ?). Si aucun répertoire de fichiers source n'est fourni blackbox est automatiquement coché.

La balise basedir est le répertoire racine d'un projet.

build se rapporte au répertoire racine où les versions compilées de vos fichiers source java sont générées.

src au répertoire racine de vos fichiers source java.

Enfin, avec lib vous définissez les librairies sur lesquelles s'appuie votre projet. L'attribut optionnel show a pour valeur "true" (défaut) ou "false" ; il contrôle l'affichage des dépendances vers les classes de base Java et les librairies.

Les balises path dans build, src et lib sont des sous-répertoires de basedir. Si des ressources se trouvent en dehors du répertoire de votre projet utilisez la balise fullpath.

Usage

Ouvrez une console et rendez vous dans le répertoire de Relief.
Tapez java -jar relief.jar [chemin/vers/mon/fichierDeConfiguration.xml [nom du projet à charger]].

Si vous ne donnez aucun argument à Relief ou le démarrez en double cliquant son icone, Relief s'attend à trouver un fichier de configuration appelé "projects.xml" dans le répertoire depuis lequel vous l'avez lancé.

Par exemple, en tapant java -jar relief.jar projet.xml avec le fichier décrit plus haut, Relief analysera monProjet alors que java -jar relief.jar projet.xml unAutreProjet chargera unAutreProjet.

Imaginons qu'un projet par défaut est défini mais que vous vouliez en choisir un autre, utilisez un nom de projet inexistant, comme choix par exemple: java -jar relief.jar projet.xml choix, de cette façon Relief ouvrira une fenêtre permettant de choisir un projet défini dans le fichier de configuration.

En cas de problème

Si dans la console vous obtenez un message d'erreur ressemblant à celui ci : 

Exception in thread "Main Thread" java.lang.NoClassDefFoundError: javax/media/j3
d/SceneGraphObject at org.workingfrog.relief.Relief.main(Relief.java:60)
Cela veut dire que soit java3d n'est pas installé, soit vous avez plusieurs jre java installés et vous en utilisez un pour lequel java3d n'est pas installé.

Le compilateur java utilisé pour analyser les fichiers sources générera peut être des avertissements. Ils peuvent vous aider à trouver des librairies ou des chemins vers les binaires manquants dans le fichier de configuration. Ils diagnostiqueront aussi un version java incompatible (case à cocher "java version < 5").

L'utilisation de la vue peut déclencher certaines exeptions java3d. Elles semblent mineures car la vue reste utilisable mais je n'ai pas encore trouvé leur cause. Tout avis est le bienvenu.