Index: lucene/module-build.xml =================================================================== --- lucene/module-build.xml (revision 1328727) +++ lucene/module-build.xml (working copy) @@ -71,11 +71,14 @@ + + + title="${Name} ${version} ${name} API" + linksource="@{linksource}"> Index: lucene/common-build.xml =================================================================== --- lucene/common-build.xml (revision 1328727) +++ lucene/common-build.xml (working copy) @@ -1274,6 +1274,7 @@ + @@ -1291,6 +1292,7 @@ noindex="true" author="true" version="true" + linksource="@{linksource}" use="true" failonerror="true" source="${ant.java.version}" Index: lucene/demo/build.xml =================================================================== --- lucene/demo/build.xml (revision 1328727) +++ lucene/demo/build.xml (working copy) @@ -37,7 +37,8 @@ - + + Index: lucene/core/src/java/overview.html =================================================================== --- lucene/core/src/java/overview.html (revision 1328727) +++ lucene/core/src/java/overview.html (working copy) @@ -15,22 +15,6 @@ limitations under the License. --> - Apache Lucene API @@ -52,19 +36,19 @@ Directory directory = new RAMDirectory(); // To store an index on disk, use this instead: //Directory directory = FSDirectory.open("/tmp/testindex"); - IndexWriter iwriter = new IndexWriter(directory, analyzer, true, - new IndexWriter.MaxFieldLength(25000)); + IndexWriterConfig config = new IndexWriterConfig(Version.LUCENE_CURRENT, analyzer); + IndexWriter iwriter = new IndexWriter(directory, config); Document doc = new Document(); String text = "This is the text to be indexed."; - doc.add(new Field("fieldname", TextField.TYPE_STORED, text)); + doc.add(new Field("fieldname", text, TextField.TYPE_STORED)); iwriter.addDocument(doc); iwriter.close(); // Now search the index: - DirectoryReader ireader = DirectoryReader.open(directory); // read-only=true + DirectoryReader ireader = DirectoryReader.open(directory); IndexSearcher isearcher = new IndexSearcher(ireader); // Parse a simple query that searches for "text": - QueryParser parser = new QueryParser("fieldname", analyzer); + QueryParser parser = new QueryParser(Version.LUCENE_CURRENT, "fieldname", analyzer); Query query = parser.parse("text"); ScoreDoc[] hits = isearcher.search(query, null, 1000).scoreDocs; assertEquals(1, hits.length); @@ -73,7 +57,6 @@ Document hitDoc = isearcher.doc(hits[i].doc); assertEquals("This is the text to be indexed.", hitDoc.get("fieldname")); } - isearcher.close(); ireader.close(); directory.close(); @@ -85,86 +68,87 @@
  • -org.apache.lucene.analysis -defines an abstract Analyzer -API for converting text from a java.io.Reader -into a TokenStream, -an enumeration of token Attributes.  -A TokenStream can be composed by applying TokenFilters -to the output of a Tokenizer.  -Tokenizers and TokenFilters are strung together and applied with an Analyzer.  -A handful of Analyzer implementations are provided, including StopAnalyzer -and the grammar-based StandardAnalyzer.
    • +{@link org.apache.lucene.analysis} +defines an abstract {@link org.apache.lucene.analysis.Analyzer Analyzer} +API for converting text from a {@link java.io.Reader} +into a {@link org.apache.lucene.analysis.TokenStream TokenStream}, +an enumeration of token {@link org.apache.lucene.util.Attribute Attribute}s.  +A TokenStream can be composed by applying {@link org.apache.lucene.analysis.TokenFilter TokenFilter}s +to the output of a {@link org.apache.lucene.analysis.Tokenizer Tokenizer}.  +Tokenizers and TokenFilters are strung together and applied with an {@link org.apache.lucene.analysis.Analyzer Analyzer}.  +analyzers-common provides a number of Analyzer implementations, including +StopAnalyzer +and the grammar-based StandardAnalyzer.
  • -org.apache.lucene.document -provides a simple Document -class.  A Document is simply a set of named Fields, -whose values may be strings or instances of java.io.Reader.
    • +{@link org.apache.lucene.codecs} +provides an abstraction over the encoding and decoding of the inverted index structure, +as well as different implementations that can be chosen depending upon application needs.
  • -org.apache.lucene.index -provides two primary classes: IndexWriter, -which creates and adds documents to indices; and IndexReader, -which accesses the data in the index.
    • +{@link org.apache.lucene.document} +provides a simple {@link org.apache.lucene.document.Document Document} +class.  A Document is simply a set of named {@link org.apache.lucene.document.Field Field}s, +whose values may be strings or instances of {@link java.io.Reader}.
  • -org.apache.lucene.search -provides data structures to represent queries (ie TermQuery -for individual words, PhraseQuery -for phrases, and BooleanQuery -for boolean combinations of queries) and the abstract Searcher -which turns queries into TopDocs. -IndexSearcher -implements search over a single IndexReader.
    • +{@link org.apache.lucene.index} +provides two primary classes: {@link org.apache.lucene.index.IndexWriter IndexWriter}, +which creates and adds documents to indices; and {@link org.apache.lucene.index.IndexReader}, +which accesses the data in the index.
  • -org.apache.lucene.queryParser -uses JavaCC to implement a -QueryParser.
    • +{@link org.apache.lucene.search} +provides data structures to represent queries (ie {@link org.apache.lucene.search.TermQuery TermQuery} +for individual words, {@link org.apache.lucene.search.PhraseQuery PhraseQuery} +for phrases, and {@link org.apache.lucene.search.BooleanQuery BooleanQuery} +for boolean combinations of queries) and the {@link org.apache.lucene.search.IndexSearcher IndexSearcher} +which turns queries into {@link org.apache.lucene.search.TopDocs TopDocs}. +A number of QueryParsers are provided for producing +query structures from strings or xml.
  • -org.apache.lucene.store -defines an abstract class for storing persistent data, the Directory, -which is a collection of named files written by an IndexOutput -and read by an IndexInput.  -Multiple implementations are provided, including FSDirectory, -which uses a file system directory to store files, and RAMDirectory +{@link org.apache.lucene.store} +defines an abstract class for storing persistent data, the {@link org.apache.lucene.store.Directory Directory}, +which is a collection of named files written by an {@link org.apache.lucene.store.IndexOutput IndexOutput} +and read by an {@link org.apache.lucene.store.IndexInput IndexInput}.  +Multiple implementations are provided, including {@link org.apache.lucene.store.FSDirectory FSDirectory}, +which uses a file system directory to store files, and {@link org.apache.lucene.store.RAMDirectory RAMDirectory} which implements files as memory-resident data structures.
  • -org.apache.lucene.util -contains a few handy data structures and util classes, ie BitVector -and PriorityQueue.
    • +{@link org.apache.lucene.util} +contains a few handy data structures and util classes, ie {@link org.apache.lucene.util.OpenBitSet OpenBitSet} +and {@link org.apache.lucene.util.PriorityQueue PriorityQueue}.
To use Lucene, an application should:
  1. -Create Documents by +Create {@link org.apache.lucene.document.Document Document}s by adding -Fields;
    2. +{@link org.apache.lucene.document.Field Field}s;
  2. -Create an IndexWriter -and add documents to it with addDocument();
    3. +Create an {@link org.apache.lucene.index.IndexWriter IndexWriter} +and add documents to it with {@link org.apache.lucene.index.IndexWriter#addDocument(Iterable) addDocument()};
  3. -Call QueryParser.parse() +Call QueryParser.parse() to build a query from a string; and
  4. -Create an IndexSearcher -and pass the query to its search() +Create an {@link org.apache.lucene.search.IndexSearcher IndexSearcher} +and pass the query to its {@link org.apache.lucene.search.IndexSearcher#search(org.apache.lucene.search.Query, int) search()} method.
Some simple examples of code which does this are: To demonstrate these, try something like: