org.apache.solr.handler

Class AnalysisRequestHandlerBase

java.lang.Object

org.apache.solr.handler.RequestHandlerBase

org.apache.solr.handler.AnalysisRequestHandlerBase

All Implemented Interfaces:

SolrInfoMBean, SolrRequestHandler

Direct Known Subclasses:

DocumentAnalysisRequestHandler, FieldAnalysisRequestHandler

public abstract class AnalysisRequestHandlerBase
extends RequestHandlerBase

A base class for all analysis request handlers.

Since:

solr 1.4

Version:

$Id: AnalysisRequestHandlerBase.java 1143785 2011-07-07 11:59:59Z uschindler $

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AnalysisRequestHandlerBase.AnalysisContext Serves as the context of an analysis process.
protected static class	AnalysisRequestHandlerBase.ListBasedTokenStream TokenStream that iterates over a list of pre-existing Tokens
static interface	AnalysisRequestHandlerBase.TokenTrackingAttribute This is an Attribute used to track the positions of tokens in the analysis chain.
static class	AnalysisRequestHandlerBase.TokenTrackingAttributeImpl Implementation of AnalysisRequestHandlerBase.TokenTrackingAttribute.

Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoMBean

SolrInfoMBean.Category

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static java.util.Map<java.lang.String,java.lang.String>	ATTRIBUTE_MAPPING

Fields inherited from class org.apache.solr.handler.RequestHandlerBase

appends, defaults, handlerStart, httpCaching, initArgs, invariants, numErrors, numRequests, numTimeouts, totalTime

Constructor Summary

Constructors

Constructor and Description
AnalysisRequestHandlerBase()

Method Summary

Modifier and Type	Method and Description
private java.util.List<org.apache.lucene.util.AttributeSource>	analyzeTokenStream(org.apache.lucene.analysis.TokenStream tokenStream) Analyzes the given TokenStream, collecting the Tokens it produces.
protected NamedList<java.util.List<NamedList>>	analyzeValue(java.lang.String value, AnalysisRequestHandlerBase.AnalysisContext context) Analyzes the given value using the given Analyzer.
protected java.util.List<org.apache.lucene.util.AttributeSource>	analyzeValue(java.lang.String value, org.apache.lucene.analysis.Analyzer analyzer) Deprecated. This method is no longer used by Solr
private java.util.List<NamedList>	convertTokensToNamedLists(java.util.List<org.apache.lucene.util.AttributeSource> tokenList, AnalysisRequestHandlerBase.AnalysisContext context) Converts the list of Tokens to a list of NamedLists representing the tokens.
protected abstract NamedList	doAnalysis(SolrQueryRequest req) Performs the analysis based on the given solr request and returns the analysis result as a named list.
protected java.util.Set<java.lang.String>	getQueryTokenSet(java.lang.String query, org.apache.lucene.analysis.Analyzer analyzer) Analyzes the given text using the given analyzer and returns the produced tokens.
void	handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp)
private java.lang.String	writeCharStream(NamedList out, org.apache.lucene.analysis.CharStream input)

Methods inherited from class org.apache.solr.handler.RequestHandlerBase

getCategory, getDescription, getDocs, getInitArgs, getName, getSource, getSourceId, getStatistics, getVersion, handleRequest, init

Methods inherited from class java.lang.Object

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

Field Detail

ATTRIBUTE_MAPPING

static java.util.Map<java.lang.String,java.lang.String> ATTRIBUTE_MAPPING

Constructor Detail

AnalysisRequestHandlerBase

public AnalysisRequestHandlerBase()

Method Detail

handleRequestBody

public void handleRequestBody(SolrQueryRequest req,
                              SolrQueryResponse rsp)
                       throws java.lang.Exception

Specified by:

handleRequestBody in class RequestHandlerBase

Throws:

java.lang.Exception

doAnalysis

protected abstract NamedList doAnalysis(SolrQueryRequest req)
                                 throws java.lang.Exception

Performs the analysis based on the given solr request and returns the analysis result as a named list.

Parameters:

req - The solr request.

Returns:

The analysis result as a named list.

Throws:

java.lang.Exception - When analysis fails.

analyzeValue

protected NamedList<java.util.List<NamedList>> analyzeValue(java.lang.String value,
                                                            AnalysisRequestHandlerBase.AnalysisContext context)

Analyzes the given value using the given Analyzer.

Parameters:

value - Value to analyze

context - The analysis context.

Returns:

NamedList containing the tokens produced by analyzing the given value

analyzeValue

@Deprecated
protected java.util.List<org.apache.lucene.util.AttributeSource> analyzeValue(java.lang.String value,
                                                                                          org.apache.lucene.analysis.Analyzer analyzer)

Deprecated. This method is no longer used by Solr

Analyzes the given text using the given analyzer and returns the produced tokens.

Parameters:

value - The value to analyze.

analyzer - The analyzer to use.

Returns:

The produces token list.

See Also:

getQueryTokenSet(java.lang.String, org.apache.lucene.analysis.Analyzer)

getQueryTokenSet

protected java.util.Set<java.lang.String> getQueryTokenSet(java.lang.String query,
                                                           org.apache.lucene.analysis.Analyzer analyzer)

Analyzes the given text using the given analyzer and returns the produced tokens.

Parameters:

query - The query to analyze.

analyzer - The analyzer to use.

analyzeTokenStream

private java.util.List<org.apache.lucene.util.AttributeSource> analyzeTokenStream(org.apache.lucene.analysis.TokenStream tokenStream)

Analyzes the given TokenStream, collecting the Tokens it produces.

Parameters:

tokenStream - TokenStream to analyze

Returns:

List of tokens produced from the TokenStream

convertTokensToNamedLists

private java.util.List<NamedList> convertTokensToNamedLists(java.util.List<org.apache.lucene.util.AttributeSource> tokenList,
                                                            AnalysisRequestHandlerBase.AnalysisContext context)

Converts the list of Tokens to a list of NamedLists representing the tokens.

Parameters:

tokens - Tokens to convert

context - The analysis context

Returns:

List of NamedLists containing the relevant information taken from the tokens

writeCharStream

private java.lang.String writeCharStream(NamedList out,
                                         org.apache.lucene.analysis.CharStream input)