Onix Text Retrieval Toolkit
API Reference

API
Function List
Topical List

Main Index

Introduction
Calling Sequences
Query Processing
Relevancy Ranking
Data Types
Error Handling
   
Support
   
Lextek Products
Onix Text Retrieval Engine
Lextek Document Profiler & Categorizer
Brevity Document Summarizer
RouteX Routing Engine
Language Identifier

ixCreateHighlightMatcher

Name

ixCreateHighlightMatcher

Synopsis

ixCreateHighlightMatcher(StatusCodeT *Status)

Arguments

Status: A pointer to a value of type StatusCodeT representing any error conditions.

Returns

A matcher which can be used with query term highlighting of type HighlightMatcherT.

If an error occurred, Status will be set to the error number.

Description

If you are interested in highlighting the terms in a piece of text which match a query, the HighlightMatcher is the best tool for the job.  Simply create the highlight matcher, add the terms to the matcher which are in the query using ixAddWildCardPatternToHighlightMatcher. To highlight the query terms in the text which match your query, you will need to reparse the text and then test the words against the HighlightMatcher using ixHighlightMatcherMatch.  If the word matches, then you may highlight it.  Another alternative for query term highlighting is to use word level indexes.  You will still need to reparse the text but the query term numbers are stored in the Query Vector instead.  (Which lets you avoid the matching process.)

See Also

Highlighting
ixDeleteHighlightMatcher, ixAddWildCardPatternToHighlightMatcher, ixHighlightMatcherMatch