Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

- Replaced references to the old package name com.lucene with org.apache.lucene 

- Fixed a few Javadocs problems.
PR:
Obtained from:
Submitted by:
Reviewed by:


git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@149681 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Otis Gospodnetic 2002-02-14 01:46:31 +00:00
parent 3e7f46010e
commit 80f9f1db38
8 changed files with 44 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/index.html
View File

@ -18,6 +18,8 @@
<meta name="author" value="Doug Cutting">
<meta name="email" value="cutting@apache.org">
<title>Jakarta Lucene - Overview - Jakarta Lucene</title>
</head>
@ -188,3 +190,9 @@ developed in an open and cooperative fashion.

8
docs/resources.html
View File

@ -16,6 +16,8 @@
<meta name="author" value="Doug Cutting">
<meta name="email" value="cutting@apache.org">
<title>Jakarta Lucene - Resources - Jakarta Lucene</title>
</head>
@ -139,3 +141,9 @@

8
docs/whoweare.html
View File

@ -16,6 +16,8 @@
<meta name="author" value="Doug Cutting">
<meta name="email" value="cutting@apache.org">
<title>Jakarta Lucene - Who We Are - Jakarta Lucene</title>
</head>
@ -191,3 +193,9 @@ the <a href="http://jakarta.apache.org/site/mail.html">Jakarta-Lucene mailing li

4
src/java/org/apache/lucene/manifest
View File

@ -1,8 +1,8 @@
Name: com/lucene
Name: org/apache/lucene
Specification-Title: Lucene Search Engine
Specification-Version: $Name$
Specification-Vendor: Lucene
Implementation-Title: com.lucene
Implementation-Title: org.apache.lucene
Implementation-Version: $Name$ $Date$
Implementation-Vendor: Lucene

8
src/java/org/apache/lucene/queryParser/QueryParser.jj
View File

@ -97,12 +97,16 @@ import org.apache.lucene.search.*;
* Clause ::= ["+", "-"] [&lt;TERM&gt; ":"] ( &lt;TERM&gt; | "(" Query ")" )
* </pre>
*
* <p>
* Examples of appropriately formatted queries can be found in the <a
* href="http://cvs.apache.org/viewcvs/jakarta-lucene/src/test/org/apache/lucene/queryParser/TestQueryParser.java?rev=1&content-type=text/vnd.viewcvs-markup">test cases</a>.
* </p>
*
* @author Brian Goetz
*/
public class QueryParser {
/** Parses a query string, returning a
* <a href="lucene.search.Query.html">Query</a>.
/** Parses a query string, returning a {@link org.apache.lucene.search.Query}.
* @param query the query string to be parsed.
* @param field the default field for query terms.
* @param analyzer used to find terms in the query text.

2
src/java/org/apache/lucene/queryParser/package.html
View File

@ -9,7 +9,7 @@ A simple query parser implemented with JavaCC.
<p>Note that JavaCC defines lots of public, classes, methods and fields
that do not need to be public.&nbsp; These clutter the documentation.&nbsp;
Sorry.
<p>Note that because JavaCC defines a class named <tt>Token</tt>, <tt>com.lucene.analysis.Token</tt>
<p>Note that because JavaCC defines a class named <tt>Token</tt>, <tt>org.apache.lucene.analysis.Token</tt>
must always be fully qualified in sourced code in this package.
</body>
</html>

4
src/java/org/apache/lucene/store/FSDirectory.java
View File

@ -85,7 +85,7 @@ final public class FSDirectory extends Directory {
*
* @param path the path to the directory.
* @param create if true, create, or erase any existing contents.
* @returns the FSDirectory for the named file. */
* @return the FSDirectory for the named file. */
public static FSDirectory getDirectory(String path, boolean create)
throws IOException {
return getDirectory(new File(path), create);
@ -99,7 +99,7 @@ final public class FSDirectory extends Directory {
*
* @param file the path to the directory.
* @param create if true, create, or erase any existing contents.
* @returns the FSDirectory for the named file. */
* @return the FSDirectory for the named file. */
public static FSDirectory getDirectory(File file, boolean create)
throws IOException {
file = new File(file.getCanonicalPath());

18
src/java/overview.html
View File

@ -8,12 +8,12 @@
The Jakarta Lucene API is divided into several packages:
<ul>
<li>
<b><a href="org/apache/lucene/util/package-summary.html">com.lucene.util</a></b>
<b><a href="org/apache/lucene/util/package-summary.html">org.apache.lucene.util</a></b>
contains a few handy data structures, e.g., <a href="org/apache/lucene/util/BitVector.html">BitVector</a>
and <a href="org/apache/lucene/util/PriorityQueue.html">PriorityQueue</a>.</li>
<li>
<b><a href="org/apache/lucene/store/package-summary.html">com.lucene.store</a></b>
<b><a href="org/apache/lucene/store/package-summary.html">org.apache.lucene.store</a></b>
defines an abstract class for storing persistent data, the <a href="org/apache/lucene/store/Directory.html">Directory</a>,
a collection of named files written by an <a href="org/apache/lucene/store/OutputStream.html">OutputStream</a>
and read by an <a href="org/apache/lucene/store/InputStream.html">InputStream</a>.&nbsp;
@ -22,13 +22,13 @@ which uses a file system directory to store files, and <a href="org/apache/lucen
which implements files as memory-resident data structures.</li>
<li>
<b><a href="org/apache/lucene/document/package-summary.html">com.lucene.document</a></b>
<b><a href="org/apache/lucene/document/package-summary.html">org.apache.lucene.document</a></b>
provides a simple <a href="org/apache/lucene/document/Document.html">Document</a>
class.&nbsp; A document is simply a set of named <a href="org/apache/lucene/document/Field.html">Field</a>'s,
whose values may be strings or instances of <a href="http://java.sun.com/products/jdk/1.2/docs/api/java/io/Reader.html">java.io.Reader</a>.</li>
<li>
<b><a href="org/apache/lucene/analysis/package-summary.html">com.lucene.analysis</a></b>
<b><a href="org/apache/lucene/analysis/package-summary.html">org.apache.lucene.analysis</a></b>
defines an abstract <a href="org/apache/lucene/analysis/Analyzer.html">Analyzer</a>
API for converting text from a <a href="http://java.sun.com/products/jdk/1.2/docs/api/java/io/Reader.html">java.io.Reader</a>
into a <a href="org/apache/lucene/analysis/TokenStream.html">TokenStream</a>,
@ -39,13 +39,13 @@ A few simple implemenations are provided, including <a href="org/apache/lucene/a
and the grammar-based <a href="org/apache/lucene/analysis/standard/StandardAnalyzer.html">StandardAnalyzer</a>.</li>
<li>
<b><a href="org/apache/lucene/index/package-summary.html">com.lucene.index</a></b>
<b><a href="org/apache/lucene/index/package-summary.html">org.apache.lucene.index</a></b>
provides two primary classes: <a href="org/apache/lucene/index/IndexWriter.html">IndexWriter</a>,
which creates and adds documents to indices; and <a href="org/apache/lucene/index/IndexReader.html">IndexReader</a>,
which accesses the data in the index.</li>
<li>
<b><a href="org/apache/lucene/search/package-summary.html">com.lucene.search</a></b>
<b><a href="org/apache/lucene/search/package-summary.html">org.apache.lucene.search</a></b>
provides data structures to represent queries (<a href="org/apache/lucene/search/TermQuery.html">TermQuery</a>
for individual words, <a href="org/apache/lucene/search/PhraseQuery.html">PhraseQuery</a>
for phrases, and <a href="org/apache/lucene/search/BooleanQuery.html">BooleanQuery</a>
@ -55,7 +55,7 @@ which turns queries into <a href="org/apache/lucene/search/Hits.html">Hits</a>.
implements search over a single IndexReader.</li>
<li>
<b><a href="org/apache/lucene/queryParser/package-summary.html">com.lucene.queryParser</a></b>
<b><a href="org/apache/lucene/queryParser/package-summary.html">org.apache.lucene.queryParser</a></b>
uses <a href="http://www.suntest.com/JavaCC/">JavaCC</a> to implement a
<a href="org/apache/lucene/queryParser/QueryParser.html">QueryParser</a>.</li>
</ul>
@ -68,7 +68,7 @@ adding
<li>
Create an <a href="org/apache/lucene/index/IndexWriter.html">IndexWriter</a>
and add documents to to it with <a href="org/apache/lucene/index/IndexWriter.html#addDocument(com.lucene.document.Document)">addDocument()</a>;</li>
and add documents to to it with <a href="org/apache/lucene/index/IndexWriter.html#addDocument(org.apache.lucene.document.Document)">addDocument()</a>;</li>
<li>
Call <a href="org/apache/lucene/queryParser/QueryParser.html#parse(java.lang.String)">QueryParser.parse()</a>
@ -76,7 +76,7 @@ to build a query from a string; and</li>
<li>
Create an <a href="org/apache/lucene/search/IndexSearcher.html">IndexSearcher</a>
and pass the query to it's <a href="org/apache/lucene/search/Searcher.html#search(com.lucene.search.Query)">search()</a>
and pass the query to it's <a href="org/apache/lucene/search/Searcher.html#search(org.apache.lucene.search.Query)">search()</a>
method.</li>
</ol>
Some simple examples of code which does this are: