Documentation technique

Documentation technique
Projet Medley
2015_TD3_FR_Medley
Projet Medley
Documentation technique

Documentation technique
Projet Medley
2015_TD3_FR_Medley
Résumé
Ce document s’adresse aux membres du labEIP et à toute personne qui
voudrait prendre connaissance des caractéristiques techniques de Medley
(développeur, architecte projet). Il présente la documentation technique de
notre projet.
Le projet Medley est composé de trois grandes parties actuellement en
développement.
Un logiciel qui fournit une interface graphique ainsi qu’une API permettant
d’utiliser des plugins et de permettre un développement public de ceux-ci.
Nous présenterons ensuite techniquement différents plugins que nous
réalisons afin de lancer le projet. Quatre plugins sont réalisés, un accordeur,
un métronome, un enregistreur/lecteur de son et un lecteur de partition.
Enfin, nous présenterons l’organisation du site internet qui est un support
communautaire de notre projet. Il n’est donc pas lié directement au logiciel et
aux plugins mais qui suit une architecture particulière également.

Documentation technique
Projet Medley
2015_TD3_FR_Medley
Description du document
Révisions
Date
Auteur
Section(s)
modifiée(s)
Commentaires
01/10/2014
Julie Nicolas
Toutes
Première version du
document
03/10/2014
Joris Mathieu
Web/Résumé
Titre
2015_TD3_FR_Medley
Date
01/10/2014
Responsable
Julie Nicolas
Email
[e-mail]
Sujet
Documentation technique du projet Medley
Version
1.0

Documentation technique
Projet Medley
2015_TD3_FR_Medley
I. Le logiciel ......................................................................................................................................... 1
a) Explications générales ................................................................................................................. 1
b) Vue détaillée ................................................................................................................................ 3
II. L'API ................................................................................................................................................. 6
a) Choix technologiques .................................................................................................................. 6
b) Diagramme de classes ................................................................................................................. 7
c) Implémentation du plugin et héritage de l’API ........................................................................... 8
III. Le Metronome (plugin) ............................................................................................................... 9
a) Choix technologiques .................................................................................................................. 9
b) Diagramme de classes ................................................................................................................. 9
c) Description ................................................................................................................................ 10
IV. L' accordeur (plugin) .................................................................................................................. 10
V. L’enregistreur de son ..................................................................................................................... 11
a) Choix de technologie ................................................................................................................. 11
b) Classes ....................................................................................................................................... 11
c) Description ................................................................................................................................ 11
VI. Le site web ................................................................................................................................. 12
a) Fonctionnalités .......................................................................................................................... 12
b) Choix technologiques ................................................................................................................ 17
c) Architecture ............................................................................................................................... 18
d) Implémentation ......................................................................................................................... 20
e) Base de données........................................................................................................................ 24

Documentation technique
Projet Medley
2015_TD3_FR_Medley
I. Le logiciel
a) Explications générales
Le choix de la librairie graphique avec laquelle nous allons créer l’interface utilisateur du logiciel a
soulevé quelques questions. En effet, Sun a lancé en 2007 Javafx, qui vise à remplacer la librairie
Swing. Swing ne sera donc plus mis à jour, tandis que Javafx continue d’évoluer, sa version 3 devant
être présentée dans le courant de l’année.
Nous allons utiliser Javafx, pour ses fonctionnalités et ses composants facilement personnalisables et
parce que c’est une librairie qui va être améliorée par Sun dans l’avenir. En effet, java 8 devrait sortir
dans le courant de l’année 2014, et une version améliorée de Javafx lui sera intégrée.
Comme nous avons décidé d’utiliser Javafx, un problème potentiel se présente au niveau de l’API de
notre projet.
En effet, de nombreux utilisateurs utilisent toujours la librairie Swing et continueront à l’utiliser
plutôt que de passer à Javafx. Nous aurions voulu leur laisser la possibilité de créer leur plugin avec
la librairie graphique qu’ils préfèrent, mais après de nombreuses recherches, il s’avère que cela est
vraiment compliqué. Nous pensons donc opter pour un logiciel tout en Javafx, quitte à restreindre un
peu le public de développeurs au début de notre projet.
Pour développer notre logiciel, nous utilisons le patron de conception MVC. Cela nous permet de
séparer les différentes parties de notre application, et d’en avoir une vision simplifiée. Notre logiciel
est composé de 4 parties principales. Chacune de ces parties correspond donc à une vue, dont les
données à afficher seront contenues dans un modèle, lui-même mis à jour et fourni par un
contrôleur. Les contrôleurs sont contenus dans un fichier .jar (Java Archive). Il en est de même pour
les vues et les modèles. En découpant ainsi notre logiciel en plus petites parties, nous le rendons
versionnable plus aisément. Le système de chargement des fichiers .jar permettra de télécharger les
mises à jour sans avoir à télécharger à nouveau tout le logiciel, ni à le relancer.
Au niveau du logiciel, nous stockons les données de configuration dans des fichiers XML qui seront
parsés grâce à la librairie JDOM (Java Document Object Model).