Skip to content

Fonctionnalités

sebez edited this page Aug 1, 2018 · 22 revisions

Cette page décrit toutes les fonctionnalités que le plugin fournit pour un projet sous Vertigo.

Les fonctionnalités sont également implémentées, pour toutes les versions antérieures de Kasper (2 à 6).

Editeur KSP

Coloration syntaxique

  • Grammaire KSP
    • Mots-clés de la grammaire KSP
    • Commentaires
  • SQL pour les Tasks
    • Mots-clés SQL
    • Commentaires SQL
    • Paramètres de la requête
    • Tags Java

Outline

  • Outline navigable et triable

Navigation

La navigation se fait en faisant un Ctrl + Click sur un mot du document dans l'éditeur.

  • Vers l'implémentation Java pour les domaines (DO_DT_OBJET_METIER_DTO, DO_DT_OBJET_METIER_DTC)
  • Vers la définition KSP pour tous les domaines, contraintes, formatter, ...
  • Vers l'implémentation Java pour une Task
  • Vers l'implémentation Java pour un nom de table SQL dans une requête SQL
  • Vers une classe Java du classpath pour un nom complet entre guillemets doubles
  • Vers une classe Java du projet pour un nom simple entre guillemets doubles
  • Vers le test unitaire pour une Task

Autocomplétion

L'autocomplétion se déclenche avec Ctrl + Space.

S'il y a une seule proposition, elle est automatiquement sélectionnée.

  • Domaine d'un paramètre de Task SQL
  • Paramètre d'une Task SQL

L'autocomplétion n'est pas sensible à la casse.

Tooltip

  • Affichage de la structure d'une table au survol d'un nom de table dans une Task SQL

Editeur KPR

  • Navigation (Ctrl + Click) vers les fichiers KPR et KSP

Editeur Java

  • Navigation (Ctrl + Click) vers la définition KSP à partir d'un nom Java (DTO, Task)
  • Navigation (Ctrl + Click) vers le test unitaire à partir du nom Java d'une Task

Remarque : le plugin se base uniquement sur le mot Java, indépendamment de son sens (méthode d'une certaine classe...).

Ainsi, on peut naviguer directement vers la Task KSP depuis chacune de ces méthodes (définition ou appel) si elles ont le même nom :

  • la méthode de DAO/PAO et son appel
  • la méthode de service et son appel
  • la méthode de webservice

Console de logs

  • Navigation vers la définition d'un KSP à partir de son nom

Par exemple, quand l'exécution des tasks SQL est loguée :

Finish /execute//* TaskEngine : TK_GET_RECETTE_LIST succes

Menu Vertigo

Un menu Vertigo est disponible dans le menu principal pour accéder aux fonctions globales, décrites ci-après.

Recherche de déclaration KSP

La fenêtre de recherche s'ouvre via le menu Vertigo ou avec le raccourci Ctrl + Shift + D.

Elle permet de rechercher une déclaration KSP par le nom Java de l'objet.

  • Task SQL (getUtilisateurListByCritere, ...)
  • DTO (UtilisateurCritere, ...)
  • Domaine (Commentaire, ...)
  • Tout objet déclaré dans les KSP (index de recherche, facet, publisher node...)

Recherche de route

La fenêtre de recherche s'ouvre via le menu Vertigo ou avec le raccourci Ctrl + Alt + Shift + R.

Elle permet de rechercher une méthode de WebService par sa route complète.

Remarque : la route indexée est celle déclarée dans la classe Java (avec la syntaxe {param}) pour les paramètres.

Les routes avec la syntaxe Javascript (${param}) ou avec des valeurs pour les paramètres ne seront pas détectées.

Il faut rechercher la partie de la route sans paramètre en utilisant le caractère joker (*).

Recherche de DAO/PAO

La fenêtre de recherche s'ouvre via le menu Vertigo ou avec le raccourci Ctrl + Alt + Shift + P.

Elle permet de rechercher une méthode de DAO/PAO par son nom Java.

Recherche de service

La fenêtre de recherche s'ouvre via le menu Vertigo ou avec le raccourci Ctrl + Alt + Shift + S.

Elle permet de rechercher une méthode d'implémentation de service métier par son nom Java.

Recherche de DTO

La fenêtre de recherche s'ouvre via le menu Vertigo ou avec le raccourci Ctrl + Alt + Shift + D.

Elle permet de rechercher une une classe de DTO par son nom Java.

Gestion de la version du framework Vertigo/Kasper

Le plugin détecte automatiquement la version de Vertigo/Kasper de chaque projet et adapte les fonctionnalités en fonction.

Il se base sur la présence discriminante de classes dans le classpath du projet.

En cas de faux positif, la version est consultable et modifiable dans les propriétés du projet, dans la page Vertigo.

Cette configuration est stockée dans le dossier .settings du projet.

Classes parentes des DTO

Si le projet utilise des classes personnalisées comme classes de base de DTO, le projet est configurable pour que les DTO soient correctement détectés par le plugin.

Voir les propriétés du projet, dans la page Vertigo.

Thème de couleur

Pour les développeurs utilisant le thème Dark d'Eclipse (fond noir), la coloration syntaxique de l'éditeur KSP s'adapte automatiquement (les couleurs complémentaires sont utilisées).

Support multi-projets

Si plusieurs projets sont ouverts dans le workspace :

  • les recherches globales se font dans tout le workspace
  • la navigation (Ctrl + Click) se fait dans le projet courant