Tema anterior: Creación de un nuevo adaptador personalizado mediante la interfaz del SDKTema siguiente: Configuración del nuevo adaptador de búsqueda personalizado con el componente de CAFedSearch


Recopilación de los archivos jar del nuevo adaptador personalizado

Recopile los archivos jar del adaptador personalizado correctamente.

Siga estos pasos:

  1. Recopile los nuevos adaptadores de búsqueda personalizados. Asegúrese de contar con los siguientes archivos jar en Java Classpath:
    jsr311-api-1.0.jar

    Este archivo jar está disponible en el directorio de CA SDM:

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

    Este archivo está disponible en este directorio:

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

    Este archivo está disponible en este directorio:

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

    Este archivo está disponible en este directorio:

    %NX_ROOT%\java\lib
    
  2. Escriba una nueva clase Java que extienda la clase SearchAdapter y proporcione una implementación para el método abstracto.
    buscar
    

    El componente CAFedSearch invoca y pasa parámetros del método de búsqueda. Estos parámetros se incrustan en el parámetro SearchOptions para cada solicitud de búsqueda del cliente.

    Nota: Asegúrese de que la implementación es segura en cuanto a subprocesos, ya que el componente de CAFedSearch solamente mantiene una instancia de la clase Java. Para cada operación de búsqueda, se invoca el método de búsqueda en la misma instancia.

  3. El parámetro SearchOptions para el método de búsqueda tiene los siguientes métodos:
    getSearchTerms()

    Especifica el método para recuperar la cadena de búsqueda.

    getStartIndex()

    Especifica el método de índice de inicio, el número desde el que el cliente desea buscar elementos. El índice empieza en 1.

    getItemsPerPage()

    Especifica el número máximo de resultados de la búsqueda que espera el cliente.

    Nota: También se pueden utilizar otros métodos de clase Java. Por ejemplo: getUserId().

  4. Envíe la información recolectada a la API del motor de búsqueda externo para recuperar los resultados de la búsqueda.

    Nota: Para obtener más información sobre los métodos de la clase Java, consulte la documentación de Java.

  5. El método de búsqueda devuelve una instancia de la clase ResultCollection. Cree una instancia de ResultCollection y rellene los valores con estos métodos:
    setSources(String name)

    Especifica el nombre del adaptador de búsqueda. Los nombres distinguen entre mayúsculas y minúsculas y deben coincidir exactamente con el nombre que se proporciona en el archivo de configuración de la utilidad. Por comodidad, SearchAdapter proporciona un método getName() que se debe utilizar.

    Por ejemplo:

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

    Especifica el recuento total de resultados de la búsqueda.

    setStartIndex(int startIndex)

    Especifica un índice de inicio de resultados. Este valor varía según los resultados del motor de búsqueda.

    results.setStartIndex(startIndex);
    
  6. La recolección de ResultItems debe pasarse al objeto ResultCollection mediante la llamada del método setSearchResultItems. Para agregar una instancia de ResultItem cada vez, utilice el método addSearchResultItem().

    Nota: Para obtener más información sobre la clase Java ResultCollection, consulte la documentación de Java.

  7. La clase ResultItem tiene los siguientes métodos importantes, que se deberán rellenar para cada elemento (fila) del resultado de la búsqueda.
    setContentText(String txt)

    Especifica un método para establecer el contenido real de resultados de la búsqueda.

    setContentHTML(String txt)

    Especifica un método para establecer el contenido HTML (puede incluir etiquetas HTML). Si el motor de búsqueda proporciona HTML resaltado, debe definirse el texto resaltado con este método.

    Nota: Si el motor de búsqueda no tiene esta función, se puede escribir un método simple para resaltar el texto. El adaptador de CA Open Space tiene un método simple para resaltar términos en negrita en los resultados de la búsqueda.

    setTitleHTML(String titleHTML)

    Método para establecer un título HTML (puede incluir etiquetas HTML).

    setTitleText(String titleText)

    Método para establecer un título sin formato (no puede incluir etiquetas HTML).

    setSource(String source)

    Método para establecer el atributo fuente. Una invocación típica sería un elemento setSource(getName());.

    Nota: Si el adaptador de búsqueda requiere más archivos jar, personalice el archivo build.xml para recopilar y preparar un archivo jar del adaptador. Se requieren binarios ant para utilizar el archivo build.xml. Utilice Ant para ejecutar los objetivos en build.xml con el fin de recopilar y crear archivos JAR. Mantenga el archivo build.xml con la carpeta fuente (src). El archivo build.properties es opcional. Para obtener más información sobre binarios Ant, consulte la ayuda de Ant.

    El archivo jar se ha recopilado correctamente.