<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head profile="http://internetalchemy.org/2003/02/profile">
<link rel="foaf" type="application/rdf+xml" title="FOAF" href="http://www.openlinksw.com/dataspace/uda/about.rdf" />
<link rel="schema.dc" href="http://purl.org/dc/elements/1.1/" />
<meta name="dc.title" content="Function: AP_BUILD_MATCH_LIST - Virtuoso Functions Guide" />
<meta name="dc.subject" content="Function: AP_BUILD_MATCH_LIST - Virtuoso Functions Guide" />
<meta name="dc.creator" content="OpenLink Software Documentation Team ; " />
<meta name="dc.copyright" content="OpenLink Software, 1999 - 2009" />
<link rel="top" href="index.html" title="OpenLink Virtuoso Universal Server: Documentation" />
<link rel="search" href="/doc/adv_search.vspx" title="Search OpenLink Virtuoso Universal Server: Documentation" />
<link rel="parent" href="functions.html" title="Chapter Contents" />
<link rel="prev" href="appendixa.html" title="Appendix" />
<link rel="next" href="functions.html#.html" title="" />
<link rel="shortcut icon" href="../images/misc/favicon.ico" type="image/x-icon" />
<link rel="stylesheet" type="text/css" href="doc.css" />
<link rel="stylesheet" type="text/css" href="/doc/translation.css" />
<title>Function: AP_BUILD_MATCH_LIST - Virtuoso Functions Guide</title>
<meta http-equiv="Content-Type" content="text/xhtml; charset=UTF-8" />
<meta name="author" content="OpenLink Software Documentation Team ; " />
<meta name="copyright" content="OpenLink Software, 1999 - 2009" />
<meta name="keywords" content="" />
<meta name="GENERATOR" content="OpenLink XSLT Team" />
</head>
<body>
<div id="header">
<a name="fn_ap_build_match_list" />
<img src="../images/misc/logo.jpg" alt="" />
<h1>22. Virtuoso Functions Guide - AP_BUILD_MATCH_LIST</h1>
</div>
<div id="navbartop">
<div>
<a class="link" href="functions.html">Chapter Contents</a> | <a class="link" href="fn_ann_phrase_class_del.html" title="DB.DBA.ANN_PHRASE_CLASS_DEL">Prev</a> | <a class="link" href="fn_ap_add_phrases.html" title="AP_ADD_PHRASES">Next</a>
</div>
</div>
<div id="currenttoc">
<form method="post" action="/doc/adv_search.vspx">
<div class="search">Keyword Search: <br />
<input type="text" name="q" /> <input type="submit" name="go" value="Go" />
</div>
</form>
<div>
<a href="http://www.openlinksw.com/">www.openlinksw.com</a>
</div>
<div>
<a href="http://docs.openlinksw.com/">docs.openlinksw.com</a>
</div>
<br />
<div>
<a href="index.html">Book Home</a>
</div>
<br />
<div>
<a href="contents.html">Contents</a>
</div>
<div>
<a href="preface.html">Preface</a>
</div>
<br />
<div>
<a class="selected" href="functions.html">Virtuoso Functions Guide</a>
</div>
<br />
<div>
<a href="functions.html#admin">Administration</a>
</div>
<div>
<a href="functions.html#aggr">Aggregate Functions</a>
</div>
<div>
<a href="functions.html#array">Array Manipulation</a>
</div>
<div>
<a href="functions.html#bpel">BPEL APIs</a>
</div>
<div>
<a href="functions.html#backup">Backup</a>
</div>
<div>
<a href="functions.html#compression">Compression</a>
</div>
<div>
<a href="functions.html#cursors">Cursor</a>
</div>
<div>
<a href="functions.html#time">Date & Time Manipulation</a>
</div>
<div>
<a href="functions.html#debug">Debug</a>
</div>
<div>
<a href="functions.html#dict">Dictionary Manipulation</a>
</div>
<div>
<a href="functions.html#encoding">Encoding & Decoding</a>
</div>
<div>
<a href="functions.html#file">File Manipulation</a>
</div>
<div>
<a href="functions.html#ft">Free Text</a>
</div>
<div>
<a href="functions.html#hash">Hashing / Cryptographic</a>
</div>
<div>
<a href="functions.html#ldap">LDAP</a>
</div>
<div>
<a href="functions.html#localization">Locale</a>
</div>
<div>
<a href="functions.html#mail">Mail</a>
</div>
<div>
<a href="functions.html#misc">Miscellaneous</a>
</div>
<div>
<a href="functions.html#number">Number</a>
</div>
<div>
<a class="selected" href="functions.html#phrz">Phrases</a>
</div>
<div class="selected">
<div>
<a href="fn_ap_add_phrases.html">ap_add_phrases</a>
</div>
<div>
<a class="selected" href="fn_ap_build_match_list.html">ap_build_match_list</a>
</div>
<div>
<a href="fn_ann_phrase_class_add.html">db.dba.ann_phrase_cl...</a>
</div>
<div>
<a href="fn_ann_phrase_class_del.html">db.dba.ann_phrase_cl...</a>
</div>
</div>
<div>
<a href="functions.html#rdf">RDF data</a>
</div>
<div>
<a href="functions.html#rmt">Remote SQL Data Source</a>
</div>
<div>
<a href="functions.html#repl">Replication</a>
</div>
<div>
<a href="functions.html#soap">SOAP</a>
</div>
<div>
<a href="functions.html#sql">SQL</a>
</div>
<div>
<a href="functions.html#string">String</a>
</div>
<div>
<a href="functions.html#txn">Transaction</a>
</div>
<div>
<a href="functions.html#type">Type Mapping</a>
</div>
<div>
<a href="functions.html#uddi">UDDI</a>
</div>
<div>
<a href="functions.html#udt">User Defined Types & The CLR</a>
</div>
<div>
<a href="functions.html#vad">VAD</a>
</div>
<div>
<a href="functions.html#jvmpl">Virtuoso Java PL API</a>
</div>
<div>
<a href="functions.html#bif">Virtuoso Server Extension Interface (VSEI)</a>
</div>
<div>
<a href="functions.html#ws">Web & Internet</a>
</div>
<div>
<a href="functions.html#xml">XML</a>
</div>
<div>
<a href="functions.html#XPATH">XPATH & XQUERY</a>
</div>
<br />
<div>
<a href="functionidx.html">Functions Index</a>
</div>
<br />
</div>
<div id="text">
<h2>AP_BUILD_MATCH_LIST</h2>
<div class="refpurpose">Returns report of all occurrences of phrases from the specified sets in the text.</div>
<div class="funcsynopsis">
<span class="funcdef">
<span class="function">AP_BUILD_MATCH_LIST</span>
</span>
(<span class="paramdef">in <span class="parameter">phrase_set_ids</span> vector of integers</span>,
<span class="paramdef">in <span class="parameter">source_UTF8_text</span> varchar not null</span>,
<span class="paramdef">in <span class="parameter">lang_name</span> varchar not null</span>,
<span class="paramdef">in <span class="parameter">source_text_is_html</span> integer</span>,
<span class="paramdef">in <span class="parameter">report_flags</span> integer</span>);
</div>
<div class="refsect1">
<div class="refsect1title">Description</div>
<p>Forms a report that lists all occurrences of phrases from the specified sets in the text.</p>
<p>The report describes "phrase hits", i.e. occurrences of annotation phrases in the
text, using "arrows" that point to specific fragments in the text, such as words of found phrases or HTML
tags.</p>
<p>The structure of the report is complicated, due to contradiction in requirements.
It is compact to provide reasonable performance and scalability, so common data should not be repeated,
saving memory. It is complete enough to prevent application from reading omitted data from system tables,
saving time.</p>
<p>All objects of one type are listed as items of some vector and the whole report consists of several
such vectors. An item in one vector may refer to item in other vector by its index, without storing a
local copy.</p>
<p>Detailed description of the report structure can be found
<a href="sqlreffastphrasematch.html#sqlreffastphrasematchapi">here</a>
</p>.
</div>
<div class="refsect1">
<div class="refsect1title">Parameters</div>
<div class="refsect2">
<span class="refsect2title">phrase_set_ids – </span>
vector of numeric identifiers of phrase sets at work, they may belong to various phrase classes,
but if language of some phrase set differs from value of lang_name argument then the phrase set is
silently ignored.
</div>
<div class="refsect2">
<span class="refsect2title">source_UTF8_text – </span>
a plain text or an HTML
</div>
<div class="refsect2">
<span class="refsect2title">lang_name – </span>
language name
</div>
<div class="refsect2">
<span class="refsect2title">source_text_is_html – </span>
0 for plain text, 1 for standard-compliant HTML or 2 for "dirty" HTML
</div>
<div class="refsect2">
<span class="refsect2title">report_flags – </span>
</div>
</div>
<div class="refsect1">
<div class="refsect1title">Examples</div>
<a name="ex_ap_build_match_list" />
<div class="example">
<div class="exampletitle" />
<p>Usage example can be found <a href="sqlreffastphrasematch.html#sqlreffastphraseexample">here</a>.</p>
</div>
</div>
<div class="refsect1">
<div class="refsect1title">See Also</div>
<p>
<a href="fn_ann_phrase_class_add.html">DB.DBA.ANN_PHRASE_CLASS_ADD</a>
</p>
<p>
<a href="fn_ann_phrase_class_del.html">DB.DBA.ANN_PHRASE_CLASS_DEL</a>
</p>
</div>
</div>
<div id="footer">
<div>Copyright© 1999 - 2009 OpenLink Software All rights reserved.</div>
<div id="validation">
<a href="http://validator.w3.org/check/referer">
<img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" />
</a>
<a href="http://jigsaw.w3.org/css-validator/">
<img src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!" height="31" width="88" />
</a>
</div>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
71d40963b505df4524269198e237b3e3
>
files
>
149
