Références de l'API-XSP de SDX

SDX offre un environnement propre au développement d'applications permettant d'effectuer des recherches dans une collection de documents XML. Dans ce contexte, on peut comparer SDX à une boîte à outils dans laquelle le développeur va puiser pour bâtir son environnement de recherche (l'application de démonstration sdxtest offre une liste de quelques applications SDX). L'ensemble de ces instruments forme ce que l'on appelle communément l'API-SDX (FIXME). Celle-ci se décompose en deux groupes : l'API-Java de SDX (disponible au format Javadoc™™) ; l'API-XSP de SDX qui fait l'objet de ce chapitre de la documentation. Elle documente les éléments mis à disposition pour l'écriture de pages XSP (voir la section pages XSP de Cocoon™).

Cette documentation se répartit en plusieurs sections :

Reprenons l'image de la boîte à outils développée plus haut. Nous avons vu que cette boîte contient deux compartiments (API-Java et API-XSP). L'API-XSP est composée de plusieurs éléments (au sens XML du terme) se répartissant en deux classes : les actions SDX et les conteneurs de paramètres SDX (voir le chapitre logique des paramètres SDX pour approfondir cette notion). Les actions SDX peuvent être comparées aux outils proprement dits (e.g., un marteau). Les conteneurs de paramètres SDX sont des éléments comprenant des attributs (au sens XML du terme) utilisables par les actions SDX. Ce ne sont pas des actions à proprement parler, car elles ne produisent pas directement un flux XML (le XML virtuel généré, prêt à être transformé et sérialisé comme indiqué dans le chapitre pages XSP de Cocoon™). Ainsi l'élément sdx:hilite contient un attribut hilite largement employé par les actions de recherche telles que sdx:executeFieldQuery ou sdx:terms. Dans le monde SDX, ces attributs sont vus comme des paramètres SDX. Pour rester dans l'image de la boîte à outils, il s'agit de la quincaillerie (e.g., des clous).