pylucene 3.5.0-3

[pylucene.git] / lucene-java-3.5.0 / lucene / contrib / facet / src / java / org / apache / lucene / facet / index / categorypolicy / package.html
diff --git a/lucene-java-3.5.0/lucene/contrib/facet/src/java/org/apache/lucene/facet/index/categorypolicy/package.html b/lucene-java-3.5.0/lucene/contrib/facet/src/java/org/apache/lucene/facet/index/categorypolicy/package.html

new file mode 100644 (file)

index 0000000..b95117e
--- /dev/null
+++ b/lucene-java-3.5.0/lucene/contrib/facet/src/java/org/apache/lucene/facet/index/categorypolicy/package.html
@@ -0,0 +1,21 @@
+<html>
+<head>
+<title>Policies for indexing categories</title>
+</head>
+<body>
+<h1>Policies for indexing categories</h1>
+
+There are two kinds of policies: 
+<ul>
+  <li>Path policies are based on the path of the category.</li>
+  <li>Ordinal policies are based on the ordinal of the category.</li>
+</ul>
+
+Policies are "consulted" with during indexing, for deciding whether a category should
+be added to the index or not. The two kinds of policies can be used for different purposes.
+For example, path policies dictates which categories can participate in a drill-down operation, 
+while ordinal policies affect which can be accumulated (e.g. counted).    
+
+
+</body>
+</html>
+\ No newline at end of file