| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| <meta name="keywords" content="SMILA/Documentation/Search,SMILA/Documentation/BPEL Workflow Processor,SMILA/Documentation/Solr,SMILA/Documentation for 5 Minutes to Success" /> |
| <link rel="shortcut icon" href="http://wiki.eclipse.org/SMILA/Documentation/2011.Simplification/favicon.ico" /> |
| <link rel="search" type="application/opensearchdescription+xml" href="http://wiki.eclipse.org/opensearch_desc.php" title="Eclipsepedia (English)" /> |
| <link rel="alternate" type="application/rss+xml" title="Eclipsepedia RSS Feed" href="http://wiki.eclipse.org/index.php?title=Special:Recentchanges&feed=rss" /> |
| <link rel="alternate" type="application/atom+xml" title="Eclipsepedia Atom Feed" href="http://wiki.eclipse.org/index.php?title=Special:Recentchanges&feed=atom" /> |
| |
| |
| <title>SMILA/Documentation/Search - Eclipsepedia</title> |
| |
| <style type="text/css" media="screen,projection">/*<![CDATA[*/ @import "http://wiki.eclipse.org/skins/eclipsenova/novaWide.css?116"; /*]]>*/</style> |
| <link rel="stylesheet" type="text/css" media="print" href="http://wiki.eclipse.org/skins/eclipsenova/eclipsenovaPrint.css?116" /> |
| <link rel="stylesheet" type="text/css" media="handheld" href="http://wiki.eclipse.org/skins/eclipsenova/handheld.css?116" /> |
| <link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/Nova/css/header.css" media="screen" /> |
| <link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/tabs.css" media="screen" /> |
| <link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/Nova/css/visual.css" media="screen" /> |
| <link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/Nova/css/layout.css" media="screen" /> |
| <link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/Nova/css/footer.css" media="screen" /> |
| <!--[if IE]><link rel="stylesheet" type="text/css" href="/skins/eclipsenova/IEpngfix.css" media="screen" /><![endif]--> |
| <!--[if lt IE 5.5000]><style type="text/css">@import "/skins/eclipsenova/IE50Fixes.css?116";</style> <![endif]--> |
| <!--[if IE 5.5000]><style type="text/css">@import "/skins/eclipsenova/IE55Fixes.css?116";</style><![endif]--> |
| <!--[if IE 6]><style type="text/css">@import "/skins/eclipsenova/IE60Fixes.css?116";</style><![endif]--> |
| <!--[if IE 7]><style type="text/css">@import "/skins/eclipsenova/IE70Fixes.css?116";</style><![endif]--> |
| <!--[if lt IE 7]><script type="text/javascript" src="/skins/common/IEFixes.js?116"></script> |
| <meta http-equiv="imagetoolbar" content="no" /><![endif]--> |
| <script type= "text/javascript">/*<![CDATA[*/ |
| var skin = "eclipsenova"; |
| var stylepath = "/skins"; |
| var wgArticlePath = "/$1"; |
| var wgScriptPath = ""; |
| var wgScript = "/index.php"; |
| var wgServer = "http://wiki.eclipse.org"; |
| var wgCanonicalNamespace = ""; |
| var wgCanonicalSpecialPageName = false; |
| var wgNamespaceNumber = 0; |
| var wgPageName = "SMILA/Documentation/Search"; |
| var wgTitle = "SMILA/Documentation/Search"; |
| var wgAction = "view"; |
| var wgRestrictionEdit = []; |
| var wgRestrictionMove = []; |
| var wgArticleId = "18950"; |
| var wgIsArticle = true; |
| var wgUserName = null; |
| var wgUserGroups = null; |
| var wgUserLanguage = "en"; |
| var wgContentLanguage = "en"; |
| var wgBreakFrames = false; |
| var wgCurRevisionId = "301040"; |
| var wgVersion = "1.12.0"; |
| var wgEnableAPI = true; |
| var wgEnableWriteAPI = false; |
| /*]]>*/</script> |
| |
| <script type="text/javascript" src="http://wiki.eclipse.org/skins/common/wikibits.js?116"><!-- wikibits js --></script> |
| |
| <!-- Performance mods similar to those for bug 166401 --> |
| <script type="text/javascript" src="http://wiki.eclipse.org/index.php?title=-&action=raw&gen=js&useskin=eclipsenova"><!-- site js --></script> |
| |
| <!-- Head Scripts --> |
| <script type="text/javascript" src="http://wiki.eclipse.org/skins/common/ajax.js?116"></script> |
| <style type="text/css">/*<![CDATA[*/ |
| .source-xml {line-height: normal; font-size: medium;} |
| .source-xml li {line-height: normal;} |
| /** |
| * GeSHi Dynamically Generated Stylesheet |
| * -------------------------------------- |
| * Dynamically generated stylesheet for xml |
| * CSS class: source-xml, CSS id: |
| * GeSHi (C) 2004 - 2007 Nigel McNie (http://qbnz.com/highlighter) |
| */ |
| .source-xml .de1, .source-xml .de2 {font-family: 'Courier New', Courier, monospace; font-weight: normal;} |
| .source-xml {} |
| .source-xml .head {} |
| .source-xml .foot {} |
| .source-xml .imp {font-weight: bold; color: red;} |
| .source-xml .ln-xtra {color: #cc0; background-color: #ffc;} |
| .source-xml li {font-family: 'Courier New', Courier, monospace; color: black; font-weight: normal; font-style: normal;} |
| .source-xml li.li2 {font-weight: bold;} |
| .source-xml .coMULTI {color: #808080; font-style: italic;} |
| .source-xml .es0 {color: #000099; font-weight: bold;} |
| .source-xml .br0 {color: #66cc66;} |
| .source-xml .st0 {color: #ff0000;} |
| .source-xml .nu0 {color: #cc66cc;} |
| .source-xml .sc0 {color: #00bbdd;} |
| .source-xml .sc1 {color: #ddbb00;} |
| .source-xml .sc2 {color: #339933;} |
| .source-xml .sc3 {color: #009900;} |
| .source-xml .re0 {color: #000066;} |
| .source-xml .re1 {font-weight: bold; color: black;} |
| .source-xml .re2 {font-weight: bold; color: black;} |
| |
| /*]]>*/ |
| </style> |
| <style type="text/css">/*<![CDATA[*/ |
| @import "http://wiki.eclipse.org/index.php?title=MediaWiki:Geshi.css&usemsgcache=yes&action=raw&ctype=text/css&smaxage=18000"; |
| /*]]>*/ |
| </style><link rel="stylesheet" type="text/css" href="Search.html" /> </head> |
| <body class="mediawiki ns-0 ltr page-SMILA_Documentation_Search"> |
| <div id="globalWrapper"> |
| |
| |
| <div id="column-one"> |
| <!-- Eclipse Additions for the Top Nav start here M. Ward--> |
| |
| <div id="header"> |
| <div id="header-graphic"> |
| <img src="http://wiki.eclipse.org/skins/eclipsenova/eclipse.png" alt="Eclipse Wiki"> |
| </div> |
| <!-- Pulled 101409 Mward --> |
| |
| <div class="portlet" id="p-personal"> |
| <div class="pBody"> |
| <ul> |
| <li id="pt-login"><a href="http://wiki.eclipse.org/index.php?title=Special:Userlogin&returnto=SMILA/Documentation/Search">Log in</a></li> |
| </ul> |
| </div> |
| </div> |
| |
| <div id="header-icons"> |
| <div id="sites"> |
| <ul id="sitesUL"> |
| <li><a href="http://www.eclipse.org"><img src="http://dev.eclipse.org/custom_icons/eclipseIcon.png" width="28" height="28" alt="Eclipse Foundation" title="Eclipse Foundation" /><div>Eclipse Foundation</div></a></li> |
| <li><a href="http://marketplace.eclipse.org"><img src="http://dev.eclipse.org/custom_icons/marketplace.png" width="28" height="28" alt="Eclipse Marketplace" title="Eclipse Marketplace" /><div>Eclipse Marketplace</div></a></li> |
| <li><a href="https://bugs.eclipse.org/bugs"><img src="http://dev.eclipse.org/custom_icons/system-search-bw.png" width="28" height="28" alt="Bugzilla" title="Bugzilla" /><div>Bugzilla</div></a></li> |
| <li><a href="http://live.eclipse.org"><img src="http://dev.eclipse.org/custom_icons/audio-input-microphone-bw.png" width="28" height="28" alt="Live" title="Live" /><div>Eclipse Live</div></a></li> |
| <li><a href="http://planeteclipse.org"><img src="http://dev.eclipse.org/large_icons/devices/audio-card.png" width="28" height="28" alt="PlanetEclipse" title="Planet" /><div>Planet Eclipse</div></a></li> |
| <li><a href="http://portal.eclipse.org"><img src="http://dev.eclipse.org/custom_icons/preferences-system-network-proxy-bw.png" width="28" height="28" alt="Portal" title="Portal" /><div>My Foundation Portal</div></a></li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <!-- NEW HEADER STUFF HERE --> |
| <div id="header-menu"> |
| <div id="header-nav"> |
| <ul> <li><a class="first_one" href="http://wiki.eclipse.org/" target="_self">Home</a></li> <li><a href="http://www.eclipse.org/downloads/" target="_self">Downloads</a></li> |
| <li><a href="http://www.eclipse.org/users/" target="_self">Users</a></li> |
| <li><a href="http://www.eclipse.org/membership/" target="_self">Members</a></li> |
| <li><a href="http://wiki.eclipse.org/index.php/Development_Resources" target="_self">Committers</a></li> |
| <li><a href="http://www.eclipse.org/resources/" target="_self">Resources</a></li> |
| <li><a href="http://www.eclipse.org/projects/" target="_self">Projects</a></li> |
| <li><a href="http://www.eclipse.org/org/" target="_self">About Us</a></li> |
| </ul> |
| </div> |
| <div id="header-utils"> |
| <!-- moved the search window here --> |
| <form action="http://wiki.eclipse.org/Special:Search" > |
| <input class="input" name="search" type="text" accesskey="f" value="" /> |
| <input type='submit' onclick="this.submit();" name="go" id="searchGoButton" class="button" title="Go to a page with this exact name if one exists" value="Go" /> |
| <input type='submit' onclick="this.submit();" name="fulltext" class="button" id="mw-searchButton" title="Search Eclipsepedia for this text" value="Search" /> |
| </form> |
| </div> |
| </div> |
| |
| |
| <!-- Eclipse Additions for the Header stop here --> |
| <!-- Additions and mods for leftside nav Start here --> |
| |
| <!--Started nav rip here--> |
| <!-- these are the nav controls main page, changes etc --> |
| <div id="novaContent" class="faux"> |
| <div id="leftcol"> |
| <ul id="leftnav"> |
| <!-- these are the page controls, edit history etc --> |
| <li class="separator"><a class="separator">Navigation   </li> |
| <li id="n-mainpage"><a href="http://wiki.eclipse.org/Main_Page">Main Page</a></li> |
| <li id="n-portal"><a href="http://wiki.eclipse.org/Eclipsepedia:Community_Portal">Community portal</a></li> |
| <li id="n-currentevents"><a href="http://wiki.eclipse.org/Eclipsepedia:Current_events">Current events</a></li> |
| <li id="n-recentchanges"><a href="http://wiki.eclipse.org/Special:Recentchanges">Recent changes</a></li> |
| <li id="n-randompage"><a href="http://wiki.eclipse.org/Special:Random">Random page</a></li> |
| <li id="n-help"><a href="http://wiki.eclipse.org/Help:Contents">Help</a></li> |
| <li class="separator"><a class="separator">Toolbox   </a></li> |
| |
| <li id="t-whatlinkshere"><a href="http://wiki.eclipse.org/Special:Whatlinkshere/SMILA/Documentation/Search">What links here</a></li> |
| <li id="t-recentchangeslinked"><a href="http://wiki.eclipse.org/Special:Recentchangeslinked/SMILA/Documentation/Search">Related changes</a></li> |
| <!-- This is the toolbox section --> |
| <li id="t-upload"><a href="http://wiki.eclipse.org/Special:Upload">Upload file</a></li> |
| <li id="t-specialpages"><a href="http://wiki.eclipse.org/Special:Specialpages">Special pages</a></li> |
| <li id="t-print"><a href="http://wiki.eclipse.org/index.php?title=SMILA/Documentation/Search&printable=yes">Printable version</a></li> <li id="t-permalink"><a href="http://wiki.eclipse.org/index.php?title=SMILA/Documentation/Search&oldid=301040">Permanent link</a></li> </ul> |
| </div> |
| |
| |
| <!-- Additions and mods for leftside nav End here --> |
| |
| |
| <div id="column-content"> |
| <div id="content"> |
| <a name="top" id="top"></a> |
| |
| <div id="tabs"> |
| <ul class="primary"> |
| <li class="active"><a href="../Search.html"><span class="tab">Page</span></a></li> |
| <li><a href="http://wiki.eclipse.org/index.php?title=Talk:SMILA/Documentation/Search&action=edit"><span class="tab">Discussion</span></a></li> |
| <li><a href="http://wiki.eclipse.org/index.php?title=SMILA/Documentation/Search&action=edit"><span class="tab">View source</span></a></li> |
| <li><a href="http://wiki.eclipse.org/index.php?title=SMILA/Documentation/Search&action=history"><span class="tab">History</span></a></li> |
| <li><a href="http://wiki.eclipse.org/index.php?title=Special:Userlogin&returnto=SMILA/Documentation/Search"><span class="tab">Edit</span></a></li> |
| </ul> |
| </div> |
| |
| |
| <script type="text/javascript"> if (window.isMSIE55) fixalpha(); </script> |
| <h1 class="firstHeading">SMILA/Documentation/Search</h1> |
| <div id="bodyContent"> |
| <h3 id="siteSub">From Eclipsepedia</h3> |
| <div id="contentSub"><span class="subpages">< <a href="../../../SMILA.html" title="SMILA">SMILA</a> | <a href="../../Documentation.1.html" title="SMILA/Documentation">Documentation</a></span>(Redirected from <a href="http://wiki.eclipse.org/index.php?title=SMILA/Documentation/2011.Simplification/Search&redirect=no" title="SMILA/Documentation/2011.Simplification/Search">SMILA/Documentation/2011.Simplification/Search</a>)</div> |
| <div id="jump-to-nav">Jump to: <a href="Search.html#column-one">navigation</a>, <a href="Search.html#searchInput">search</a></div> <!-- start content --> |
| <p>This page describes the search service and related parts of SMILA. This includes the query and result helpers, the processing of search requests in BPEL workflows, and the sample servlet used to create a simple web-based GUI for search. |
| </p> |
| <table id="toc" class="toc" summary="Contents"><tr><td><div id="toctitle"><h2>Contents</h2></div> |
| <ul> |
| <li class="toclevel-1"><a href="Search.html#Introduction"><span class="tocnumber">1</span> <span class="toctext">Introduction</span></a></li> |
| <li class="toclevel-1"><a href="Search.html#Search_Processing"><span class="tocnumber">2</span> <span class="toctext">Search Processing</span></a> |
| <ul> |
| <li class="toclevel-2"><a href="Search.html#Search_Pipelines"><span class="tocnumber">2.1</span> <span class="toctext">Search Pipelines</span></a></li> |
| </ul> |
| </li> |
| <li class="toclevel-1"><a href="Search.html#Search_Service_API"><span class="tocnumber">3</span> <span class="toctext">Search Service API</span></a></li> |
| <li class="toclevel-1"><a href="Search.html#Query_Parameters"><span class="tocnumber">4</span> <span class="toctext">Query Parameters</span></a></li> |
| <li class="toclevel-1"><a href="Search.html#Result_Annotations"><span class="tocnumber">5</span> <span class="toctext">Result Annotations</span></a></li> |
| <li class="toclevel-1"><a href="Search.html#Helper_Classes"><span class="tocnumber">6</span> <span class="toctext">Helper Classes</span></a></li> |
| <li class="toclevel-1"><a href="Search.html#SMILA_Search_Servlet"><span class="tocnumber">7</span> <span class="toctext">SMILA Search Servlet</span></a> |
| <ul> |
| <li class="toclevel-2"><a href="Search.html#XSLT_Stylesheets_for_SMILA_search_and_result_pages"><span class="tocnumber">7.1</span> <span class="toctext">XSLT Stylesheets for SMILA search and result pages</span></a></li> |
| <li class="toclevel-2"><a href="Search.html#Setting_parameters"><span class="tocnumber">7.2</span> <span class="toctext">Setting parameters</span></a></li> |
| <li class="toclevel-2"><a href="Search.html#Setting_attributes"><span class="tocnumber">7.3</span> <span class="toctext">Setting attributes</span></a></li> |
| <li class="toclevel-2"><a href="Search.html#Setting_other_parameters"><span class="tocnumber">7.4</span> <span class="toctext">Setting other parameters</span></a></li> |
| <li class="toclevel-2"><a href="Search.html#Adding_attachments"><span class="tocnumber">7.5</span> <span class="toctext">Adding attachments</span></a></li> |
| </ul> |
| </li> |
| <li class="toclevel-1"><a href="Search.html#Record_Search_Servlet"><span class="tocnumber">8</span> <span class="toctext">Record Search Servlet</span></a></li> |
| </ul> |
| </li> |
| </ul> |
| </td></tr></table><script type="text/javascript"> if (window.showTocToggle) { var tocShowText = "show"; var tocHideText = "hide"; showTocToggle(); } </script> |
| <a name="Introduction"></a><h3> <span class="mw-headline"> Introduction </span></h3> |
| <p>Let's start right at the top: Provided that you installed SMILA and created an index by starting a crawler as described in <a href="../../Documentation_for_5_Minutes_to_Success.html" title="SMILA/Documentation for 5 Minutes to Success">5 Minutes to Success</a>, you can use you web browser to go to <a href="http://localhost:8080/SMILA/search" class="external free" title="http://localhost:8080/SMILA/search" rel="nofollow">http://localhost:8080/SMILA/search</a> and search on the index: |
| </p><p><a href="http://wiki.eclipse.org/Image:SMILA-search-page-default.png" class="image" title="SMILA's sample search page"><img alt="SMILA's sample search page" src="http://wiki.eclipse.org/images/thumb/8/82/SMILA-search-page-default.png/500px-SMILA-search-page-default.png" width="500" height="381" border="0" /></a> |
| </p><p>What happens behind the scenes when you enter a query string and submit the form, is that a servlet creates a SMILA record from the HTTP parameters, uses the search service to execute a BPEL workflow on this record, receives an enriched version of the query record and also a list of result records in XML form, and uses an XSLT stylesheet to create a result page in HTML format. |
| </p><p>By clicking the <i>Advanced</i> link at the top of the search page (or by entering the URL <tt><a href="http://localhost:8080/SMILA/search?style=SMILASearchAdvanced" class="external free" title="http://localhost:8080/SMILA/search?style=SMILASearchAdvanced" rel="nofollow">http://localhost:8080/SMILA/search?style=SMILASearchAdvanced</a></tt>), you can switch to a more detailed search form page, which allows you to construct more specific search queries: |
| </p><p><a href="http://wiki.eclipse.org/Image:SMILA-search-page-advanced.png" class="image" title="SMILA's advanced sample search page"><img alt="SMILA's advanced sample search page" src="http://wiki.eclipse.org/images/thumb/7/70/SMILA-search-page-advanced.png/500px-SMILA-search-page-advanced.png" width="500" height="381" border="0" /></a> |
| </p><p>If you want to use the default search servlet for your own search page, you are encouraged to use the two XSLT files creating these HTML pages as a reference or basis when building your pages. |
| </p> |
| <a name="Search_Processing"></a><h3> <span class="mw-headline"> Search Processing </span></h3> |
| <p>Having seen the tip of the iceberg, we dive down to the very bottom of SMILA search: the actual processing of search requests in SMILA BPEL pipelines. We assume that you are accustomed to the basic SMILA workflow processing features used in indexing workflows. You may want to refer to <a href="../BPEL_Workflow_Processor.html" title="SMILA/Documentation/BPEL Workflow Processor">SMILA/Documentation/BPEL Workflow Processor</a> for details. |
| </p> |
| <a name="Search_Pipelines"></a><h4> <span class="mw-headline"> Search Pipelines </span></h4> |
| <p>Search workflows (or pipelines) look just like indexing pipelines, they are only used a bit differently: Instead of pushing lists of records corresponding to data source objects through them, they are invoked with a single record representing the search request. This record contains the values of the parameters which were defined by the Search API (see below). The request object can be analyzed and enriched with additional information during the workflow before the actual search on the index takes place. The results of this search are not added to the blackboard as records of their own, but are added to the request record under the key "records". Further pipelets may then do further processing based on the request data and the result record list (e.g. highlighting). Finally, the request record including the search results is returned to the client and can be presented. |
| </p><p>Pipelet invocations look the same as in indexing pipelines. See <tt>SMILA.application/configuration/org.eclipse.smila.processing.bpel/pipelines/searchpipeline.bpel</tt> for a complete example search pipeline (the one used in the above sample). |
| </p> |
| <a name="Search_Service_API"></a><h3> <span class="mw-headline"> Search Service API </span></h3> |
| <p>The actual Search API is quite simple: SMILA registers an OSGi service with the interface <tt>org.eclipse.smila.search.api.SearchService</tt>. It provides a few methods that take a SMILA query record and the name of a search workflow as input, execute the workflow on the record, and return the result in different formats: |
| </p> |
| <ul><li><tt>Record search(String workflowName, Record query) throws ProcessingException</tt>: This is the basic method of the search service, returning the result records as native SMILA data structures. The other methods call this method for the actual search execution, too, and then just convert the result. |
| </li><li><tt>org.w3c.dom.Document searchAsXml(String workflowName, Record query) throws ProcessingException</tt>: Returns the search result as an XML DOM document. See below for the schema of the result. |
| </li><li><tt>String searchAsXmlString(String workflowName, Record query) throws ProcessingException</tt>: Returns the search result as an XML string. See below for the schema of the result. |
| </li></ul> |
| <p>The schema of XML search results is basically as follows (target namespace is <tt><a href="http://www.eclipse.org/smila/search" class="external free" title="http://www.eclipse.org/smila/search" rel="nofollow">http://www.eclipse.org/smila/search</a></tt>, see <tt>org.eclipse.smila.search.api/xml/search.xsd</tt> for the full definition): |
| </p> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><element</span> <span class="re0">name</span>=<span class="st0">"SearchResult"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><complexType<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><sequence</span> <span class="re0">minOccurs</span>=<span class="st0">"1"</span> <span class="re0">maxOccurs</span>=<span class="st0">"1"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><element</span> <span class="re0">name</span>=<span class="st0">"Workflow"</span> <span class="re0">type</span>=<span class="st0">"string"</span> <span class="re0">minOccurs</span>=<span class="st0">"1"</span> <span class="re0">maxOccurs</span>=<span class="st0">"1"</span> <span class="re2">/></span></span> |
| <span class="sc3"><span class="re1"><element</span> <span class="re0">ref</span>=<span class="st0">"rec:Record"</span> <span class="re0">minOccurs</span>=<span class="st0">"0"</span> <span class="re0">maxOccurs</span>=<span class="st0">"1"</span> <span class="re2">/></span></span> |
| <span class="sc3"><span class="re1"></sequence<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></complexType<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></element<span class="re2">></span></span></span></pre></div> |
| <p>You can view the result XML when using the sample SMILA search page at <tt><a href="http://localhost:8080/SMILA/search" class="external free" title="http://localhost:8080/SMILA/search" rel="nofollow">http://localhost:8080/SMILA/search</a></tt> if you enable the <i>Show XML result</i> option before submitting the query. |
| </p><p>The content of the query record basically depends a lot on the used search services. However, the Search API also includes a recommendation where to put some basic commonly used search parameters which all index integrations should honor (of course they may specify extensions that are not covered by the generic Search API). The following sections describe these recommendations. |
| </p> |
| <a name="Query_Parameters"></a><h3> <span class="mw-headline"> Query Parameters </span></h3> |
| <p>The query record mainly consists of parameters. The Search API defines the names of these parameters, the allowed values as well as the default values for a set of commonly used parameters. All implementations should use these properties if possible, i.e. they should not introduce additional parameters for the same purpose, but it may be possible that certain parameters are not supported because it is not feasible with the underlying technology. For some parameters we also defined default values. All parameters are single-valued unless otherwise specified. |
| </p> |
| <ul><li><i>query</i>: Either a search string using a query syntax or a query record describing the query by setting values for attributes (aka fielded search). The implementer for a specific underlying technology may define a query syntax to be able to build complex search criteria in a single string. However, SMILA currently does not define an own query syntax and passes the string as is to its default search engine <a href="../Solr.html" title="SMILA/Documentation/Solr">Solr</a> (see there for handling and interpretation). |
| <ul><li>Example using a query string: |
| </li></ul> |
| </li></ul> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><Record<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"query"</span><span class="re2">></span></span>meaning of life<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Record<span class="re2">></span></span></span></pre></div> |
| <ul><li>Example using a query object (fielded search): |
| </li></ul> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><Record<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Map</span> <span class="re0">key</span>=<span class="st0">"query"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"author"</span><span class="re2">></span></span>shakespeare<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"title"</span><span class="re2">></span></span>hamlet<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Record<span class="re2">></span></span></span></pre></div> |
| <ul><li><i>maxcount</i>: The maximum number of records which should be returned to the search client. Default value is 10. Example: |
| </li></ul> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"query"</span><span class="re2">></span></span>meaning of life<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"maxcount"</span> <span class="re0">type</span>=<span class="st0">"long"</span><span class="re2">></span></span>3<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span></pre></div> |
| <ul><li><i>offset</i>: The number of hits which, starting from the top, should be skipped in the search result. Default value is 0. Use this parameter to implement result list paging and to provide the user a means to navigate through the result pages: If resultSize=10, the "next page" queries can be identical to the initial query, but with resultOffset=10, 20, ... Example: |
| </li></ul> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"query"</span><span class="re2">></span></span>meaning of life<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"maxcount"</span> <span class="re0">type</span>=<span class="st0">"long"</span><span class="re2">></span></span>3<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"offset"</span> <span class="re0">type</span>=<span class="st0">"long"</span><span class="re2">></span></span>3<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span></pre></div> |
| <ul><li><i>threshold</i>: The minimal value of the relevance score that a result must have to be returned to the search client. Default is 0.0. |
| </li></ul> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"query"</span><span class="re2">></span></span>meaning of life<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"threshold"</span> <span class="re0">type</span>=<span class="st0">"double"</span><span class="re2">></span></span>0.5<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span></pre></div> |
| <ul><li><i>language</i>: The natural language of the query. No default value. This parameter may be required for language-specific pipelets/services that need to know in which language the user is expressing his or her query to be able to deliver feasible results. Example: |
| </li></ul> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"query"</span><span class="re2">></span></span>sinn des lebens<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"language"</span><span class="re2">></span></span>de<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span></pre></div> |
| <ul><li><i>indexname</i>: Some index services (like Solr) can manage multiple indices at once. When doing so, they can use this parameter to select the index which is to be searched with the current request. However, when using such a scenario, it is recommended to configure a default index name, so that search requests will succeed without having this parameter set explicitly. Example: |
| </li></ul> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"query"</span><span class="re2">></span></span>meaning of life<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"indexname"</span><span class="re2">></span></span>wikipedia<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span></pre></div> |
| <ul><li><i>resultAttributes</i>: A multi-valued parameter containing the names of the attributes which the search engine should add to the result records. Since including too many attributes will decrease performance, the list should contain only those attributes that are needed by some pipelets for further processing after the search has taken place or for displaying the results in the end. Omitting the parameter results in getting all available attributes. Example: |
| </li></ul> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"query"</span><span class="re2">></span></span>meaning of life<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Seq</span> <span class="re0">key</span>=<span class="st0">"resultAttributes"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><Val<span class="re2">></span></span></span>author<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val<span class="re2">></span></span></span>title<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Seq<span class="re2">></span></span></span></pre></div> |
| <ul><li><i>highlight</i>: A sequence of string values specifying the attribute names for which highlighting should be returned. Example: |
| </li></ul> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"query"</span><span class="re2">></span></span>meaning of life<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Seq</span> <span class="re0">key</span>=<span class="st0">"highlight"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><Val<span class="re2">></span></span></span>content<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Seq<span class="re2">></span></span></span></pre></div> |
| <ul><li><i>sortby</i>: A sequence of maps each containing the <i>key</i> "attribute" (any string) and the <i>key</i> "order" ("ascending" | "descending") specifying that the search result should be sorted by the named attributes in the given order. Omitting this parameter results in a search result sorting by descending relevance (score, similarity, ranking, ....). Multiple maps can be added and should be evaluated in the order of their appearance. Example: |
| </li></ul> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"query"</span><span class="re2">></span></span>meaning of life<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Seq</span> <span class="re0">key</span>=<span class="st0">"sortby"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"attribute"</span><span class="re2">></span></span>year<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"order"</span><span class="re2">></span></span>descending<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"attribute"</span><span class="re2">></span></span>author<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"order"</span><span class="re2">></span></span>ascending<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Seq<span class="re2">></span></span></span></pre></div> |
| <ul><li><i>facetby</i>: A sequence of maps each containing the <i>key</i> "attribute" (any string) and the <i>key</i> "maxcount" (long). This causes facets to be returned by the search results for the specified attributes, returning "maxcount" values for each attribute. Optionally, each facetby map may contain a map with key "sortby" with keys "order" ("ascending" | "descending") and "criterion" (any string, e.g. "count" or "value") specifying in which order to return the values (e.g. "count" by number of this per facet or "value" by attribute value name). Example: |
| </li></ul> |
| <div class="messagebox" style="background-color: #def3fe; border: 1px solid #c5d7e0; color: black; padding: 5px; margin: 1ex 0; min-height: 35px; padding-left: 45px;"> |
| <div style="float: left; margin-left: -40px;"><a href="http://wiki.eclipse.org/Image:Note.png" class="image" title="Note.png"><img alt="" src="http://wiki.eclipse.org/images/c/cc/Note.png" width="35" height="35" border="0" /></a></div> |
| <div><b>since 1.0</b><br />prior to 1.0 this was named <i>groupby</i> and has been merely renamed, (see <a href="http://dev.eclipse.org/mhonarc/lists/smila-dev/msg00998.html" class="external text" title="http://dev.eclipse.org/mhonarc/lists/smila-dev/msg00998.html" rel="nofollow">mail thread</a></div> |
| </div> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"query"</span><span class="re2">></span></span>meaning of life<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Seq</span> <span class="re0">key</span>=<span class="st0">"facetby"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"attribute"</span><span class="re2">></span></span>year<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"maxcount"</span> <span class="re0">type</span>=<span class="st0">"long"</span><span class="re2">></span></span>10<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"attribute"</span><span class="re2">></span></span>author<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Map</span> <span class="re0">key</span>=<span class="st0">"sortby"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"criterion"</span><span class="re2">></span></span>value<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"order"</span><span class="re2">></span></span>ascending<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"maxcount"</span> <span class="re0">type</span>=<span class="st0">"long"</span><span class="re2">></span></span>5<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Seq<span class="re2">></span></span></span></pre></div> |
| <ul><li><i>filter</i>: A sequence of maps describing for certain attributes which values they must have in valid result records. Each of the maps contains a <i>key</i> "attribute" and one or more value descriptions: |
| <ul><li>"oneOf", "allOf", "noneOf": sequences of values describing required or forbidden attribute values. |
| </li><li>"atLeast", "atMost", "greaterThan", "lessThan": single values describing lower and upper bounds (including or excluding the bound values) for the attribute value. Example: |
| </li></ul> |
| </li></ul> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"query"</span><span class="re2">></span></span>meaning of life<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Seq</span> <span class="re0">key</span>=<span class="st0">"filter"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"attribute"</span><span class="re2">></span></span>author<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Seq</span> <span class="re0">key</span>=<span class="st0">"oneOf"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><Val<span class="re2">></span></span></span>pratchett<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val<span class="re2">></span></span></span>adams<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Seq<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"attribute"</span><span class="re2">></span></span>year<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"atLeast"</span><span class="re2">></span></span>1990<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"lessThan"</span><span class="re2">></span></span>2000<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Seq<span class="re2">></span></span></span></pre></div> |
| <ul><li><i>ranking</i>: A configuration defining how to rank the search results. This is highly depending on the used search engine, so we don't specify this further in SMILA. |
| </li></ul> |
| <a name="Result_Annotations"></a><h3> <span class="mw-headline"> Result Annotations </span></h3> |
| <p>The search result is usually the request record, enriched with result data. |
| </p> |
| <ul><li><i>records</i>: A sequence of maps describing the actual search result, meaning the records retrieved from the index. Each record should have an additional attribute "_weight" describing the relevance score of this record with respect to the query. The size of the "record" sequence is limited by the "maxcount" parameter. |
| </li></ul> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"query"</span><span class="re2">></span></span>meaning of life<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="coMULTI"><!-- other query parameters --></span></span> |
| <span class="sc3"><span class="re1"><Seq</span> <span class="re0">key</span>=<span class="st0">"records"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"_weight"</span> <span class="re0">type</span>=<span class="st0">"double"</span><span class="re2">></span></span>0.95<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"_recordid"</span><span class="re2">></span></span>file:hamlet<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"title"</span><span class="re2">></span></span>Hamlet<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"author"</span><span class="re2">></span></span>Shakespeare<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| ... |
| <span class="sc3"><span class="re1"></Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"_weight"</span> <span class="re0">type</span>=<span class="st0">"double"</span><span class="re2">></span></span>0.90<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"_recordid"</span><span class="re2">></span></span>file:hitchhiker<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"title"</span><span class="re2">></span></span>Hitchhiker's Guide to the Galaxy<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"author"</span><span class="re2">></span></span>Adams<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| ... |
| <span class="sc3"><span class="re1"></Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Seq<span class="re2">></span></span></span></pre></div> <div class="messagebox" style="background-color: #def3fe; border: 1px solid #c5d7e0; color: black; padding: 5px; margin: 1ex 0; min-height: 35px; padding-left: 45px;"> |
| <div style="float: left; margin-left: -40px;"><a href="http://wiki.eclipse.org/Image:Note.png" class="image" title="Note.png"><img alt="" src="http://wiki.eclipse.org/images/c/cc/Note.png" width="35" height="35" border="0" /></a></div> |
| <div><b>return binary content</b><br />There is no nice way to return binary content anymore as attachents may only be top-level children of a record. These two solutions are possible: |
| <ol><li> add an attachment to the search record with a name after this pattern: <resultItem-record.Id>.<resultItem.atachmentName> |
| </li><li> convert the byte[] into a string (e.g. base64 encoding, so it is serializable) and return it in the AnyMap</div> |
| </li></ol> |
| </div> |
| <ul><li><i>count</i>: The total number of records in the index that have any relevance to the query. Example see <i>runtime</i>. |
| </li><li><i>indexSize</i> (optional): The total number of records in the searched index. Example see <i>runtime</i>. |
| </li><li><i>runtime</i>: The execution time of request in milliseconds, added by the search service. Example: |
| </li></ul> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"query"</span><span class="re2">></span></span>meaning of life<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"count"</span> <span class="re0">type</span>=<span class="st0">"long"</span><span class="re2">></span></span>123456<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"indexSize"</span> <span class="re0">type</span>=<span class="st0">"long"</span><span class="re2">></span></span>987654321<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"runtime"</span> <span class="re0">type</span>=<span class="st0">"long"</span><span class="re2">></span></span>42<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="coMULTI"><!-- other query parameters --></span></span> |
| <span class="sc3"><span class="re1"><Seq</span> <span class="re0">key</span>=<span class="st0">"records"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="coMULTI"><!-- contains returned records --></span></span> |
| <span class="sc3"><span class="re1"></Seq<span class="re2">></span></span></span></pre></div> |
| <ul><li><i>facets</i>: The faceting results as requested by the <i>facetby</i> parameters. This Map contains a nested Seq for each requested facet and its values. |
| </li></ul> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"query"</span><span class="re2">></span></span>meaning of life<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Map</span> <span class="re0">key</span>=<span class="st0">"facets"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><Seq</span> <span class="re0">key</span>=<span class="st0">"year"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"value"</span><span class="re2">></span></span>2000<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"count"</span> <span class="re0">type</span>=<span class="st0">"long"</span><span class="re2">></span></span>42<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"value"</span><span class="re2">></span></span>2001<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"count"</span> <span class="re0">type</span>=<span class="st0">"long"</span><span class="re2">></span></span>21<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Map<span class="re2">></span></span></span> |
| ... |
| <span class="sc3"><span class="re1"></Seq<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Seq</span> <span class="re0">key</span>=<span class="st0">"author"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"value"</span><span class="re2">></span></span>adams<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"count"</span> <span class="re0">type</span>=<span class="st0">"long"</span><span class="re2">></span></span>13<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"value"</span><span class="re2">></span></span>shakespear<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"count"</span> <span class="re0">type</span>=<span class="st0">"long"</span><span class="re2">></span></span>17<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Map<span class="re2">></span></span></span> |
| ... |
| <span class="sc3"><span class="re1"></Seq<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span></pre></div> |
| <ul><li><i>_highlight</i>: The annotation of the result record, usually used to highlight relevant sections from the result documents in order to allow the user to see at one glance if it suits what he or she was looking for. What is returned here exactly, depends on the used search engine. For example, the Solr integration in SMILA returns the raw form of the text and information about the matching parts to be highlighted. Example: |
| </li></ul> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><Seq</span> <span class="re0">key</span>=<span class="st0">"records"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><Map<span class="re2">></span></span></span> |
| ... |
| <span class="sc3"><span class="re1"><Map</span> <span class="re0">key</span>=<span class="st0">"_highlight"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><Map</span> <span class="re0">key</span>=<span class="st0">"content"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"text"</span><span class="re2">></span></span>... To be or not to be ...<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Seq</span> <span class="re0">key</span>=<span class="st0">"positions"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"start"</span> <span class="re0">type</span>=<span class="st0">"long"</span><span class="re2">></span></span>7<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"end"</span> <span class="re0">type</span>=<span class="st0">"long"</span><span class="re2">></span></span>9<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"quality"</span> <span class="re0">type</span>=<span class="st0">"long"</span><span class="re2">></span></span>100<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"start"</span> <span class="re0">type</span>=<span class="st0">"long"</span><span class="re2">></span></span>20<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"end"</span> <span class="re0">type</span>=<span class="st0">"long"</span><span class="re2">></span></span>22<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"quality"</span> <span class="re0">type</span>=<span class="st0">"long"</span><span class="re2">></span></span>95<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Seq<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Map<span class="re2">></span></span></span> |
| ... |
| <span class="sc3"><span class="re1"></Map<span class="re2">></span></span></span></pre></div> Using the HighlightingPipelet this can be transformed into a highlighted text fragment (here using * as the highlight tag): <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><Seq</span> <span class="re0">key</span>=<span class="st0">"records"</span><span class="re2">></span></span> |
| <pre> <span class="sc3"><span class="re1"><Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"_weight"</span> <span class="re0">type</span>=<span class="st0">"double"</span><span class="re2">></span></span>0.95<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"_recordid"</span><span class="re2">></span></span>file:hamlet<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"title"</span><span class="re2">></span></span>Hamlet<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"author"</span><span class="re2">></span></span>Shakespeare<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Map</span> <span class="re0">key</span>=<span class="st0">"_highlight"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><Map</span> <span class="re0">key</span>=<span class="st0">"content"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"text"</span><span class="re2">></span></span>... To *be* or not to *be* ...<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Map<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Map<span class="re2">></span></span></span> |
| ... |
| </pre> |
| <span class="sc3"><span class="re1"></Map<span class="re2">></span></span></span></pre></div> |
| <a name="Helper_Classes"></a><h3> <span class="mw-headline"> Helper Classes </span></h3> |
| <p>There are some classes that help a client to create query records with their annotations and to read result records and their annotation. You can find them in package <tt>org.eclipse.smila.search.api.helper</tt>: |
| </p> |
| <ul><li><tt>QueryBuilder</tt>: A helper class for building queries and sending the query to search service. Returns a result in the form of the next class: |
| </li><li><tt>ResultAccessor</tt>: A wrapper for the complete search result. Provides methods to access the basic top-level result annotations and to access each search result record wrapped by a: |
| </li><li><tt>ResultRecordAccessor</tt>: Defines methods for accessing some of the result record annotations. |
| </li></ul> |
| <p>See the source code or JavaDocs for more details on the provided methods. |
| </p> |
| <a name="SMILA_Search_Servlet"></a><h3> <span class="mw-headline"> SMILA Search Servlet </span></h3> |
| <p>In addition to the "search backend", SMILA contains a simple servlet that creates a query record from HTTP parameters and displays the result as an HTML page by converting the XML search result using an XSLT stylesheet. This servlet is intended for quick demos only, not for productive use. It is usually deployed in the Jetty instance that comes with SMILA at <tt>/SMILA/search</tt>. On first invocation, it currently creates a quite empty query record (it sets some default parameters like <i>maxcount</i> etc.) and processes it with the default pipeline "SearchPipeline". The pipeline should be able to process such a query and return an empty result list, not an error. The XML representation of this empty result is then transformed using the default stylesheet ("SMILASearchDefault") to present an initial search page. |
| </p><p>Note that the servlet actually enriches the XML search result a bit, so the input for the XSLT stylsheet does not completely conform to the defined XML schema. Currently, it adds a section containing the names of indices available in Solr so that the search page can display the names for selection on the left side: |
| </p> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><SearchResult</span> <span class="re0">xmlns</span>=<span class="st0">"http://www.eclipse.org/smila/search"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><Workflow<span class="re2">></span></span></span>searchpipeline<span class="sc3"><span class="re1"></Workflow<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Record</span> <span class="re0">xmlns</span>=<span class="st0">"http://www.eclipse.org/smila/record"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="coMULTI"><!-- effective query and embedded result records ---></span></span> |
| <span class="sc3"><span class="re1"></Record<span class="re2">></span></span></span> |
| <span class="sc3"><span class="coMULTI"><!-- part added by SearchServlet --></span></span> |
| <span class="sc3"><span class="re1"><IndexNames<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><IndexName<span class="re2">></span></span></span>test_index<span class="sc3"><span class="re1"></IndexName<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></IndexNames<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></SearchResult<span class="re2">></span></span></span></pre></div> |
| <p>You can use the same mechanism to add other information to the XML that is necessary for displaying purposes in the search form but not contained in the search service result: You just have to implement your own servlet or extend the default servlet. Please refer to the source code for details. |
| </p> |
| <a name="XSLT_Stylesheets_for_SMILA_search_and_result_pages"></a><h4> <span class="mw-headline"> XSLT Stylesheets for SMILA search and result pages </span></h4> |
| <p>The stylesheets are loaded from the configuration directory <tt>org.eclipse.smila.search.servlet</tt> and are selected by adding the HTTP parameter "style" to the URL. The value of this parameter must be the filename of the desired stylesheet without the suffix. The file's extension must bei <tt>.xsl</tt>. The servlet currently uses the hardcoded default name "SMILASearchDefault" if no other value was set. |
| </p><p>In the default application, three stylesheets are avaiable: |
| </p> |
| <ul><li>SMILASearchDefault: The default search page. Use this as a reference on how to describe simple queries and present result lists, including paging through bigger results. |
| </li><li>SMILASearchAdvanced: Same layout for the result list but demostrates how to create more complex query records with attribute values and filters. |
| </li><li>SMILASearchTest: Primitive layout without paging but demonstrates the setting of even more query features. |
| </li></ul> |
| <p>To start with another than the default stylesheet, you can add a <i>style</i> parameter to the initial URL. E.g., to start with the "advanced" stylesheet, use: <tt><a href="http://localhost:8080/SMILA/search?style=SMILASearchAdvanced" class="external free" title="http://localhost:8080/SMILA/search?style=SMILASearchAdvanced" rel="nofollow">http://localhost:8080/SMILA/search?style=SMILASearchAdvanced</a></tt>. |
| </p><p>In the following we will describe how to set query record features using the servlet. Please have a look at those sample stylesheets for complete examples on how to apply them, as we will not present something like a full tutorial here (-; |
| </p> |
| <a name="Setting_parameters"></a><h4> <span class="mw-headline"> Setting parameters </span></h4> |
| <p>To set a parameter, just use the parameter name as the HTTP parameter name. All values for this HTTP parameter are added to the "parameters" annotation of the query record. E.g., to set the <i>resultSize</i> parameter to 7 using a hidden HTML input field, use: |
| </p> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><input</span> <span class="re0">type</span>=<span class="st0">"hidden"</span> <span class="re0">name</span>=<span class="st0">"resultSize"</span> <span class="re0">value</span>=<span class="st0">"7"</span> <span class="re2">/></span></span></pre></div> |
| <p>See below for naming rules for the HTTP parameter names to set attribute literals and annotations. Note that you cannot set a parameter with a name that matches one of these rules. |
| </p> |
| <a name="Setting_attributes"></a><h4> <span class="mw-headline"> Setting attributes </span></h4> |
| <p>You can add literal string values to attributes using "A.<AttributeName>" as the HTTP parameter name. E.g., to set a value from an HTML text input field as a literal in attribute "Title", use: |
| </p> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><input</span> <span class="re0">type</span>=<span class="st0">"text"</span> <span class="re0">name</span>=<span class="st0">"A.Title"</span> <span class="re2">/></span></span></pre></div> |
| <a name="Setting_other_parameters"></a><h4> <span class="mw-headline"> Setting other parameters </span></h4> |
| <p>To add a "sortby" parameter for an attribute, use "sortBy.<AttributeName>=<order>", e.g. |
| </p> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><input</span> <span class="re0">type</span>=<span class="st0">"hidden"</span> <span class="re0">name</span>=<span class="st0">"sortby.FileSize"</span> <span class="re0">value</span>=<span class="st0">"descending"</span> <span class="re2">/></span></span></pre></div> |
| <p>To create a filter for an attribute, use HTTP params: |
| </p> |
| <ul><li>"F.val.<AttributeName>" to add filter values to an "oneOf" filter. |
| </li><li>"F.min.<AttributeName>" and "F.max.<AttributeName>" to set the lower/upper bounds of an "atLeast"/"atMost" filter. |
| </li></ul> |
| <p>If both "F.val" and "F.min/F.max" paramaters are set, the servlet will create both an enumeration filter and a range filter with the same filter mode. It depends on the used search engine integration what happens in this case. E.g. |
| </p> |
| <ul><li>To set a filter for attribute <i>MimeType</i> restricting the result to HTML documents, use: |
| </li></ul> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><input</span> <span class="re0">type</span>=<span class="st0">"hidden"</span> <span class="re0">name</span>=<span class="st0">"F.val.MimeType"</span> <span class="re0">value</span>=<span class="st0">"text/html"</span> <span class="re2">/></span></span></pre></div> |
| <ul><li>To set a filter for attribute <i>FileSize</i> restricting the result to document sizes between 1000 and 10000 bytes, use: |
| </li></ul> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><input</span> <span class="re0">type</span>=<span class="st0">"hidden"</span> <span class="re0">name</span>=<span class="st0">"F.min.FileSize"</span> <span class="re0">value</span>=<span class="st0">"1000"</span> <span class="re2">/></span></span> |
| <span class="sc3"><span class="re1"><input</span> <span class="re0">type</span>=<span class="st0">"hidden"</span> <span class="re0">name</span>=<span class="st0">"F.max.FileSize"</span> <span class="re0">value</span>=<span class="st0">"10000"</span> <span class="re2">/></span></span></pre></div> |
| <p>To set a value in the ranking parameter for the complete record or an attribute, use "R[.<AttributeName>].<ValueName>". E.g., the following input field adds a parameter "Operator=OR" to attribute "Content": |
| </p> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><input</span> <span class="re0">type</span>=<span class="st0">"hidden"</span> <span class="re0">name</span>=<span class="st0">"R.Operator.Content"</span> <span class="re0">value</span>=<span class="st0">"OR"</span> <span class="re2">/></span></span></pre></div> |
| <a name="Adding_attachments"></a><h4> <span class="mw-headline"> Adding attachments </span></h4> |
| <p>Attachments can be added to the query record by adding file upload fields to the search form, for example: |
| </p> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><input</span> <span class="re0">type</span>=<span class="st0">"file"</span> <span class="re0">name</span>=<span class="st0">"Content"</span><span class="re2">/></span></span></pre></div> |
| <p>If the user selects a file for this field, it will be uploaded to SMILA and added as attachment "Content". Of course, there must be pipelets in your search pipeline that can process this attachment. Note, that the attachments will be kept in memory in a default SMILA configuration, so they should not be too large. |
| </p> |
| <a name="Record_Search_Servlet"></a><h3> <span class="mw-headline"> Record Search Servlet </span></h3> |
| <p>In addition there exists the very basic Record Search Servlet available at <span style="font-family:monospace;">/SMILA/recordsearch</span>. |
| </p><p>You can do a POST or GET request on this URL with a SMILA search record in XML representation as the request body. The servlet then parses the given XML and calls the Search Service. The default is to use the SeachPipeline but you can define any other pipeline by adding the <span style="font-family:monospace;">_workflow</span> annotation to the search record with the respective pipeline name. |
| </p><p>The servlet returns the XML representation of the record returned by the Search Service as is, in which you can find the search results (see above). |
| </p> |
| <!-- |
| NewPP limit report |
| Preprocessor node count: 198/1000000 |
| Post-expand include size: 2905/2097152 bytes |
| Template argument size: 1761/2097152 bytes |
| #ifexist count: 0/100 |
| --> |
| |
| <!-- Saved in parser cache with key wikidb:pcache:idhash:18950-0!1!0!!en!2!edit=0 and timestamp 20120710135634 --> |
| <div class="printfooter"> |
| Retrieved from "<a href="../Search.html">http://wiki.eclipse.org/SMILA/Documentation/Search</a>"</div> |
| <div id="catlinks"><p class='catlinks'><a href="http://wiki.eclipse.org/Special:Categories" title="Special:Categories">Category</a>: <span dir='ltr'><a href="http://wiki.eclipse.org/Category:SMILA" title="Category:SMILA">SMILA</a></span></p></div> <!-- end content --> |
| <div class="visualClear"></div> |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| |
| <!-- Yoink of toolbox for phoenix moved up --> |
| |
| |
| </div> |
| </div> |
| <div id="clearFooter"/> |
| <div id="footer" > |
| <ul id="footernav"> |
| <li class="first"><a href="http://www.eclipse.org/">Home</a></li> |
| <li><a href="http://www.eclipse.org/legal/privacy.php">Privacy Policy</a></li> |
| <li><a href="http://www.eclipse.org/legal/termsofuse.php">Terms of Use</a></li> |
| <li><a href="http://www.eclipse.org/legal/copyright.php">Copyright Agent</a></li> |
| <li><a href="http://www.eclipse.org/org/foundation/contact.php">Contact</a></li> |
| <li><a href="http://wiki.eclipse.org/Eclipsepedia:About" title="Eclipsepedia:About">About Eclipsepedia</a></li> |
| </ul> |
| <span id="copyright">Copyright © 2012 The Eclipse Foundation. All Rights Reserved</span> |
| <p id="footercredit">This page was last modified 11:07, 4 May 2012 by <a href="http://wiki.eclipse.org/index.php?title=User:Juergen.schumacher.attensity.com&action=edit" class="new" title="User:Juergen.schumacher.attensity.com">Juergen Schumacher</a>. Based on work by <a href="http://wiki.eclipse.org/User:Tmenzel.brox.de" title="User:Tmenzel.brox.de">thomas menzel</a>, <a href="http://wiki.eclipse.org/index.php?title=User:Daniel.stucky.attensity.com&action=edit" class="new" title="User:Daniel.stucky.attensity.com">Daniel Stucky</a> and <a href="http://wiki.eclipse.org/User:Drazen.cindric.attensity.com" title="User:Drazen.cindric.attensity.com">Drazen Cindric</a> and <a href="http://wiki.eclipse.org/index.php?title=SMILA/Documentation/Search&action=credits" title="SMILA/Documentation/Search">others</a>.</p> |
| <p id="footerviews">This page has been accessed 4,859 times.</p> |
| </div> |
| |
| <script type="text/javascript"> |
| var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); |
| document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); |
| </script> |
| <script type="text/javascript"> |
| var pageTracker = _gat._getTracker("UA-910670-4"); |
| pageTracker._trackPageview(); |
| </script> |
| |
| |
| |
| |
| |
| |
| |
| <!-- <div class="visualClear"></div> --> |
| |
| <script type="text/javascript">if (window.runOnloadHook) runOnloadHook();</script> |
| </div> |
| |
| <!-- Served in 0.056 secs. --></body></html> |
