Rubrique précédente: Création d'un adaptateur personnalisé à l'aide de l'interface du SDKRubrique suivante: Configuration du nouvel adaptateur de recherche personnalisée avec le composant CAFedSearch


Compilation des fichiers Jar du nouvel adaptateur personnalisé

Compilez les fichiers Jar de l'adaptateur de recherche personnalisée.

  1. Compilez les nouveaux adaptateurs de recherche personnalisée. Vérifiez que les fichiers jar suivants se trouvent bien dans le paramètre classpath Java :
    jsr311-api-1.0.jar

    Ce fichier jar se trouve dans le répertoire CA SDM :

    %NX_ROOT%\java\lib\CXF\
    
    cafedsearch-core.jar

    Ce fichier se trouve dans le répertoire suivant :

    %NX_ROOT%\bopcfg\www\CATALINA_BASE_FS\webapps\cafedsearch\WEB-INF\lib
    
    cafedsearch-adapter-sdk-1.0.0.jar

    Ce fichier se trouve dans le répertoire suivant :

    %NX_ROOT%\bopcfg\www\CATALINA_BASE_FS\webapps\cafedsearch\WEB-INF\lib
    
    log4j-1.2.15.jar (facultatif)

    Ce fichier se trouve dans le répertoire suivant :

    %NX_ROOT%\java\lib
    
  2. Écrivez une nouvelle classe Java qui étend la classe SearchAdapter et fournit une mise en oeuvre pour la méthode abstraite.
    recherche
    

    Le composant CAFedSearch appelle et transmet les paramètres de méthode de recherche. Ces paramètres sont intégrés dans le paramètre SearchOptions pour chaque requête de recherche du client.

    Remarque : Vérifiez que votre mise en oeuvre garantit la sécurité des threads, car le composant CAFedSearch conserve une seule instance de votre classe Java. Pour chaque opération de recherche, la méthode de recherche est appelée sur la même instance.

  3. Le paramètre SearchOptions de la méthode de recherche est associé aux méthodes suivantes :
    getSearchTerms()

    Indique la méthode de récupération de la chaîne de recherche.

    getStartIndex()

    Indique la méthode d'index de début, c'est-à-dire le nombre à partir duquel le client veut rechercher des éléments. L'index débute à 1.

    getItemsPerPage()

    Indique le nombre maximal de résultats de recherche attendus par le client.

    Remarque : Vous pouvez également utiliser d'autres méthodes de classe Java. Par exemple, getUserId()

  4. Envoyez les données collectées à l'API du moteur de recherche externe pour récupérer les résultats de recherche.

    Remarque : Pour de plus amples renseignements sur les méthodes de classe, reportez-vous à la documentation Java.

  5. La méthode recherche retourne une instance de la classe ResultCollection. Créez une instance de ResultCollection et utilisez la méthode suivante pour y inscrire les valeurs requises :
    setSources(String name)

    Spécifie le nom de l'adaptateur de recherche. Les noms sont sensibles à la casse et doivent être en tout point identiques au nom fourni dans le fichier de configuration de l'utilitaire. Pour des raisons pratiques, SearchAdapter fournit la méthode getName() qui doit être utilisée.

    Par exemple :

    results.setSources(getName());
    
    setTotalResults (int total)

    Indique le nombre total de résultats de recherche.

    setStartIndex(int startIndex)

    Indique l'index de début des résultats. Cette valeur est fonction des résultats tirés de votre moteur de recherche.

    results.setStartIndex(startIndex);
    
  6. Un ensemble de ResultItems doit être transféré vers l'objet ResultCollection en appelant la méthode setSearchResultItems. Pour ajouter une instance de ResultItem à la fois, utilisez la méthode addSearchResultItem().

    Remarque : Pour de plus amples renseignements sur la classe Java ResultCollection, reportez-vous à la documentation Java.

  7. La classe ResultItem inclut les méthodes suivantes, dont les champs doivent être remplis pour chaque élément de résultat de la recherche (ligne).
    setContentText(String txt)

    Indique une méthode de définition du contenu réel des résultats de recherche.

    setContentHTML(String txt)

    Indique une méthode de définition du contenu HTML (peut contenir des balises HTML). Si le moteur de recherche renvoie du contenu HTML en surbrillance, définissez le texte en surbrillance à l'aide de cette méthode.

    Remarque : Si votre moteur de recherche n'offre pas cette option, vous pouvez écrire une méthode de classe Java simple pour mettre le texte en surbrillance. L'adaptateur CA Open Space propose une méthode simple pour mettre des termes en gras dans les résultats de recherche.

    setTitleHTML(String titleHTML)

    Méthode pour définir un titre en HTML (peut contenir des balises HTML).

    setTitleText(String titleText)

    Méthode pour définir un titre brut (ne peut pas contenir de balises HTML).

    setSource(String source)

    Méthode pour définir l'attribut source. Un appel simple pourrait être un élément setSource(getName());

    Remarque : Si l'adaptateur de recherche requiert d'autres fichiers jar, personnalisez le fichier build.xml pour compiler et préparer un fichier jar de l'adaptateur. Les fourmis binaires sont requises pour créer le fichier build.xml. Utilisez Ant pour exécuter les cibles dans build.xml afin de compiler et de préparer les fichiers jar. Maintenez le fichier build.xml avec votre dossier source (src). Le fichier build.properties est facultatif. Pour de plus amples renseignements sur les binaires de Ant, reportez-vous à l'Aide de Ant.

    Le fichier jar a été correctement compilé.