2006-11-26 19:03:13 -05:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
< html >
< head >
< META http-equiv = "Content-Type" content = "text/html; charset=UTF-8" >
< meta content = "Apache Forrest" name = "Generator" >
< meta name = "Forrest-version" content = "0.7" >
< 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" >
< 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 >
< div class = "header" >
< 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 >
< 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 >
< 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" >
< input attr = "value" name = "Search" value = "Search" type = "submit" >
< / form >
< / div >
< ul id = "tabs" >
< li class = "current" >
< a class = "base-selected" href = "index.html" > Main< / a >
< / li >
< li >
< a class = "base-not-selected" href = "http://wiki.apache.org/jakarta-lucene" > Wiki< / a >
< / li >
< / ul >
< / div >
< / div >
< div id = "main" >
< div id = "publishedStrip" >
< div id = "level2tabs" > < / div >
< script type = "text/javascript" > < ! - -
document.write("< text > Last Published:< / text > " + document.lastModified);
// -->< / script >
< / div >
< div class = "breadtrail" >
< / div >
< div id = "menu" >
< div onclick = "SwitchMenu('menu_1.1', 'skin/')" id = "menu_1.1Title" class = "menutitle" > About< / div >
< div id = "menu_1.1" class = "menuitemgroup" >
< div class = "menuitem" >
< a href = "index.html" title = "Welcome to Java Lucene" > Overview< / a >
< / div >
< div class = "menuitem" >
< a href = "features.html" > Features< / a >
< / div >
< div class = "menuitem" >
< a href = "http://wiki.apache.org/jakarta-lucene/PoweredBy" > Powered by Lucene< / a >
< / div >
< div class = "menuitem" >
< a href = "whoweare.html" > Who We Are< / a >
< / div >
< / div >
< div onclick = "SwitchMenu('menu_1.2', 'skin/')" id = "menu_1.2Title" class = "menutitle" > Documentation< / div >
< div id = "menu_1.2" class = "menuitemgroup" >
< div class = "menuitem" >
< a href = "api/" > API Docs< / a >
< / div >
< div class = "menuitem" >
< a href = "benchmarks.html" > Benchmarks< / a >
< / div >
< div class = "menuitem" >
< a href = "contributions.html" > Contributions< / a >
< / div >
< div class = "menuitem" >
< a href = "http://wiki.apache.org/jakarta-lucene/LuceneFAQ" > FAQ< / a >
< / div >
< div class = "menuitem" >
< a href = "fileformats.html" > File Formats< / a >
< / div >
< div class = "menuitem" >
< a href = "gettingstarted.html" > Getting Started< / a >
< / div >
< div class = "menuitem" >
< a href = "lucene-sandbox/index.html" > Lucene Sandbox< / a >
< / div >
< div class = "menuitem" >
< a href = "queryparsersyntax.html" > Query Syntax< / a >
< / div >
< div class = "menuitem" >
< a href = "scoring.html" > Scoring< / a >
< / div >
< div class = "menuitem" >
< a href = "http://wiki.apache.org/jakarta-lucene" > Wiki< / a >
< / div >
< / div >
< div onclick = "SwitchMenu('menu_1.3', 'skin/')" id = "menu_1.3Title" class = "menutitle" > Resources< / div >
< div id = "menu_1.3" class = "menuitemgroup" >
< div class = "menuitem" >
2006-12-02 07:11:45 -05:00
< a href = "developer-resources.html" > Developers< / a >
< / div >
< div class = "menuitem" >
2006-11-26 19:03:13 -05:00
< a href = "http://issues.apache.org/jira/browse/LUCENE" > Issue Tracking< / a >
< / div >
< div class = "menuitem" >
< a href = "mailinglists.html" > Mailing Lists< / a >
< / div >
< div class = "menuitem" >
2006-12-02 07:11:45 -05:00
< a href = "releases.html" > Releases< / a >
2006-11-26 19:03:13 -05:00
< / div >
< div class = "menuitem" >
2006-12-09 11:32:22 -05:00
< a href = "systemrequirements.html" > System Requirements< / a >
< / div >
< div class = "menuitem" >
2006-11-26 19:03:13 -05:00
< a href = "http://svn.apache.org/viewcvs.cgi/lucene/java/" > Version Control< / a >
< / div >
< / div >
< div onclick = "SwitchMenu('menu_1.4', 'skin/')" id = "menu_1.4Title" class = "menutitle" > Site Versions< / div >
< div id = "menu_1.4" class = "menuitemgroup" >
< div class = "menuitem" >
2006-12-02 07:11:45 -05:00
< a href = "./" > Main< / a >
< / div >
< div class = "menuitem" >
< a href = "http://lucene.apache.org/java/1_4_3/" > 1.4.3< / a >
< / div >
< div class = "menuitem" >
< a href = "http://lucene.apache.org/java/1_9_0/" > 1.9.0< / a >
< / div >
< div class = "menuitem" >
< a href = "http://lucene.apache.org/java/1_9_1/" > 1.9.1< / a >
< / div >
< div class = "menuitem" >
< a href = "http://lucene.apache.org/java/2_0_0/" > 2.0.0< / a >
2006-11-26 19:03:13 -05:00
< / div >
< / div >
< div onclick = "SwitchMenu('menu_1.5', 'skin/')" id = "menu_1.5Title" class = "menutitle" > Related Projects< / div >
< div id = "menu_1.5" class = "menuitemgroup" >
< div class = "menuitem" >
< a href = "http://lucene.apache.org" > Lucene (Top-Level)< / a >
< / div >
< div class = "menuitem" >
< a href = "http://lucene.apache.org/hadoop/" > Hadoop< / a >
< / div >
< div class = "menuitem" >
< a href = "http://lucene.apache.org/lucy/" > Lucy< / a >
< / div >
< div class = "menuitem" >
< a href = "http://incubator.apache.org/projects/lucene.net.html" > Lucene.NET< / a >
< / div >
< div class = "menuitem" >
< a href = "http://lucene.apache.org/nutch/" > Nutch< / a >
< / div >
< div class = "menuitem" >
< a href = "http://incubator.apache.org/solr/" > SOLR< / a >
< / 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 >
< div id = "credit2" > < / div >
< / div >
< 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
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 < 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
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.
< / 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 >
< div class = "clearboth" > < / div >
< / div >
< div id = "footer" >
< div class = "lastmodified" >
< script type = "text/javascript" > < ! - -
document.write("< text > Last Published:< / text > " + document.lastModified);
// -->< / script >
< / div >
< div class = "copyright" >
Copyright ©
2006 < a href = "http://www.apache.org/licenses/" > The Apache Software Foundation.< / a >
< / div >
< / div >
< / body >
< / html >
