1. Introduction
2. Sample application files
3. Setting up the sample applications
Oracle Ultra Search provides a fully functional sample application for querying indexes and displaying the query results. The sample application is provided as a Java Server Page (JSP) application. The sample query application is able to view search results that refer to web pages, database table row content and local files.
In addition to the sample query application, Oracle Ultra Search also provides a sample Mailing List Browser written in JSP. The Mailing List Browser can be used to display email addressed to mailing lists that have been indexed by the Ultra Search system.
The sample JSP query application invokes the Oracle Ultra Search Java Query API. The Mailing List Browser invokes the Oracle Ultra Search Email API.
The sample applications are fully functional and can be minimally customized to support the look-and-feel of your organization. Alternatively, you can build your own sample applications from scratch. If you decide to do so, you can still refer to the sample application code for an understanding of how to invoke the various Oracle Ultra Search APIs.
Complete and comprehensive documentation on each API is provided in the following documents:
- Ultra Search Java Query API
- Ultra Search Java Email API
The sample application files are located in the $ORACLE_HOME/ultrasearch/sample directory. You can directly view the sample application source code using your preferred text editor.
The following tables list and describe all sample application files:
| File | Description |
| sample_readme.html | This file. |
| styles.css | Style sheet for sample query web application. |
| mail.css | Style sheet for sample email web application. |
| File | Description |
| jsp/gsearch.jsp | Sample JSP Query Application, non-framed version. Renders the Basic and Advanced query screens. |
| jsp/gsearchf.jsp | Sample JSP Query Application, framed version. Renders the Basic and Advanced query screens. |
| jsp/gutil.jsp | Sample JSP page for soliciting feedback from the end-user, allowing the end user to add a seed URL and providing a help page to the end user. |
| jsp/display.jsp | JSP page for reading and displaying file and table record data. |
| File | Description |
| jsp/mail.jsp | Mailing List Browser application that selectively includes HTML code returned by other JSP files depending on what the end-user wishes to view. |
| jsp/mailindex.jsp | JSP page that displays all email sources (mailing lists) of an Ultra Search instance. |
| jsp/mailmsgs.jsp | JSP page that displays all emails for an email source (mailing list). |
| jsp/mailreader.jsp | JSP page that displays an email (non-framed version). |
| jsp/mailreaderf.jsp | JSP page that displays an email (framed version). |
| jsp/mailutil.jsp | JSP page that defines various functions that are used by mailreader.jsp (non-framed version) |
| jsp/mailutilf.jsp | JSP page that defines various functions that are used by mailreaderf.jsp (framed version) |
| File | Description |
| images/c.gif | Image used in sample query application |
| images/home.gif | Home image used in sample query application |
| images/logo_sp.gif | Oracle logo image |
| images/logored.gif | Oracle logo image in red color |
| images/roundbl.gif | Rounded left corner graphic for creating illusion of round edged tables. |
| images/roundbr.gif | Rounded right corner graphic for creating illusion of round edged tables. |
| images/webview.gif | Oracle logo with picture of the Earth |
| images/wsd.gif | Background image used in sample query application |
3.1 Setting up the JSP sample application
Detailed instructions on setting up the Sample JSP Query Application and the Sample JSP Email Browser are located in the Oracle Ultra Search document titled "Installing the Ultra Search Middle-Tier Components on web server hosts".
3.2 Using the framed versions of the sample applications
The non-framed versions of the Sample Query Appications and the Mailing List Browser Application are preferred above the framed versions. This is because framed HTML pages are often inconsistently rendered, depending on the browser type as well as the browser settings.
However, if you prefer to invoke the framed version of the Sample JSP Query Appication, simply invoke gsearchf.jsp instead of gsearch.jsp.
If you prefer to invoke the framed version of the Mailing List Browser Application, the easiest solution is to rename the mailreaderf.jsp and mailutilf.jsp files as mailreader.jsp and mailutil.jsp respectively. You should first copy the original mailreader.jsp and mailutil.jsp files to a safe place before doing so.