Argomento precedente: Creazione di un nuovo adapter personalizzato mediante l'interfaccia SDKArgomento successivo: Configurazione del nuovo adapter di ricerca personalizzato con il componente CAFedSearch


Compilazione dei file JAR per il nuovo adapter personalizzato

Compilare i file JAR del nuovo adapter personalizzato.

Procedere come descritto di seguito:

  1. Compilare il nuovo adapter di ricerca personalizzato. Verificare i seguenti file JAR siano disponibili nel Classpath di Java:
    jsr311-api-1.0.jar

    Questo file JAR è disponibile nella directory di CA SDM:

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

    Questo file è disponibile nella directory:

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

    Questo file è disponibile nella directory:

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

    Questo file è disponibile nella directory:

    %NX_ROOT%\java\lib
    
  2. Eseguire la scrittura di una nuova classe Java per estendere la classe SearchAdapter e fornire l'implementazione del metodo astratto.
    search
    

    Il componente CAFedSearch richiama e trasmette i parametri del metodo di ricerca. Questi parametri sono integrati all'interno del parametro SearchOptions per ciascuna richiesta di ricerca dal client.

    Nota: Verificare che l'implementazione sia thread-safe in quanto il componente CAFedSearch è in grado di gestire unicamente un'istanza della classe Java. Per ciascuna operazione di ricerca, il metodo di ricerca viene richiamato sulla stessa istanza.

  3. Il parametro SearchOptions per il metodo di ricerca comprende i metodi seguenti:
    getSearchTerms()

    Specifica il metodo per il recupero della stringa di ricerca.

    getStartIndex()

    Specifica il metodo di indicizzazione iniziale, il numero in base al quale il client desidera cercare gli elementi. L'indice inizia da 1.

    getItemsPerPage()

    Specifica il numero massimo di risultati della ricerca previsti dal client.

    Nota: È possibile utilizzare anche altri metodi di classe Java. Ad esempio: getUserId()

  4. Inviare le informazioni raccolte all'API del motore di ricerca esterno per recuperare i risultati della ricerca.

    Nota: Per informazioni sui metodi di classe Java, consultare la documentazione di Java.

  5. Il metodo di ricerca restituisce un'istanza della classe ResultCollection. Creare un'istanza di ResultCollection e inserire i valori mediante i metodi seguenti:
    setSources(String name)

    Specifica il nome dell'adapter di ricerca. I nomi rispettano la distinzione tra maiuscole e minuscole e devono corrispondere esattamente al nome specificato nel file di configurazione dell'utilità. Per comodità, SearchAdapter fornisce un metodo getName() da utilizzare.

    Ad esempio:

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

    Specifica il numero totale dei risultati di ricerca.

    setStartIndex(int startIndex)

    Specifica un indice iniziale dei risultati. Questo valore si basa sui risultati forniti dal motore di ricerca.

    results.setStartIndex(startIndex);
    
  6. È necessario trasmettere la raccolta di ResultItems all'oggetto ResultCollection chiamando il metodo setSearchResultItems. Per aggiungere un'istanza di ResultItem alla volta, utilizzare il metodo addSearchResultItem().

    Nota: Per ulteriori informazioni sulla classe Java di ResultCollection, consultare la documentazione di Java.

  7. La classe ResultItem presenta i seguenti metodi importanti, che vanno riempiti per ciascun elemento dei risultati della ricerca (riga).
    setContentText(String txt)

    Specifica un metodo per impostare il contenuto effettivo dei risultati di ricerca.

    setContentHTML(String txt)

    Specifica un metodo per impostare il contenuto HTML (può contenere i tag HTML). Se il motore di ricerca restituisce l'HTML evidenziato, impostare il testo evidenziato mediante questo metodo.

    Nota: Se il motore di ricerca non dispone di questa funzionalità, è possibile scrivere un metodo semplice di classe Java per evidenziare il testo. L'adapter CA Open Space dispone di un metodo semplice con termini in grassetto nei risultati di ricerca.

    setTitleHTML(String titleHTML)

    Metodo per impostare un titolo HTML (può contenere tag HTML).

    setTitleText(String titleText)

    Metodo per impostare un titolo normale (non può contenere tag HTML).

    setSource(String source)

    Metodo per impostare l'attributo di origine. Un'attivazione tipica sarebbe setSource(getName()); per un elemento

    Nota: Se l'adapter di ricerca richiede più file JAR, personalizzare il file build.xml per compilare e preparare un file JAR per l'adapter. È necessario disporre di Ant binari per utilizzare il file build.xml. Usare Ant per eseguire le destinazioni nel file build.xml per compilare e creare i file JAR. Conservare il file build.xml insieme alla cartella di origine (src). Il file build.properties è facoltativo. Per ulteriori informazioni su binari Ant, consultare la Guida in linea di Ant.

    Il file JAR è stato correttamente compilato.