Package org.apache.solr.response.transform

Class ValueSourceAugmenter

java.lang.Object

org.apache.solr.response.transform.DocTransformer

org.apache.solr.response.transform.ValueSourceAugmenter

public class ValueSourceAugmenter
extends DocTransformer

Add values from a ValueSource (function query etc)

NOT really sure how or if this could work...

Since:

solr 4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ValueSourceAugmenter.ScoreAndDoc	Fake scorer for a single document

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

DocTransformer.NoopFieldTransformer

Field Summary

Fields

Modifier and Type	Field	Description
final String	name
final QParser	qparser
final org.apache.lucene.queries.function.ValueSource	valueSource

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

context

Constructor Summary

Constructors

Constructor	Description
ValueSourceAugmenter(String name, QParser qparser, org.apache.lucene.queries.function.ValueSource valueSource)

Method Summary

Modifier and Type	Method	Description
String	getName()
boolean	needsSolrIndexSearcher()	Always returns true
void	setContext(ResultContext context)	This is called before DocTransformer.transform(org.apache.solr.common.SolrDocument, int, org.apache.solr.search.DocIterationInfo) to provide context for any subsequent transformations.
protected void	setValue(org.apache.solr.common.SolrDocument doc, Object val)
void	transform(org.apache.solr.common.SolrDocument doc, int docid, DocIterationInfo docIterationInfo)	This is where implementations do the actual work.

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

getExtraRequestFields, getRawFields, toString

Methods inherited from class java.lang.Object

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

Field Details

name

public final String name

qparser

public final QParser qparser

valueSource

public final org.apache.lucene.queries.function.ValueSource valueSource

Constructor Details

ValueSourceAugmenter

public ValueSourceAugmenter(String name,
 QParser qparser,
 org.apache.lucene.queries.function.ValueSource valueSource)

Method Details

getName

public String getName()

Specified by:

getName in class DocTransformer

Returns:

The name of the transformer

setContext

public void setContext(ResultContext context)

Description copied from class: DocTransformer

This is called before DocTransformer.transform(org.apache.solr.common.SolrDocument, int, org.apache.solr.search.DocIterationInfo) to provide context for any subsequent transformations.

Overrides:

setContext in class DocTransformer

Parameters:

context - The ResultContext stores information about how the documents were produced.

See Also:

• DocTransformer.needsSolrIndexSearcher()

transform

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

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

docIterationInfo - the document information for this document, including the score. Do not pass null, instead use DocIterationInfo.NONE.

See Also:

• DocTransformer.needsSolrIndexSearcher()

needsSolrIndexSearcher

public boolean needsSolrIndexSearcher()

Always returns true

Overrides:

needsSolrIndexSearcher in class DocTransformer

See Also:

• ResultContext.getSearcher()
• DocTransformer.transform(org.apache.solr.common.SolrDocument, int, org.apache.solr.search.DocIterationInfo)

setValue

protected void setValue(org.apache.solr.common.SolrDocument doc,
 Object val)