Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: warn about sorting by function 

git-svn-id: https://svn.apache.org/repos/asf/lucene/solr/trunk@911877 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Yonik Seeley 2010-02-19 17:55:07 +00:00
parent e4d016cdbe
commit a0464f402f
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/java/org/apache/solr/search/function/ValueSource.java
View File

@ -68,10 +68,13 @@ public abstract class ValueSource implements Serializable {
}
/**
* EXPERIMENTAL: This method is subject to change.
* <br>WARNING: Sorted function queries are not currently weighted.
* <p>
* Get the SortField for this ValueSource. Uses the {@link #getValues(java.util.Map, org.apache.lucene.index.IndexReader)}
* to populate the SortField.
*
* @param reverse true if the order should be reversed.
* @param reverse true if this is a reverse sort.
* @return The {@link org.apache.lucene.search.SortField} for the ValueSource
* @throws IOException if there was a problem reading the values.
*/