You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by sh...@apache.org on 2013/07/19 23:58:27 UTC

svn commit: r1505041 - in /lucene/dev/trunk/lucene: ./ facet/ facet/src/java/ facet/src/java/org/apache/lucene/facet/ facet/src/java/org/apache/lucene/facet/codecs/facet42/ facet/src/java/org/apache/lucene/facet/doc-files/ facet/src/java/org/apache/luc...

Author: shaie
Date: Fri Jul 19 21:58:26 2013
New Revision: 1505041

URL: http://svn.apache.org/r1505041
Log:
LUCENE-4894: remove facet userguide

Removed:
    lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/doc-files/
Modified:
    lucene/dev/trunk/lucene/CHANGES.txt
    lucene/dev/trunk/lucene/facet/build.xml
    lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/FacetPackage.java
    lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/codecs/facet42/package.html
    lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/index/package.html
    lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/range/RangeFacetRequest.java
    lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/taxonomy/package.html
    lucene/dev/trunk/lucene/facet/src/java/overview.html

Modified: lucene/dev/trunk/lucene/CHANGES.txt
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/CHANGES.txt?rev=1505041&r1=1505040&r2=1505041&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/CHANGES.txt (original)
+++ lucene/dev/trunk/lucene/CHANGES.txt Fri Jul 19 21:58:26 2013
@@ -69,6 +69,9 @@ Bug Fixes
 * LUCENE-5116: IndexWriter.addIndexes(IndexReader...) should drop empty (or all
   deleted) segments. (Robert Muir, Shai Erera)
 
+* LUCENE-4734: Add FastVectorHighlighter support for proximity queries and
+  phrase queries with gaps or overlapping terms. (Ryan Lauck, Adrien Grand)
+
 API Changes
 
 * LUCENE-5094: Add ramBytesUsed() to MultiDocValues.OrdinalMap.
@@ -85,10 +88,10 @@ Optimizations
 * LUCENE-5119: DiskDV keeps the document-to-ordinal mapping on disk for 
   SortedDocValues.  (Robert Muir)
 
-Bug fixes
+Documentation
 
-* LUCENE-4734: Add FastVectorHighlighter support for proximity queries and
-  phrase queries with gaps or overlapping terms. (Ryan Lauck, Adrien Grand)
+* LUCENE-4894: remove facet userguide as it was outdated. Partially absorbed into
+  package's documentation and classes javadocs. (Shai Erera)
 
 ======================= Lucene 4.4.0 =======================
 

Modified: lucene/dev/trunk/lucene/facet/build.xml
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/facet/build.xml?rev=1505041&r1=1505040&r2=1505041&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/facet/build.xml (original)
+++ lucene/dev/trunk/lucene/facet/build.xml Fri Jul 19 21:58:26 2013
@@ -23,9 +23,6 @@
     Faceted indexing and search capabilities
   </description>
 
-  <!-- prettify.css/js -->
-  <property name="rat.excludes" value="**/prettify.css,**/prettify.js"/>
-  
   <import file="../module-build.xml"/>
 
   <target name="run-encoding-benchmark" depends="compile-test">

Modified: lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/FacetPackage.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/FacetPackage.java?rev=1505041&r1=1505040&r2=1505041&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/FacetPackage.java (original)
+++ lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/FacetPackage.java Fri Jul 19 21:58:26 2013
@@ -17,11 +17,7 @@ package org.apache.lucene.facet;
  * limitations under the License.
  */
 
-/**
- * Required so that userguide files are copied as part of javadocs generation.
- * Otherwise, if the root facet package contains no classes, doc-files aren't
- * copied.
- */
+/** Required for javadocs generation. */
 public final class FacetPackage {
   
   private FacetPackage() {}

Modified: lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/codecs/facet42/package.html
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/codecs/facet42/package.html?rev=1505041&r1=1505040&r2=1505041&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/codecs/facet42/package.html (original)
+++ lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/codecs/facet42/package.html Fri Jul 19 21:58:26 2013
@@ -16,9 +16,6 @@
  limitations under the License.
 -->
 <html>
-<head>
-   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-</head>
 <body>
 Codec + DocValuesFormat that are optimized for facets.
 </body>

Modified: lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/index/package.html
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/index/package.html?rev=1505041&r1=1505040&r2=1505041&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/index/package.html (original)
+++ lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/index/package.html Fri Jul 19 21:58:26 2013
@@ -20,6 +20,5 @@
 </head>
 <body>
 Facets indexing code.
-
 </body>
 </html>
\ No newline at end of file

Modified: lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/range/RangeFacetRequest.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/range/RangeFacetRequest.java?rev=1505041&r1=1505040&r2=1505041&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/range/RangeFacetRequest.java (original)
+++ lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/range/RangeFacetRequest.java Fri Jul 19 21:58:26 2013
@@ -36,6 +36,7 @@ public class RangeFacetRequest<T extends
 
   public final Range[] ranges;
 
+  @SuppressWarnings("unchecked")
   public RangeFacetRequest(String field, T...ranges) {
     super(new CategoryPath(field), 1);
     this.ranges = ranges;

Modified: lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/taxonomy/package.html
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/taxonomy/package.html?rev=1505041&r1=1505040&r2=1505041&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/taxonomy/package.html (original)
+++ lucene/dev/trunk/lucene/facet/src/java/org/apache/lucene/facet/taxonomy/package.html Fri Jul 19 21:58:26 2013
@@ -21,28 +21,33 @@
 <body>
 	<h1>Taxonomy of Categories</h1>
 	
-	Facets are defined using a hierarchy of categories, known as a
-	<i>Taxonomy</i>.
-	
-	<br>
-	For example, in a book store application, a Taxonomy could have the
-	following hierarchy:
-	<p>
+	Facets are defined using a hierarchy of categories, known as a <i>Taxonomy</i>.
+	For example, the taxonomy of a book store application might have the following structure:
 	<ul>
-		<li>Author</li>
-		<ul>
-		<li>Mark Twain</li>
-		<li>J. K. Rowling</li>
-		</ul>
+		<li>Author
+			<ul>
+			<li>Mark Twain</li>
+			<li>J. K. Rowling</li>
+			</ul>
+		</li>
 	</ul>
 	<ul>
-		<li>Date</li>
-		<ul>
-		<li>2010</li>
-		<li>2009</li>
-		</ul>
+		<li>Date
+			<ul>
+			<li>2010
+				<ul>
+				<li>March</li>
+				<li>April</li>
+				</ul>
+			</li>
+			<li>2009</li>
+			</ul>
+		</li>
 	</ul>
 	
-	The <i>Taxonomy</i> translates category-paths into category-ordinal and vice versa.
+	The <i>Taxonomy</i> translates category-paths into interger identifiers (often termed <i>ordinals</i>) and vice versa.
+	The category <code>Author/Mark Twain</code> adds two nodes to the taxonomy: <code>Author</code> and 
+	<code>Author/Mark Twain</code>, each is assigned a different ordinal. The taxonomy maintains the invariant that a 
+	node always has an ordinal that is &lt; all its children.
 </body>
 </html>
\ No newline at end of file

Modified: lucene/dev/trunk/lucene/facet/src/java/overview.html
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/facet/src/java/overview.html?rev=1505041&r1=1505040&r2=1505041&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/facet/src/java/overview.html (original)
+++ lucene/dev/trunk/lucene/facet/src/java/overview.html Fri Jul 19 21:58:26 2013
@@ -15,12 +15,10 @@
  limitations under the License.
 -->
 <html>
-  <head>
-    <title>
-      facet
-    </title>
-  </head>
-  <body>
-  Provides faceted indexing and search capabilities (checkout the <a href="org/apache/lucene/facet/doc-files/userguide.html">userguide</a>).
-  </body>
+<head><title>facet</title></head>
+<body>
+Provides faceted indexing and search capabilities. Checkout <a href="http://shaierera.blogspot.com/2012/11/lucene-facets-part-1.html">this</a>
+and <a href="http://shaierera.blogspot.com/2012/11/lucene-facets-part-2.html">this</a> blog posts for some overview on the facets module
+as well as source code examples <a href="../demo">here</a>.
+</body>
 </html>