From b8bb58c1ca6c6f6747050cd7d06a72fa57baf5c6 Mon Sep 17 00:00:00 2001
From: Mark Robert Miller <markrmiller@apache.org>
Date: Fri, 24 Apr 2009 17:00:39 +0000
Subject: [PATCH] put in warning about fvhq not doing auto resolution on the
 SortFields passed to it

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@768371 13f79535-47bb-0310-9956-ffa450edef68
---
 src/java/org/apache/lucene/search/FieldValueHitQueue.java | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/java/org/apache/lucene/search/FieldValueHitQueue.java b/src/java/org/apache/lucene/search/FieldValueHitQueue.java
index 90652b29b86..54e2f68d146 100644
--- a/src/java/org/apache/lucene/search/FieldValueHitQueue.java
+++ b/src/java/org/apache/lucene/search/FieldValueHitQueue.java
@@ -28,6 +28,11 @@ import org.apache.lucene.util.PriorityQueue;
  * Expert: A hit queue for sorting by hits by terms in more than one field.
  * Uses <code>FieldCache.DEFAULT</code> for maintaining
  * internal term lookup tables.
+ * 
+ * This class will not resolve SortField.AUTO types, and expects the type
+ * of all SortFields used for construction to already have been resolved. 
+ * {@link #detectFieldType(IndexReader, String)} is a utility method which
+ * may be used for field type detection.
  *
  * <b>NOTE:</b> This API is experimental and might change in
  * incompatible ways in the next release.