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" >
2006-11-26 19:03:13 -05:00
< meta name = "Forrest-skin-name" content = "pelt" >
< title >
Apache Lucene - Building and Installing the Basic Demo
< / 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" >
< form action = "http://www.google.com/search" method = "get" class = "roundtopsmall" >
< input value = "lucene.apache.org" name = "sitesearch" type = "hidden" > < input onFocus = "getBlank (this, 'Search the site with google');" size = "25" name = "q" id = "query" type = "text" value = "Search the site with google" >
2007-06-26 00:26:07 -04:00
< input name = "Search" value = "Search" type = "submit" >
2006-11-26 19:03:13 -05:00
< / form >
< / 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_1.1', 'skin/')" id = "menu_1.1Title" class = "menutitle" > Documentation< / div >
2006-11-26 19:03:13 -05:00
< div id = "menu_1.1" class = "menuitemgroup" >
< 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" >
2008-01-13 13:36:22 -05:00
< a href = "api/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" >
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" >
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-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" >
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" >
2008-01-11 18:21:01 -05:00
< a href = "api/contrib-snowball/index.html" > Snowball< / 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-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 = "benchmarks.html" > Benchmarks< / a >
2006-11-26 19:03:13 -05:00
< / div >
2007-02-18 09:24:11 -05:00
< 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 >
< div class = "menuitem" >
2008-01-11 18:21:01 -05:00
< a href = "gettingstarted.html" > Getting Started< / a >
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 = "demo.pdf" > < img alt = "PDF -icon" src = "skin/images/pdfdoc.gif" class = "skin" > < br >
PDF< / a >
< / div >
< h1 >
Apache Lucene - Building and Installing the Basic Demo
< / h1 >
< div id = "minitoc-area" >
< ul class = "minitoc" >
< li >
< a href = "#About this Document" > About this Document< / a >
< / li >
< li >
< a href = "#About the Demos" > About the Demos< / a >
< / li >
< li >
< a href = "#Setting your CLASSPATH" > Setting your CLASSPATH< / a >
< / li >
< li >
< a href = "#Indexing Files" > Indexing Files< / a >
< / li >
< li >
< a href = "#About the code..." > About the code...< / a >
< / li >
< / ul >
< / div >
< a name = "N10013" > < / a > < a name = "About this Document" > < / a >
< h2 class = "boxed" > About this Document< / h2 >
< div class = "section" >
< p >
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.
< / p >
< / div >
< a name = "N1001C" > < / a > < a name = "About the Demos" > < / a >
< h2 class = "boxed" > About the Demos< / h2 >
< div class = "section" >
< p >
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.
< / p >
< / div >
< a name = "N10025" > < / a > < a name = "Setting your CLASSPATH" > < / a >
< h2 class = "boxed" > Setting your CLASSPATH< / h2 >
< div class = "section" >
< p >
First, you should < a href = "http://www.apache.org/dyn/closer.cgi/lucene/java/" > download< / a > the
2007-03-09 17:29:00 -05:00
latest Lucene distribution and then extract it to a working directory. Alternatively, you can < a href = "http://wiki.apache.org/lucene-java/SourceRepository" > check out the sources from
2006-11-26 19:03:13 -05:00
Subversion< / a > , and then run < span class = "codefrag" > ant war-demo< / span > to generate the JARs and WARs.
< / p >
< p >
You should see the Lucene JAR file in the directory you created when you extracted the archive. It
should be named something like < span class = "codefrag" > lucene-core-{version}.jar< / span > . You should also see a file
called < span class = "codefrag" > lucene-demos-{version}.jar< / span > . If you checked out the sources from Subversion then
the JARs are located under the < span class = "codefrag" > build< / span > subdirectory (after running < span class = "codefrag" > ant< / span >
successfully). Put both of these files in your Java CLASSPATH.
< / p >
< / div >
< a name = "N10048" > < / a > < a name = "Indexing Files" > < / a >
< h2 class = "boxed" > Indexing Files< / h2 >
< div class = "section" >
< p >
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 < span class = "codefrag" > index< / span > which will contain an index of all of the
Lucene source code.
< / p >
< p >
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
2008-09-10 17:30:52 -04:00
Lucene developers are very well mannered and get no results. Now try entering the word "string".
2006-11-26 19:03:13 -05:00
That should return a whole bunch of documents. The results will page at every tenth result and ask
you whether you want more results.
< / p >
< / div >
< a name = "N10063" > < / a > < a name = "About the code..." > < / a >
< h2 class = "boxed" > About the code...< / h2 >
< div class = "section" >
< p >
< a href = "demo2.html" > read on> > > < / a >
< / p >
< / 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 >
