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

SOLR-789: The javadoc of RandomSortField is not readable 

git-svn-id: https://svn.apache.org/repos/asf/lucene/solr/trunk@699549 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Koji Sekiguchi 2008-09-27 03:45:40 +00:00
parent ac881d9cc6
commit 774153b891
2 changed files with 17 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES.txt
View File

@ -57,7 +57,7 @@ Build
Documentation
----------------------
1. SOLR-789: The javadoc of RandomSortField is not readable (Nicolas Lalevée via koji)

37
src/java/org/apache/solr/schema/RandomSortField.java
View File

@ -32,27 +32,30 @@ import org.apache.solr.search.function.ValueSource;
/**
* Utility Field used for random sorting. It should not be passed a value.
*
* <p>
* This random sorting implementation uses the dynamic field name to set the
* random 'seed'. To get random sorting order, you need to use a random
* dynamic field name. For example, you will need to configure schema.xml:
* <pre>
* &lt;types&gt;
* ...
* &lt;fieldType name="random" class="solr.RandomSortField" /&gt;
* ...
* &lt;/types&gt;
* &lt;fields&gt;
* ...
* &lt;dynamicField name="random*" type="rand" indexed="true" stored="false"/&gt;
* ...
* &lt;/fields&gt;
* </pre>
*
* <types>
* ...
* <fieldType name="random" class="solr.RandomSortField" />
* ...
* </types>
* <fields>
* ...
* <dynamicField name="random*" type="rand" indexed="true" stored="false"/>
* ...
* </fields>
*
* http://localhost:8983/solr/select/?q=*:*&fl=name&sort=rand_1234%20desc
* http://localhost:8983/solr/select/?q=*:*&fl=name&sort=rand_2345%20desc
* http://localhost:8983/solr/select/?q=*:*&fl=name&sort=rand_ABDC%20desc
* http://localhost:8983/solr/select/?q=*:*&fl=name&sort=rand_21%20desc
*
* Examples of queries:
* <ul>
* <li>http://localhost:8983/solr/select/?q=*:*&fl=name&sort=rand_1234%20desc</li>
* <li>http://localhost:8983/solr/select/?q=*:*&fl=name&sort=rand_2345%20desc</li>
* <li>http://localhost:8983/solr/select/?q=*:*&fl=name&sort=rand_ABDC%20desc</li>
* <li>http://localhost:8983/solr/select/?q=*:*&fl=name&sort=rand_21%20desc</li>
* </ul>
* Note that multiple calls to the same URL will return the same sorting order.
*
* @version $Id$