IBM Books
(C) IBM Corp. 2000

Manual de administración y del usuario de DB2 Net Search Extender

DB2EXT.HIGHLIGHT

Utilice la función db2ext.highlight para obtener información sobre por qué un documento se ha calificado como resultado de la búsqueda. Más concretamente, ésta se puede utilizar para:

Tenga en cuenta que la función db2ext.highlight sólo se puede utilizar con la función de valor de tabla db2ext.textsearch. La función de valor de tabla realiza una búsqueda en el índice y proporciona los resultados que la función HIGHLIGHT debe utilizar.

Para obtener información sobre el uso de la función db2ext.textsearch, vea DB2EXT.TEXTSEARCH.

Sintaxis de la función

>>-db2ext.highlight--------------------------------------------->
 
>--(--contenido-documento--,--información-coincidencia--,--información-proceso-coincidencias--)-><
 
 

Parámetros de la función

Los siguientes son parámetros de entrada:

contenido de documento CLOB (100 K)
Sólo reciben soporte los documentos UTF8 en formato TEXT o XML. Para aumentar este valor, consulte la sección DB2EXTHL (programa de utilidad).

información de coincidencias BLOB (20 K)
Serie que contiene información de coincidencias. La devuelva la función db2ext.textsearch, si se ha especificado el parámetro numberOfHits.

información de proceso de coincidencias VARCHAR(1024)
Este parámetro es una lista de pares de valores de opción separados por comas ',' con cada carácter de la serie entre comillas dobles " ". Especifica cómo se debe realizar el resaltado para el documento especificado. Si no se especifica ninguna de las opciones, se devuelve el documento original.

TAGS = ("STRING", "STRING")
Esta opción permite que el usuario especifique los identificadores que se deben insertar antes y después de una coincidencia en el documento. Si esta opción se omite, no se añadirán identificadores antes y después de una coincidencia en el documento.

WINDOW_NUMBER = INTEGER
Esta opción especifica cuántas partes (o ventanas) del documento debe devolver la función de resaltado. Cada ventana contiene una o más coincidencias y la primera coincidencia de cada ventana determina la parte del documento devuelta al usuario. Estas coincidencias pueden tener texto alrededor o no tenerlo.

Si esta opción se omite, se tomará 0 como valor por omisión y se devolverá todo el documento con identificadores iniciales y finales (si se especifican). En este caso, la opción WINDOW_SIZE se pasa por alto.

WINDOW_SIZE = INTEGER
Esta opción especifica el tamaño recomendado de la ventana en bytes. Este tamaño real puede variar, según el número de coincidencias, la longitud de las coincidencias y los tamaños de los identificadores iniciales y finales. Se esta opción se omite, el valor por omisión será 0 y sólo se devolverán coincidencias con el texto circundante.

WINDOW_SEPARATOR = "STRING"
Esta opción especifica el identificador utilizado para separar una ventana de la siguiente ventana. Si la opción se omite, el valor por omisión será "...".

FORMAT = "STRING"
Esta opción especifica el formato del documento. Los valores válidos son XML o TEXT. Si esta opción se omite, se tomará TEXT como valor por omisión. Asegúrese de que el valor del formato es el mismo que el que se ha especificado durante la indexación.

MODEL_NAME = "STRING"
Esta opción especifica el nombre de modelo relacionado con el documento XML especificado. Tenga en cuenta que, si el valor de FORMAT es TEXT, esta opción tendrá como resultado una condición de error.

SECTIONS = ("nombre-sección1", ..., "nombre-secciónN")
En el caso de los documentos XML, el resaltado se puede restringir a secciones relevantes. Por ejemplo, se pueden definir en el archivo de modelos. Para especificar estas secciones, separe los nombres de las secciones con una coma. Si esta opción se omite, el resaltado se llevará a cabo en todo el documento XML. Tenga en cuenta que, si el valor de FORMAT es TEXT, esta opción se pasará por alto.

Parámetros de la función

Los siguientes son parámetros de retorno.

CLOB (200 K)
La función de resaltado devuelve un valor CLOB que contiene las partes del documento modificadas por la función de resaltado.

Uso

El ejemplo siguiente muestra cómo utilizar la función HIGHLIGHT:

select p.id,
       p.title,
       db2ext.highlight(p.content,
       t.hitinformation, 
       'TAGS = ("<bf>", "</bf>"),
       WINDOWS_NUMBER = 5,
       WINDOWS_SIZE = 200,
       WINDOW_SEPARATOR = "...",
       FORMAT = "XML", 
       SECTIONS = ("nombre-sección1", "nombre-sección2")')
 
FROM patent p, table (db2ext.textsearch(
       '"sistemas de bases de datos relacionales"',
         'DB2EXT',
       'TI_FOR_CONTENT',
       0,
         20,
       CAST(NULL as BIGINT),
       15)) t
 
WHERE p.id = t.primkey

La utilización de documentos de más de 100 KB hará que la consulta SQL termine y produzca un error de SQL (SQL 1476N y el error de SQL -433). Para evitar estos errores, utilice el mandato db2exthl para aumentar el tamaño de contenido del documento. Para obtener información, consulte la sección DB2EXTHL (programa de utilidad).

Nota

Los caracteres especiales como, por ejemplo, los caracteres de "nueva línea", se devuelven tal cual.

Restricciones


[ Principio de página | Página anterior | Página siguiente | Contenido | Índice ]