Règles d'engagement d'API
- Seules les API exposées dans la référence Javadoc sont prises en charge pour la programmation,
sauf mention contraire dans la documentation en rapport. Les API des documents Javadoc
sont stables et ne seront pas supprimées au-delà des limites de version.
Il est possible que des API CARMA deviennent obsolètes dans des éditions futures
mais continuent d'être disponibles et utilisables par les programmeurs
telles que définies dans la documentation. D'autres API figurent dans les plug-in
CARMA mais doivent être considérées comme non prises en charge et sujettes
à modification dans les éditions futures.
- Les API du modèle CARMA (package com.ibm.carma.model)
sont conçues pour une utilisation en lecture seule par le programmeur,
c'est-à-dire que celui-ci ne doit pas tenter de créer/ajouter/déplacer des éléments
manuellement dans le modèle CARMA. Les objets de la hiérarchie sont destinés
à être mis à jour via les méthodes refreshXXX() et createXXX().
La création d'objet de modèle en dehors de l'utilisation de méthodes d'API n'est pas prise en charge.
Si des objets de modèle sont créés en dehors de ces méthodes, des incohérences
risquent d'être engendrées.
- Toutes les listes de ressources de référentiel du modèle sont associées à une chaîne de filtrage.
La chaîne de filtrage par défaut est “*”.
- La plupart des méthodes du modèle CARMA requiert une connexion à l'hôte CARMA
pour être actives lors de leur exécution. Si la connexion n'est pas active,
une exception com.ibm.carma.transport.NotConnected est émise.
- Les méthodes CARMA nécessitant l'activation de la connexion à l'hôte CARMA
comportent un paramètre org.eclipse.core.runtime.IProgressMonitor
dans la signature de méthode. Pour annuler l'exécution de la méthode,
nous utilisons la méthode IProgressMonitor.isCancelled(),
vérifiée lors de l'exécution de méthodes à exécution longue.
- Le modèle CARMA sert de cache de données pour la hiérarchie CARMA.
Il est de la responsabilité du programmeur de conserver la mémoire
cache à jour à l'aide des méthodes refreshXXX()
du modèle.
- Le cache du modèle CARMA doit être initialisé. En cas d'accès à une une portion de la hiérarchie CARMA
qui n'est pas mise en cache, une exception com.ibm.carma.transport.NotSynchronizedException
est émise. Pour résoudre l'exception, exécutez une méthode refreshXXX() sur l'objet.
- Les modèles du cache du modèle CARMA sont disponibles hors connexion à l'hôte CARMA.
L'hôte CARMA doit être connecté et actif pour exécuter des méthodes en fonction
des objets du cache qui accèdent à l'hôte CARMA.
- Les modifications du modèle sont communiqués aux programmes d'écoute
par notification. La notification est envoyée à tout adaptateur
à l'écoute de l'objet de modèle. Des programmes d'écoute doivent être ajoutés
au modèle à l'aide d'une classe qui étend org.eclipse.emf.common.notify.Adapter.
Il s'agit d'une méthode de notification Eclipse Modeling Framework (EMF). Voir la documentation
EMF pour plus d'informations sur la notification d'adaptateur.
- L'interface utilisateur CARMA par défaut (incluant les API
com.ibm.carma.ui.*)
utilise une combinaison d'actions et de travaux d'exécution des méthodes
sur le modèle CARMA. L'Action (étendant org.eclipse.ui.IAction ou
org.eclipse.ui.IActionDelegate) est responsable
de la collecte des données nécessaires à l'exécution de la méthode du modèle.
Les données collectées sont transmises sans intervention à un travail
d'interface utilisateur CARMA, lequel est planifié pour s'exécuter en arrière-plan
lorsque des ressources sont disponibles. Si la méthode du modèle entraîne des mises à jour
de la la hiérarchie CARMA, des notifications sont adressées depuis le modèle
aux programmes d'écoute, lesquels mettent à jour l'interface utilisateur en fonction des besoins.
|
Ce centre de documentation utilise la technologie Eclipse. (http://www.eclipse.org)