2002-01-26 11:38:28 -05:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2004-03-04 09:41:28 -05:00
<!--
Copyright 1999-2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
2002-01-26 11:38:28 -05:00
<!-- Content Stylesheet for Site -->
<!-- start the processing -->
<!-- ====================================================================== -->
2002-12-12 01:23:48 -05:00
<!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! -->
2002-01-26 11:38:28 -05:00
<!-- Main Page Section -->
<!-- ====================================================================== -->
< html >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=iso-8859-1" / >
< meta name = "author" value = "Andrew C. Oliver" >
< meta name = "email" value = "acoliver@apache.org" >
2002-02-11 14:45:24 -05:00
2003-01-04 11:29:08 -05:00
2005-02-14 11:48:47 -05:00
< title > Apache Lucene - Apache Lucene - Building and Installing the Basic Demo< / title >
2006-08-22 09:38:16 -04:00
< link rel = "stylesheet" type = "text/css" href = "styles/lucene.css" >
2002-01-26 11:38:28 -05:00
< / head >
< body bgcolor = "#ffffff" text = "#000000" link = "#525D76" >
< table border = "0" width = "100%" cellspacing = "0" >
<!-- TOP IMAGE -->
< tr >
< td align = "left" >
2005-05-02 14:50:45 -04:00
< a href = "http://www.apache.org" > < img src = "http://lucene.apache.org/java/docs/images/asf-logo.gif" width = "387" height = "100" border = "0" / > < / a >
2002-01-26 11:38:28 -05:00
< / td >
< td align = "right" >
2005-02-14 11:48:47 -05:00
< a href = "http://lucene.apache.org/" > < img src = "./images/lucene_green_300.gif" alt = "Apache Lucene" border = "0" / > < / a >
2002-01-26 11:38:28 -05:00
< / td >
< / tr >
< / table >
< table border = "0" width = "100%" cellspacing = "4" >
< tr > < td colspan = "2" >
< hr noshade = "" size = "1" / >
< / td > < / tr >
< tr >
<!-- LEFT SIDE NAVIGATION -->
< td width = "20%" valign = "top" nowrap = "true" >
2003-10-09 10:40:30 -04:00
<!-- ============================================================ -->
< p > < strong > About< / strong > < / p >
2002-01-26 11:38:28 -05:00
< ul >
< li > < a href = "./index.html" > Overview< / a >
2005-05-14 19:05:04 -04:00
< / li >
< li > < a href = "./features.html" > Features< / a >
2002-01-26 11:38:28 -05:00
< / li >
2004-05-18 09:32:01 -04:00
< li > < a href = "http://wiki.apache.org/jakarta-lucene/PoweredBy" > Powered by Lucene< / a >
2002-01-26 11:38:28 -05:00
< / li >
< li > < a href = "./whoweare.html" > Who We Are< / a >
< / li >
2005-03-26 07:58:35 -05:00
< li > < a href = "./mailinglists.html" > Mailing Lists< / a >
2002-01-26 11:38:28 -05:00
< / li >
< / ul >
< p > < strong > Resources< / strong > < / p >
< ul >
2004-02-28 21:43:36 -05:00
< li > < a href = "http://wiki.apache.org/jakarta-lucene" > Wiki< / a >
< / li >
2004-12-30 16:50:43 -05:00
< li > < a href = "http://wiki.apache.org/jakarta-lucene/LuceneFAQ" > FAQ< / a >
2002-06-20 10:23:48 -04:00
< / li >
< li > < a href = "./gettingstarted.html" > Getting Started< / a >
2002-05-16 01:16:10 -04:00
< / li >
< li > < a href = "./queryparsersyntax.html" > Query Syntax< / a >
2002-10-29 23:14:11 -05:00
< / li >
< li > < a href = "./fileformats.html" > File Formats< / a >
2006-09-11 21:05:20 -04:00
< / li >
< li > < a href = "./scoring.html" > Scoring< / a >
2002-01-26 11:38:28 -05:00
< / li >
< li > < a href = "./api/index.html" > Javadoc< / a >
< / li >
< li > < a href = "./contributions.html" > Contributions< / a >
2002-12-04 00:56:33 -05:00
< / li >
< li > < a href = "./benchmarks.html" > Benchmarks< / a >
2002-11-29 16:23:47 -05:00
< / li >
2005-09-21 06:41:16 -04:00
< li > < a href = "http://issues.apache.org/jira/browse/LUCENE" > Issue Tracker< / a >
2002-12-04 00:56:33 -05:00
< / li >
< li > < a href = "./lucene-sandbox/" > Lucene Sandbox< / a >
2002-01-26 11:38:28 -05:00
< / li >
< / ul >
< p > < strong > Download< / strong > < / p >
< ul >
2006-02-21 11:31:28 -05:00
< li > < a href = "http://www.apache.org/dyn/closer.cgi/lucene/java/" > Releases< / a >
2002-01-26 11:38:28 -05:00
< / li >
2006-02-21 11:31:28 -05:00
< li > < a href = "http://svn.apache.org/viewcvs.cgi/lucene/java/" > Source Repository< / a >
2002-01-26 11:38:28 -05:00
< / li >
< / ul >
< / td >
< td width = "80%" align = "left" valign = "top" >
< table border = "0" cellspacing = "0" cellpadding = "2" width = "100%" >
< tr > < td bgcolor = "#525D76" >
< font color = "#ffffff" face = "arial,helvetica,sanserif" >
< a name = "About this Document" > < strong > About this Document< / strong > < / a >
< / font >
< / td > < / tr >
< tr > < td >
< blockquote >
< p >
2006-08-03 18:24:42 -04:00
This document is intended as a "getting started" guide to using and running the Lucene demos.
It walks you through some basic installation and configuration.
2002-01-26 11:38:28 -05:00
< / p >
< / blockquote >
< / p >
< / td > < / tr >
< tr > < td > < br / > < / td > < / tr >
< / table >
< table border = "0" cellspacing = "0" cellpadding = "2" width = "100%" >
< tr > < td bgcolor = "#525D76" >
< font color = "#ffffff" face = "arial,helvetica,sanserif" >
< a name = "About the Demos" > < strong > About the Demos< / strong > < / a >
< / font >
< / td > < / tr >
< tr > < td >
< blockquote >
< p >
2006-08-03 18:24:42 -04:00
The Lucene command-line demo code consists of two applications that demonstrate various
functionalities of Lucene and how one should go about adding Lucene to their applications.
2002-01-26 11:38:28 -05:00
< / p >
< / blockquote >
< / p >
< / td > < / tr >
< tr > < td > < br / > < / td > < / tr >
< / table >
< table border = "0" cellspacing = "0" cellpadding = "2" width = "100%" >
< tr > < td bgcolor = "#525D76" >
< font color = "#ffffff" face = "arial,helvetica,sanserif" >
2006-08-03 18:24:42 -04:00
< a name = "Setting your CLASSPATH" > < strong > Setting your CLASSPATH< / strong > < / a >
2002-01-26 11:38:28 -05:00
< / font >
< / td > < / tr >
< tr > < td >
< blockquote >
< p >
2006-08-03 18:24:42 -04:00
First, you should < a href = "http://www.apache.org/dyn/closer.cgi/lucene/java/" > download< / a > the
latest Lucene distribution and then extract it to a working directory. Alternatively, you can < a href = "http://wiki.apache.org/jakarta-lucene/SourceRepository" > check out the sources from
Subversion< / a > , and then run < code > ant war-demo< / code > to generate the JARs and WARs.
2002-01-26 11:38:28 -05:00
< / p >
< p >
2006-08-03 18:24:42 -04:00
You should see the Lucene JAR file in the directory you created when you extracted the archive. It
should be named something like < code > lucene-core-{version}.jar< / code > . You should also see a file
called < code > lucene-demos-{version}.jar< / code > . If you checked out the sources from Subversion then
the JARs are located under the < code > build< / code > subdirectory (after running < code > ant< / code >
successfully). Put both of these files in your Java CLASSPATH.
2002-01-26 11:38:28 -05:00
< / p >
< / blockquote >
< / p >
< / td > < / tr >
< tr > < td > < br / > < / td > < / tr >
< / table >
< table border = "0" cellspacing = "0" cellpadding = "2" width = "100%" >
< tr > < td bgcolor = "#525D76" >
< font color = "#ffffff" face = "arial,helvetica,sanserif" >
< a name = "Indexing Files" > < strong > Indexing Files< / strong > < / a >
< / font >
< / td > < / tr >
< tr > < td >
< blockquote >
< p >
2006-08-03 18:24:42 -04:00
Once you've gotten this far you're probably itching to go. Let's < b > build an index!< / b > Assuming
you've set your CLASSPATH correctly, just type:
< pre >
java org.apache.lucene.demo.IndexFiles {full-path-to-lucene}/src
< / pre >
This will produce a subdirectory called < code > index< / code > which will contain an index of all of the
Lucene source code.
2002-01-26 11:38:28 -05:00
< / p >
< p >
2006-08-03 18:24:42 -04:00
To < b > search the index< / b > type:
< pre >
java org.apache.lucene.demo.SearchFiles
< / pre >
You'll be prompted for a query. Type in a swear word and press the enter key. You'll see that the
Lucene developers are very well mannered and get no results. Now try entering the word "vector".
That should return a whole bunch of documents. The results will page at every tenth result and ask
you whether you want more results.
2002-01-26 11:38:28 -05:00
< / p >
< / blockquote >
< / p >
< / td > < / tr >
< tr > < td > < br / > < / td > < / tr >
< / table >
< table border = "0" cellspacing = "0" cellpadding = "2" width = "100%" >
< tr > < td bgcolor = "#525D76" >
< font color = "#ffffff" face = "arial,helvetica,sanserif" >
< a name = "About the code..." > < strong > About the code...< / strong > < / a >
< / font >
< / td > < / tr >
< tr > < td >
< blockquote >
< p >
< a href = "demo2.html" > read on> > > < / a >
< / p >
< / blockquote >
< / p >
< / td > < / tr >
< tr > < td > < br / > < / td > < / tr >
< / table >
< / td >
< / tr >
<!-- FOOTER -->
< tr > < td colspan = "2" >
< hr noshade = "" size = "1" / >
< / td > < / tr >
< tr > < td colspan = "2" >
< div align = "center" > < font color = "#525D76" size = "-1" > < em >
2005-01-18 08:57:32 -05:00
Copyright © 1999-2005, The Apache Software Foundation
2002-01-26 11:38:28 -05:00
< / em > < / font > < / div >
< / td > < / tr >
< / table >
< / body >
< / html >
<!-- end the processing -->
2002-02-11 14:45:24 -05:00
