2007-06-26 00:26:07 -04:00
|
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
2006-11-26 19:03:13 -05:00
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
|
|
|
<meta content="Apache Forrest" name="Generator">
|
2007-06-26 00:26:07 -04:00
|
|
|
<meta name="Forrest-version" content="0.8">
|
2009-06-24 12:20:00 -04:00
|
|
|
<meta name="Forrest-skin-name" content="lucene">
|
2006-11-26 19:03:13 -05:00
|
|
|
<title>
|
|
|
|
|
Apache Lucene - Getting Started Guide
|
|
|
|
|
</title>
|
|
|
|
|
<link type="text/css" href="skin/basic.css" rel="stylesheet">
|
|
|
|
|
<link media="screen" type="text/css" href="skin/screen.css" rel="stylesheet">
|
|
|
|
|
<link media="print" type="text/css" href="skin/print.css" rel="stylesheet">
|
|
|
|
|
<link type="text/css" href="skin/profile.css" rel="stylesheet">
|
|
|
|
|
<script src="skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="skin/fontsize.js" language="javascript" type="text/javascript"></script>
|
|
|
|
|
<link rel="shortcut icon" href="images/favicon.ico">
|
|
|
|
|
</head>
|
|
|
|
|
<body onload="init()">
|
|
|
|
|
<script type="text/javascript">ndeSetTextSize();</script>
|
|
|
|
|
<div id="top">
|
2007-06-26 00:26:07 -04:00
|
|
|
<!--+
|
|
|
|
|
|breadtrail
|
|
|
|
|
+-->
|
2006-11-26 19:03:13 -05:00
|
|
|
<div class="breadtrail">
|
2006-12-02 07:11:45 -05:00
|
|
|
<a href="http://www.apache.org/">Apache</a> > <a href="http://lucene.apache.org/">Lucene</a><script src="skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
|
2006-11-26 19:03:13 -05:00
|
|
|
</div>
|
2007-06-26 00:26:07 -04:00
|
|
|
<!--+
|
|
|
|
|
|header
|
|
|
|
|
+-->
|
2006-11-26 19:03:13 -05:00
|
|
|
<div class="header">
|
2007-06-26 00:26:07 -04:00
|
|
|
<!--+
|
|
|
|
|
|start group logo
|
|
|
|
|
+-->
|
2006-11-26 19:03:13 -05:00
|
|
|
<div class="grouplogo">
|
2006-12-02 07:11:45 -05:00
|
|
|
<a href="http://lucene.apache.org/"><img class="logoImage" alt="Lucene" src="http://www.apache.org/images/asf_logo_simple.png" title="Apache Lucene"></a>
|
2006-11-26 19:03:13 -05:00
|
|
|
</div>
|
2007-06-26 00:26:07 -04:00
|
|
|
<!--+
|
|
|
|
|
|end group logo
|
|
|
|
|
+-->
|
|
|
|
|
<!--+
|
|
|
|
|
|start Project Logo
|
|
|
|
|
+-->
|
2006-11-26 19:03:13 -05:00
|
|
|
<div class="projectlogo">
|
|
|
|
|
<a href="http://lucene.apache.org/java/"><img class="logoImage" alt="Lucene" src="http://lucene.apache.org/images/lucene_green_300.gif" title="Apache Lucene is a high-performance, full-featured text search engine library written entirely in
|
|
|
|
|
Java. It is a technology suitable for nearly any application that requires full-text search, especially cross-platform."></a>
|
|
|
|
|
</div>
|
2007-06-26 00:26:07 -04:00
|
|
|
<!--+
|
|
|
|
|
|end Project Logo
|
|
|
|
|
+-->
|
|
|
|
|
<!--+
|
|
|
|
|
|start Search
|
|
|
|
|
+-->
|
2006-11-26 19:03:13 -05:00
|
|
|
<div class="searchbox">
|
2009-06-24 12:20:00 -04:00
|
|
|
<form action="http://search.lucidimagination.com/p:lucene" method="get" class="roundtopsmall">
|
2009-07-09 09:06:51 -04:00
|
|
|
<input onFocus="getBlank (this, 'Search the site with Lucene');" size="25" name="q" id="query" type="text" value="Search the site with Lucene">
|
2007-06-26 00:26:07 -04:00
|
|
|
<input name="Search" value="Search" type="submit">
|
2006-11-26 19:03:13 -05:00
|
|
|
</form>
|
2009-06-24 12:20:00 -04:00
|
|
|
<div style="position: relative; top: -5px; left: -10px">Powered by <a href="http://www.lucidimagination.com" style="color: #033268">Lucid Imagination</a>
|
|
|
|
|
</div>
|
2006-11-26 19:03:13 -05:00
|
|
|
</div>
|
2007-06-26 00:26:07 -04:00
|
|
|
<!--+
|
|
|
|
|
|end search
|
|
|
|
|
+-->
|
|
|
|
|
<!--+
|
|
|
|
|
|start Tabs
|
|
|
|
|
+-->
|
2006-11-26 19:03:13 -05:00
|
|
|
<ul id="tabs">
|
|
|
|
|
<li class="current">
|
2008-01-11 18:21:01 -05:00
|
|
|
<a class="selected" href="http://lucene.apache.org/java/docs/">Main</a>
|
2006-11-26 19:03:13 -05:00
|
|
|
</li>
|
|
|
|
|
<li>
|
2007-06-26 00:26:07 -04:00
|
|
|
<a class="unselected" href="http://wiki.apache.org/lucene-java">Wiki</a>
|
2006-11-26 19:03:13 -05:00
|
|
|
</li>
|
2008-01-11 18:21:01 -05:00
|
|
|
<li class="current">
|
2008-10-03 12:12:29 -04:00
|
|
|
<a class="selected" href="index.html">Lucene 2.9-dev Documentation</a>
|
2008-01-11 18:21:01 -05:00
|
|
|
</li>
|
2006-11-26 19:03:13 -05:00
|
|
|
</ul>
|
2007-06-26 00:26:07 -04:00
|
|
|
<!--+
|
|
|
|
|
|end Tabs
|
|
|
|
|
+-->
|
2006-11-26 19:03:13 -05:00
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div id="main">
|
|
|
|
|
<div id="publishedStrip">
|
2007-06-26 00:26:07 -04:00
|
|
|
<!--+
|
|
|
|
|
|start Subtabs
|
|
|
|
|
+-->
|
2006-11-26 19:03:13 -05:00
|
|
|
<div id="level2tabs"></div>
|
2007-06-26 00:26:07 -04:00
|
|
|
<!--+
|
|
|
|
|
|end Endtabs
|
|
|
|
|
+-->
|
2006-11-26 19:03:13 -05:00
|
|
|
<script type="text/javascript"><!--
|
2007-06-26 00:26:07 -04:00
|
|
|
document.write("Last Published: " + document.lastModified);
|
2006-11-26 19:03:13 -05:00
|
|
|
// --></script>
|
|
|
|
|
</div>
|
2007-06-26 00:26:07 -04:00
|
|
|
<!--+
|
|
|
|
|
|breadtrail
|
|
|
|
|
+-->
|
2006-11-26 19:03:13 -05:00
|
|
|
<div class="breadtrail">
|
2007-06-26 00:26:07 -04:00
|
|
|
|
2006-11-26 19:03:13 -05:00
|
|
|
|
|
|
|
|
</div>
|
2007-06-26 00:26:07 -04:00
|
|
|
<!--+
|
|
|
|
|
|start Menu, mainarea
|
|
|
|
|
+-->
|
|
|
|
|
<!--+
|
|
|
|
|
|start Menu
|
|
|
|
|
+-->
|
2006-11-26 19:03:13 -05:00
|
|
|
<div id="menu">
|
2008-01-11 18:21:01 -05:00
|
|
|
<div onclick="SwitchMenu('menu_selected_1.1', 'skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('skin/images/chapter_open.gif');">Documentation</div>
|
|
|
|
|
<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
|
2006-11-26 19:03:13 -05:00
|
|
|
<div class="menuitem">
|
2008-01-11 18:21:01 -05:00
|
|
|
<a href="index.html">Overview</a>
|
2006-11-26 19:03:13 -05:00
|
|
|
</div>
|
2008-01-11 18:21:01 -05:00
|
|
|
<div onclick="SwitchMenu('menu_1.1.2', 'skin/')" id="menu_1.1.2Title" class="menutitle">Javadocs</div>
|
|
|
|
|
<div id="menu_1.1.2" class="menuitemgroup">
|
2006-11-26 19:03:13 -05:00
|
|
|
<div class="menuitem">
|
2009-03-13 17:20:06 -04:00
|
|
|
<a href="api/all/index.html">All</a>
|
2006-11-26 19:03:13 -05:00
|
|
|
</div>
|
|
|
|
|
<div class="menuitem">
|
2008-01-11 18:21:01 -05:00
|
|
|
<a href="api/core/index.html">Core</a>
|
2006-11-26 19:03:13 -05:00
|
|
|
</div>
|
|
|
|
|
<div class="menuitem">
|
2008-01-11 18:21:01 -05:00
|
|
|
<a href="api/demo/index.html">Demo</a>
|
2006-11-26 19:03:13 -05:00
|
|
|
</div>
|
2008-01-11 18:21:01 -05:00
|
|
|
<div onclick="SwitchMenu('menu_1.1.2.4', 'skin/')" id="menu_1.1.2.4Title" class="menutitle">Contrib</div>
|
|
|
|
|
<div id="menu_1.1.2.4" class="menuitemgroup">
|
2006-11-26 19:03:13 -05:00
|
|
|
<div class="menuitem">
|
2008-01-11 18:21:01 -05:00
|
|
|
<a href="api/contrib-analyzers/index.html">Analyzers</a>
|
2006-11-26 19:03:13 -05:00
|
|
|
</div>
|
|
|
|
|
<div class="menuitem">
|
2009-07-23 14:32:12 -04:00
|
|
|
<a href="api/contrib-smartcn/index.html">Smart Chinese Analyzer</a>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="menuitem">
|
2008-01-11 18:21:01 -05:00
|
|
|
<a href="api/contrib-ant/index.html">Ant</a>
|
2006-11-26 19:03:13 -05:00
|
|
|
</div>
|
|
|
|
|
<div class="menuitem">
|
2008-01-11 18:21:01 -05:00
|
|
|
<a href="api/contrib-bdb/index.html">Bdb</a>
|
2006-11-26 19:03:13 -05:00
|
|
|
</div>
|
|
|
|
|
<div class="menuitem">
|
2008-01-11 18:21:01 -05:00
|
|
|
<a href="api/contrib-bdb-je/index.html">Bdb-je</a>
|
2006-11-26 19:03:13 -05:00
|
|
|
</div>
|
|
|
|
|
<div class="menuitem">
|
2008-01-11 18:21:01 -05:00
|
|
|
<a href="api/contrib-benchmark/index.html">Benchmark</a>
|
2006-11-26 19:03:13 -05:00
|
|
|
</div>
|
|
|
|
|
<div class="menuitem">
|
2009-03-19 06:51:55 -04:00
|
|
|
<a href="api/contrib-collation/index.html">Collation</a>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="menuitem">
|
2009-07-09 09:06:51 -04:00
|
|
|
<a href="api/contrib-fast-vector-highlighter/index.html">Fast Vector Highlighter</a>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="menuitem">
|
2008-01-11 18:21:01 -05:00
|
|
|
<a href="api/contrib-highlighter/index.html">Highlighter</a>
|
2006-11-26 19:03:13 -05:00
|
|
|
</div>
|
|
|
|
|
<div class="menuitem">
|
2008-10-11 13:28:23 -04:00
|
|
|
<a href="api/contrib-instantiated/index.html">Instantiated</a>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="menuitem">
|
2008-01-11 18:21:01 -05:00
|
|
|
<a href="api/contrib-lucli/index.html">Lucli</a>
|
2006-11-26 19:03:13 -05:00
|
|
|
</div>
|
|
|
|
|
<div class="menuitem">
|
2008-01-11 18:21:01 -05:00
|
|
|
<a href="api/contrib-memory/index.html">Memory</a>
|
2006-11-26 19:03:13 -05:00
|
|
|
</div>
|
2007-12-04 07:56:22 -05:00
|
|
|
<div class="menuitem">
|
2008-01-11 18:21:01 -05:00
|
|
|
<a href="api/contrib-misc/index.html">Miscellaneous</a>
|
2007-12-04 07:56:22 -05:00
|
|
|
</div>
|
2006-11-26 19:03:13 -05:00
|
|
|
<div class="menuitem">
|
2008-01-11 18:21:01 -05:00
|
|
|
<a href="api/contrib-queries/index.html">Queries</a>
|
2007-12-04 07:56:22 -05:00
|
|
|
</div>
|
|
|
|
|
<div class="menuitem">
|
2009-08-03 00:04:08 -04:00
|
|
|
<a href="api/contrib-queryparser/index.html">Query Parser Framework</a>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="menuitem">
|
2008-01-11 18:21:01 -05:00
|
|
|
<a href="api/contrib-regex/index.html">Regex</a>
|
2007-12-04 07:56:22 -05:00
|
|
|
</div>
|
|
|
|
|
<div class="menuitem">
|
2009-06-15 08:45:05 -04:00
|
|
|
<a href="api/contrib-remote/index.html">Remote</a>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="menuitem">
|
2008-01-11 18:21:01 -05:00
|
|
|
<a href="api/contrib-snowball/index.html">Snowball</a>
|
2007-12-04 07:56:22 -05:00
|
|
|
</div>
|
2006-11-26 19:03:13 -05:00
|
|
|
<div class="menuitem">
|
2009-05-19 01:11:26 -04:00
|
|
|
<a href="api/contrib-spatial/index.html">Spatial</a>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="menuitem">
|
2008-01-11 18:21:01 -05:00
|
|
|
<a href="api/contrib-spellchecker/index.html">Spellchecker</a>
|
2006-12-02 07:11:45 -05:00
|
|
|
</div>
|
|
|
|
|
<div class="menuitem">
|
2008-01-11 18:21:01 -05:00
|
|
|
<a href="api/contrib-surround/index.html">Surround</a>
|
2006-11-26 19:03:13 -05:00
|
|
|
</div>
|
|
|
|
|
<div class="menuitem">
|
2008-01-11 18:21:01 -05:00
|
|
|
<a href="api/contrib-swing/index.html">Swing</a>
|
2006-11-26 19:03:13 -05:00
|
|
|
</div>
|
|
|
|
|
<div class="menuitem">
|
2008-01-13 13:36:22 -05:00
|
|
|
<a href="api/contrib-wikipedia/index.html">Wikipedia</a>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="menuitem">
|
2008-01-11 18:21:01 -05:00
|
|
|
<a href="api/contrib-wordnet/index.html">Wordnet</a>
|
2006-11-26 19:03:13 -05:00
|
|
|
</div>
|
|
|
|
|
<div class="menuitem">
|
2008-01-11 18:21:01 -05:00
|
|
|
<a href="api/contrib-xml-query-parser/index.html">XML Query Parser</a>
|
2006-12-09 11:32:22 -05:00
|
|
|
</div>
|
2006-11-26 19:03:13 -05:00
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="menuitem">
|
2008-01-11 18:21:01 -05:00
|
|
|
<a href="contributions.html">Contributions</a>
|
2007-02-18 09:24:11 -05:00
|
|
|
</div>
|
2007-06-19 04:00:51 -04:00
|
|
|
<div class="menuitem">
|
2008-01-11 18:21:01 -05:00
|
|
|
<a href="http://wiki.apache.org/lucene-java/LuceneFAQ">FAQ</a>
|
2006-11-26 19:03:13 -05:00
|
|
|
</div>
|
|
|
|
|
<div class="menuitem">
|
2008-01-11 18:21:01 -05:00
|
|
|
<a href="fileformats.html">File Formats</a>
|
2006-11-26 19:03:13 -05:00
|
|
|
</div>
|
2008-01-11 18:21:01 -05:00
|
|
|
<div class="menupage">
|
|
|
|
|
<div class="menupagetitle">Getting Started</div>
|
2006-11-26 19:03:13 -05:00
|
|
|
</div>
|
|
|
|
|
<div class="menuitem">
|
2008-01-11 18:21:01 -05:00
|
|
|
<a href="lucene-sandbox/index.html">Lucene Sandbox</a>
|
2006-11-26 19:03:13 -05:00
|
|
|
</div>
|
|
|
|
|
<div class="menuitem">
|
2008-01-11 18:21:01 -05:00
|
|
|
<a href="queryparsersyntax.html">Query Syntax</a>
|
2006-11-26 19:03:13 -05:00
|
|
|
</div>
|
|
|
|
|
<div class="menuitem">
|
2008-01-11 18:21:01 -05:00
|
|
|
<a href="scoring.html">Scoring</a>
|
2006-11-26 19:03:13 -05:00
|
|
|
</div>
|
|
|
|
|
<div class="menuitem">
|
2008-01-11 18:21:01 -05:00
|
|
|
<a href="http://wiki.apache.org/lucene-java">Wiki</a>
|
2006-11-26 19:03:13 -05:00
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div id="credit"></div>
|
|
|
|
|
<div id="roundbottom">
|
|
|
|
|
<img style="display: none" class="corner" height="15" width="15" alt="" src="skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
|
2007-06-26 00:26:07 -04:00
|
|
|
<!--+
|
|
|
|
|
|alternative credits
|
|
|
|
|
+-->
|
2006-11-26 19:03:13 -05:00
|
|
|
<div id="credit2"></div>
|
|
|
|
|
</div>
|
2007-06-26 00:26:07 -04:00
|
|
|
<!--+
|
|
|
|
|
|end Menu
|
|
|
|
|
+-->
|
|
|
|
|
<!--+
|
|
|
|
|
|start content
|
|
|
|
|
+-->
|
2006-11-26 19:03:13 -05:00
|
|
|
<div id="content">
|
|
|
|
|
<div title="Portable Document Format" class="pdflink">
|
|
|
|
|
<a class="dida" href="gettingstarted.pdf"><img alt="PDF -icon" src="skin/images/pdfdoc.gif" class="skin"><br>
|
|
|
|
|
PDF</a>
|
|
|
|
|
</div>
|
|
|
|
|
<h1>
|
|
|
|
|
Apache Lucene - Getting Started Guide
|
|
|
|
|
</h1>
|
|
|
|
|
<div id="minitoc-area">
|
|
|
|
|
<ul class="minitoc">
|
|
|
|
|
<li>
|
|
|
|
|
<a href="#Getting Started">Getting Started</a>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a name="N10013"></a><a name="Getting Started"></a>
|
|
|
|
|
<h2 class="boxed">Getting Started</h2>
|
|
|
|
|
<div class="section">
|
|
|
|
|
<p>
|
|
|
|
|
This document is intended as a "getting started" guide. It has three audiences: first-time users
|
|
|
|
|
looking to install Apache Lucene in their application or web server; developers looking to modify or base
|
|
|
|
|
the applications they develop on Lucene; and developers looking to become involved in and contribute
|
|
|
|
|
to the development of Lucene. This document is written in tutorial and walk-through format. The
|
|
|
|
|
goal is to help you "get started". It does not go into great depth on some of the conceptual or
|
|
|
|
|
inner details of Lucene.
|
|
|
|
|
</p>
|
|
|
|
|
<p>
|
|
|
|
|
Each section listed below builds on one another. More advanced users
|
|
|
|
|
may wish to skip sections.
|
|
|
|
|
</p>
|
|
|
|
|
<ul>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<a href="demo.html">About the command-line Lucene demo and its usage</a>. This section
|
|
|
|
|
is intended for anyone who wants to use the command-line Lucene demo.</li>
|
|
|
|
|
<p></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<a href="demo2.html">About the sources and implementation for the command-line Lucene
|
|
|
|
|
demo</a>. This section walks through the implementation details (sources) of the
|
|
|
|
|
command-line Lucene demo. This section is intended for developers.</li>
|
|
|
|
|
<p></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<a href="demo3.html">About installing and configuring the demo template web
|
|
|
|
|
application</a>. While this walk-through assumes Tomcat as your container of choice,
|
|
|
|
|
there is no reason you can't (provided you have the requisite knowledge) adapt the
|
|
|
|
|
instructions to your container. This section is intended for those responsible for the
|
|
|
|
|
development or deployment of Lucene-based web applications.</li>
|
|
|
|
|
<p></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<a href="demo4.html">About the sources used to construct the demo template web
|
|
|
|
|
application</a>. Please note the template application is designed to highlight features of
|
|
|
|
|
Lucene and is <b>not</b> an example of best practices. (One would hopefully use MVC
|
|
|
|
|
architecture such as provided by Jakarta Struts and taglibs, but showing you how to do that
|
|
|
|
|
would be WAY beyond the scope of this guide.) This section is intended for developers and
|
|
|
|
|
those wishing to customize the demo template web application to their needs. </li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
2007-06-26 00:26:07 -04:00
|
|
|
<!--+
|
|
|
|
|
|end content
|
|
|
|
|
+-->
|
2006-11-26 19:03:13 -05:00
|
|
|
<div class="clearboth"> </div>
|
|
|
|
|
</div>
|
|
|
|
|
<div id="footer">
|
2007-06-26 00:26:07 -04:00
|
|
|
<!--+
|
|
|
|
|
|start bottomstrip
|
|
|
|
|
+-->
|
2006-11-26 19:03:13 -05:00
|
|
|
<div class="lastmodified">
|
|
|
|
|
<script type="text/javascript"><!--
|
2007-06-26 00:26:07 -04:00
|
|
|
document.write("Last Published: " + document.lastModified);
|
2006-11-26 19:03:13 -05:00
|
|
|
// --></script>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="copyright">
|
|
|
|
|
Copyright ©
|
|
|
|
|
2006 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
|
|
|
|
|
</div>
|
2007-06-26 00:26:07 -04:00
|
|
|
<!--+
|
|
|
|
|
|end bottomstrip
|
|
|
|
|
+-->
|
2006-11-26 19:03:13 -05:00
|
|
|
</div>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
