fnp / pylucene.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
pylucene 3.5.0-3
[pylucene.git] / lucene-java-3.5.0 / lucene / contrib / facet / src / java / org / apache / lucene / facet / enhancements / package.html
diff --git a/lucene-java-3.5.0/lucene/contrib/facet/src/java/org/apache/lucene/facet/enhancements/package.html b/lucene-java-3.5.0/lucene/contrib/facet/src/java/org/apache/lucene/facet/enhancements/package.html
new file mode 100644 (file)
index 0000000..f851511
--- /dev/null
+++ b/lucene-java-3.5.0/lucene/contrib/facet/src/java/org/apache/lucene/facet/enhancements/package.html
@@ -0,0 +1,32 @@
+<html>
+<head>
+<title>Enhanced category features</title>
+</head>
+<body>
+<h1>Enhanced category features</h1>
+
+Mechanisms for addition of enhanced category features.
+<p>A {@link org.apache.lucene.facet.enhancements.CategoryEnhancement CategoryEnhancement}
+(which can correspond to a 
+{@link org.apache.lucene.facet.index.attributes.CategoryProperty CategoryProperty}) 
+can contribute to the index in two possible ways:
+<ol>
+       <li>To each category with data relevant to the enhancement, 
+       add     this data to the category's token payload, through 
+       {@link org.apache.lucene.facet.enhancements.CategoryEnhancement#getCategoryTokenBytes(CategoryAttribute) CategoryEnhancement.getCategoryTokenBytes()}.
+       This data will be read during search using 
+       {@link org.apache.lucene.facet.enhancements.CategoryEnhancement#extractCategoryTokenData(byte[],        int, int) CategoryEnhancement.extractCategoryTokenData()}.
+       </li>
+       <li>To each document which contains categories with data relevant       to the enhancement, add a 
+       {@link org.apache.lucene.facet.index.streaming.CategoryListTokenizer CategoryListTokenizer} through 
+       {@link org.apache.lucene.facet.enhancements.CategoryEnhancement#getCategoryListTokenizer CategoryEnhancement.getCategoryListTokenizer()} . 
+       The 
+       {@link org.apache.lucene.facet.index.streaming.CategoryListTokenizer CategoryListTokenizer} 
+       should add a single token which includes all the enhancement relevant data from the categories. 
+       The category list       token's text is defined by 
+       {@link org.apache.lucene.facet.enhancements.CategoryEnhancement#getCategoryListTermText() CategoryEnhancement.getCategoryListTermText()}.
+       </li>
+</ol>
+
+</body>
+</html>