Updated postings format jdocs

This commit is contained in:
Martijn van Groningen 2013-02-27 10:46:55 +01:00
parent b53a8aff6a
commit ffbdc0a4c3
2 changed files with 4 additions and 9 deletions

View File

@ -27,21 +27,16 @@ import org.elasticsearch.common.inject.assistedinject.Assisted;
import org.elasticsearch.common.settings.Settings;
/**
* The default postingsformat, maps to {@link Lucene40PostingsFormat}.
* The default postingsformat, maps to {@link Lucene41PostingsFormat}.
* <ul>
* <li><tt>min_block_size</tt>: the minimum block size the default Lucene term
* dictionary uses to encode on-disk blocks.</li>
*
* <li><tt>max_block_size</tt>: the maximum block size the default Lucene term
* dictionary uses to encode on-disk blocks.</li>
*
* <li><tt>freq_cut_off</tt>: the document frequency cut off where pulsing
* in-lines posting lists into the term dictionary. Terms with a document
* frequency less or equal to the cutoff will be in-lined. The default is
* <tt>1</tt></li>
* </ul>
*/
// LUCENE UPGRADE: Upgrade Lucene40PostingsFormat to next version
// LUCENE UPGRADE: Check if type of field postingsFormat needs to be updated!
public class DefaultPostingsFormatProvider extends AbstractPostingsFormatProvider {
private final int minBlockSize;

View File

@ -27,7 +27,7 @@ import org.elasticsearch.common.inject.assistedinject.Assisted;
import org.elasticsearch.common.settings.Settings;
/**
* A {@link PostingsFormatProvider} for Lucenes {@link Pulsing40PostingsFormat}.
* A {@link PostingsFormatProvider} for Lucenes {@link Pulsing41PostingsFormat}.
* The pulsing implementation in-lines the posting lists for very low frequent
* terms in the term dictionary. This is useful to improve lookup performance
* for low-frequent terms. This postings format offers the following parameters:
@ -44,7 +44,7 @@ import org.elasticsearch.common.settings.Settings;
* <tt>1</tt></li>
* </ul>
*/
// LUCENE UPGRADE: Upgrade Pulsing40PostingsFormat to next version
// LUCENE UPGRADE: Check if type of field postingsFormat needs to be updated!
public class PulsingPostingsFormatProvider extends AbstractPostingsFormatProvider {
private final int freqCutOff;