SDX et le multilinguisme

Dans le fichier de configuration (application.xconf), l'élément supérieur sdx:application doit avoir un attribut xml:lang. La valeur de cet attribut peut être utilisée par SDX pour identifier la langue de consultation. On peut considérer cette valeur comme la langue par défaut de l'application ; pour une application unilingue cet attribut est en général suffisant pour indiquer la langue.

Les applications Web construites avec SDX offrent des services à des utilisateurs qui demandent les différentes pages du Web. Même lorsqu'il n'y a pas d'identification formelle des personnes qui consultent, pour SDX il y a un utilisateur spécial, l'utilisateur anonyme. Aucune langue n'est associée à cet utilisateur, mais il s'agit d'une exception. Tous les autres utilisateurs auront une langue associée et cette langue peut être utilisée pour déterminer la langue d'interface.

Dans l'interface de création des utilisateurs de SDX, il est possible d'associer une langue à l'utilisateur. Les applications qui ont leur propre interface de gestion des utilisateurs peuvent, de leur côté, associer une langue avec la méthode de leur choix, SDX pourra tout de même utiliser cette langue pour indiquer la langue d'interface.

Dans une page XSP, il est possible d'indiquer directement une langue et de faire en sorte que SDX utilise cette langue comme indication de langue d'interface. Cette spécification de la langue doit se faire par un attribut xml:lang de l'élément sdx:page ou de son élément parent xsp:page. Par exemple :

<xsp:page>
  <sdx:page xml:lang="es">
  ...
  </sdx:page>
</xsp:page>

L'API-SDX utilise un concept générique de paramètres et offre de nombreuses façons de spécifier ces paramètres dans une page XSP. Pour en connaître les détails, il est préférable de consulter la documentation sur cette notion de paramètres. Nous allons ici illustrer leur utilisation pour la langue.

Les paramètres SDX ont nécessairement un nom ; pour la langue, le nom du paramètre concerné est lang. Ensuite, SDX prévoit cinq façons de spécifier la valeur d'un paramètre. Ces façons sont dans l'ordre de priorité :

Nous pouvons tout de suite signaler que, pour la langue, il n'y a pas de valeur par défaut dans SDX. Cet aspect importe peu, car la langue de l'application (définie dans le application.xconf) joue le rôle de valeur par défaut. Nous devons également mentionner que l'utilisation d'une valeur explicite d'un paramètre n'apporte rien par rapport à l'utilisation de l'attribut xml:lang dans la page XSP, tel que mentionné plus haut.

Ce paramètre code doit nécessairement être associé à l'élément sdx:page. L'exemple suivant illustre les différentes façons de le faire :

<!--
Valeur explicite 
-->
<sdx:page lang="fr">

<!--
Valeur provenant de l'objet de 
session dont la clé est "langue"
-->
<sdx:page langSession="langue">

<!--
Valeur provenant d'un paramètre 
HTTP "l" (par exemple l'URL test.xsp?l=fr)
-->
<sdx:page langParam="l">

<!--
Valeur provenant d'une variable 
Java de type String préalablement définie
-->
<xsp:logic>
  String l = "fr";
</xsp:logic>
<sdx:page langString="l">

Ces exemples utilisent tous la méthode des attributs pour identifier un paramètre. Mais SDX offre une seconde méthode : celle des sous-éléments sdx:parameter permettant de spécifier des paramètres. Ainsi, il est possible de remplacer le troisième exemple ci-dessus par ce code :

<sdx:page>
  <sdx:parameter name="lang" valueParam="l"/>

Cette méthode des paramètres est très souple. Elle est d'ailleurs nécessaire pour créer de véritables applications Web dynamiques et multilingues. Par exemple, il est possible d'ajouter à toutes les URL de l'interface le paramètre l, de lui donner une valeur de langue et dans la page XSP utiliser l'attribut langParam="l" pour ainsi toujours avoir une valeur appropriée comme langue d'interface.

Toutefois, cette approche comporte un inconvénient : le développeur doit toujours faire attention à inclure le paramètre l dans les liens hypertextes, ce qui est sujet à erreur. Une solution est de stocker cette valeur dans un objet de session. Ainsi, une fois que l'objet de session est défini, SDX peut l'exploiter. Pour y arriver, il s'agit tout simplement d'utiliser ceci dans les pages XSP :

<sdx:page langSession="l" langParam="l">

Mettre ces deux indications n'est pas contradictoire. Au contraire, puisque SDX définit une priorité : le paramètre d'URL (attribut langParam) est prioritaire sur l'objet de session, mais cette priorité n'est exploitée que s'il y a effectivement ce paramètre dans l'URL. De plus, s'il est présent, alors, non seulement SDX l'utilise, mais en plus il va conserver sa valeur en objet de session, à cause de la présence de l'attribut langSession avec la même valeur que celle de l'attribut langParam.

Cette caractéristique des paramètres SDX est problablement celle qui permet la plus grande souplesse et aussi la plus grande simplicité pour la gestion de la langue. Nous allons l'illustrer avec un exemple.

Deux attributs peuvent être utilisés pour spécifier directement quel analyseur de mots utiliser : analyzerClass et analyzerConf. Ces attributs peuvent être associés à l'élément sdx:field, et dans ce cas ils identifient l'analyseur de mots du champ en question, ou encore ils peuvent être associés à l'élément sdx:fieldList, et dans ce cas ils identifient l'analyseur de mots par défaut pour la base de documents.

L'attribut analyzerClass indique tout simplement la classe à utiliser comme analyseur ; tel qu'indiqué ci-dessus, cette classe doit étendre la classe fr.gouv.culture.sdx.search.lucene.analysis.Analyzer et bien entendu elle doit être disponible dans le CLASSPATH Java.

L'attribut analyzerConf donne la localisation du fichier de configuration pour l'analyseur de mots. La valeur de l'attribut est une URL, absolue ou relative au fichier application.xconf. Si cet attribut est omis, la configuration par défaut de l'analyseur est utilisée. Il est à noter que cet attribut peut également spécifier un fichier de configuration dans le cas où l'analyseur de mots est spécifié de manière indirecte.

Il est aussi possible de spécifier un analyseur de mots indirectement, c'est-à-dire en précisant la langue du contenu du champ ou de l'ensemble des champs de la base de documents. Ainsi, si on utilise les attributs xml:lang et variant avec les éléments sdx:field (pour un champ en particulier) ou sdx:fieldList (comme valeur par défaut pour tous les champs de la base de documents), SDX tentera de trouver un analyseur de mots adéquat pour cette langue.

<sdx:field ... xml:lang="fr-CA" variant="qc"/>

Lorsqu'aucun analyseur n'est spécifié pour un champ ou une base de documents, SDX utilise l'analyseur fr.gouv.culture.sdx.search.lucene.analysis.DefaultAnalyzer. Il s'agit d'un analyseur de mots pour la langue anglaise. Il est également utilisé si un champ déclare indirectement un analyseur qui n'est pas disponible avec SDX.