Package org.apache.solr.response.transform

Class ScoreAugmenter

java.lang.Object

org.apache.solr.response.transform.DocTransformer

org.apache.solr.response.transform.ScoreAugmenter

public class ScoreAugmenter
extends DocTransformer

Simple Augmenter that adds the score

Since:

solr 4.0

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.solr.response.transform.DocTransformer

DocTransformer.NoopFieldTransformer

Field Summary

Fields inherited from class org.apache.solr.response.transform.DocTransformer

context

Constructor Summary

Constructors

Constructor	Description
ScoreAugmenter(String display)

Method Summary

Modifier and Type	Method	Description
String	getName()
void	transform(org.apache.solr.common.SolrDocument doc, int docid)	This is where implementations do the actual work.
void	transform(org.apache.solr.common.SolrDocument doc, int docid, float score)	This is where implementations do the actual work.

Methods inherited from class org.apache.solr.response.transform.DocTransformer

getExtraRequestFields, getRawFields, needsSolrIndexSearcher, setContext, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ScoreAugmenter

public ScoreAugmenter(String display)

Method Detail

getName

public String getName()

Specified by:

getName in class DocTransformer

Returns:

The name of the transformer

transform

public void transform(org.apache.solr.common.SolrDocument doc,
                      int docid,
                      float score)

Description copied from class: DocTransformer

This is where implementations do the actual work. If implementations require a valid docId and index access, the DocTransformer.needsSolrIndexSearcher() method must return true

Default implementation calls DocTransformer.transform(SolrDocument, int).

Overrides:

transform in class DocTransformer

Parameters:

doc - The document to alter

docid - The Lucene internal doc id, or -1 in cases where the doc did not come from the index

score - the score for this document

See Also:

DocTransformer.needsSolrIndexSearcher()

transform

public void transform(org.apache.solr.common.SolrDocument doc,
                      int docid)

Description copied from class: DocTransformer

This is where implementations do the actual work. If implementations require a valid docId and index access, the DocTransformer.needsSolrIndexSearcher() method must return true

Specified by:

transform in class DocTransformer

Parameters:

doc - The document to alter

docid - The Lucene internal doc id, or -1 in cases where the doc did not come from the index

See Also:

DocTransformer.needsSolrIndexSearcher()