lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From o...@apache.org
Subject cvs commit: jakarta-lucene/src/java/org/apache/lucene/store FSDirectory.java
Date Thu, 14 Feb 2002 01:46:31 GMT
otis        02/02/13 17:46:31

  Modified:    docs     index.html resources.html whoweare.html
               src/java overview.html
               src/java/org/apache/lucene manifest
               src/java/org/apache/lucene/queryParser QueryParser.jj
                        package.html
               src/java/org/apache/lucene/store FSDirectory.java
  Log:
  - Replaced references to the old package name com.lucene with org.apache.lucene
  - Fixed a few Javadocs problems.
  
  Revision  Changes    Path
  1.6       +8 -0      jakarta-lucene/docs/index.html
  
  Index: index.html
  ===================================================================
  RCS file: /home/cvs/jakarta-lucene/docs/index.html,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- index.html	26 Jan 2002 16:31:37 -0000	1.5
  +++ index.html	14 Feb 2002 01:46:30 -0000	1.6
  @@ -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>
   
  @@ -174,6 +176,12 @@
           </body>
       </html>
   <!-- end the processing -->
  +
  +
  +
  +
  +
  +
   
   
   
  
  
  
  1.6       +8 -0      jakarta-lucene/docs/resources.html
  
  Index: resources.html
  ===================================================================
  RCS file: /home/cvs/jakarta-lucene/docs/resources.html,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- resources.html	26 Jan 2002 16:31:49 -0000	1.5
  +++ resources.html	14 Feb 2002 01:46:30 -0000	1.6
  @@ -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>
   
  @@ -125,6 +127,12 @@
           </body>
       </html>
   <!-- end the processing -->
  +
  +
  +
  +
  +
  +
   
   
   
  
  
  
  1.6       +8 -0      jakarta-lucene/docs/whoweare.html
  
  Index: whoweare.html
  ===================================================================
  RCS file: /home/cvs/jakarta-lucene/docs/whoweare.html,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- whoweare.html	26 Jan 2002 16:31:56 -0000	1.5
  +++ whoweare.html	14 Feb 2002 01:46:30 -0000	1.6
  @@ -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>
   
  @@ -177,6 +179,12 @@
           </body>
       </html>
   <!-- end the processing -->
  +
  +
  +
  +
  +
  +
   
   
   
  
  
  
  1.6       +9 -9      jakarta-lucene/src/java/overview.html
  
  Index: overview.html
  ===================================================================
  RCS file: /home/cvs/jakarta-lucene/src/java/overview.html,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- overview.html	27 Jan 2002 23:20:30 -0000	1.5
  +++ overview.html	14 Feb 2002 01:46:30 -0000	1.6
  @@ -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 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 @@
   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 @@
   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 @@
   
   <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 @@
   
   <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:
  
  
  
  1.2       +3 -3      jakarta-lucene/src/java/org/apache/lucene/manifest
  
  Index: manifest
  ===================================================================
  RCS file: /home/cvs/jakarta-lucene/src/java/org/apache/lucene/manifest,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- manifest	18 Sep 2001 16:29:49 -0000	1.1
  +++ manifest	14 Feb 2002 01:46:30 -0000	1.2
  @@ -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-Version: $Name:  $ $Date: 2001/09/18 16:29:49 $
  +Implementation-Title: org.apache.lucene
  +Implementation-Version: $Name:  $ $Date: 2002/02/14 01:46:30 $
   Implementation-Vendor: Lucene
  
  
  
  1.12      +6 -2      jakarta-lucene/src/java/org/apache/lucene/queryParser/QueryParser.jj
  
  Index: QueryParser.jj
  ===================================================================
  RCS file: /home/cvs/jakarta-lucene/src/java/org/apache/lucene/queryParser/QueryParser.jj,v
  retrieving revision 1.11
  retrieving revision 1.12
  diff -u -r1.11 -r1.12
  --- QueryParser.jj	14 Feb 2002 00:58:46 -0000	1.11
  +++ QueryParser.jj	14 Feb 2002 01:46:31 -0000	1.12
  @@ -97,12 +97,16 @@
    *   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.
  
  
  
  1.2       +1 -1      jakarta-lucene/src/java/org/apache/lucene/queryParser/package.html
  
  Index: package.html
  ===================================================================
  RCS file: /home/cvs/jakarta-lucene/src/java/org/apache/lucene/queryParser/package.html,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- package.html	18 Sep 2001 16:29:55 -0000	1.1
  +++ package.html	14 Feb 2002 01:46:31 -0000	1.2
  @@ -9,7 +9,7 @@
   <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>
  
  
  
  1.5       +2 -2      jakarta-lucene/src/java/org/apache/lucene/store/FSDirectory.java
  
  Index: FSDirectory.java
  ===================================================================
  RCS file: /home/cvs/jakarta-lucene/src/java/org/apache/lucene/store/FSDirectory.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- FSDirectory.java	11 Oct 2001 17:21:10 -0000	1.4
  +++ FSDirectory.java	14 Feb 2002 01:46:31 -0000	1.5
  @@ -85,7 +85,7 @@
      * 
      * @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 @@
      * 
      * @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());
  
  
  

--
To unsubscribe, e-mail:   <mailto:lucene-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:lucene-dev-help@jakarta.apache.org>


Mime
View raw message