org.apache.solr.client.solrj.request

Class DocumentAnalysisRequest

java.lang.Object

org.apache.solr.client.solrj.SolrRequest

org.apache.solr.client.solrj.request.DocumentAnalysisRequest

All Implemented Interfaces:

java.io.Serializable

public class DocumentAnalysisRequest
extends SolrRequest

A request for the org.apache.solr.handler.DocumentAnalysisRequestHandler.

Since:

solr 1.4

Version:

$Id: DocumentAnalysisRequest.java 767412 2009-04-22 08:53:28Z shalin $

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.solr.client.solrj.SolrRequest

SolrRequest.METHOD

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<SolrInputDocument>	documents
private java.lang.String	query
private boolean	showMatch

Constructor Summary

Constructors

Constructor and Description
DocumentAnalysisRequest() Constructs a new request with a default uri of "/documentanalysis".
DocumentAnalysisRequest(java.lang.String uri) Constructs a new request with the given request handler uri.

Method Summary

Modifier and Type	Method and Description
DocumentAnalysisRequest	addDocument(SolrInputDocument doc) Adds a document to be analyzed.
DocumentAnalysisRequest	addDocuments(java.util.Collection<SolrInputDocument> docs) Adds a collection of documents to be analyzed.
java.util.Collection<ContentStream>	getContentStreams()
java.util.List<SolrInputDocument>	getDocuments() Returns all documents that will be analyzed when processing the request.
ModifiableSolrParams	getParams()
java.lang.String	getQuery() Returns the query that will be analyzed when processing the request.
(package private) java.lang.String	getXML() Returns the xml be be set as the request body.
boolean	isShowMatch() Returns whether index time tokens that match query time tokens will be marked as a "match".
DocumentAnalysisResponse	process(SolrServer server)
DocumentAnalysisRequest	setQuery(java.lang.String query) Sets the query to be analyzed.
DocumentAnalysisRequest	setShowMatch(boolean showMatch) Sets whether index time tokens that match query time tokens should be marked as a "match".

Methods inherited from class org.apache.solr.client.solrj.SolrRequest

getMethod, getPath, getResponseParser, setMethod, setPath, setResponseParser

Methods inherited from class java.lang.Object

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

Field Detail

documents

private java.util.List<SolrInputDocument> documents

query

private java.lang.String query

showMatch

private boolean showMatch

Constructor Detail

DocumentAnalysisRequest

public DocumentAnalysisRequest()

Constructs a new request with a default uri of "/documentanalysis".

DocumentAnalysisRequest

public DocumentAnalysisRequest(java.lang.String uri)

Constructs a new request with the given request handler uri.

Parameters:

uri - The of the request handler.

Method Detail

getContentStreams

public java.util.Collection<ContentStream> getContentStreams()
                                                      throws java.io.IOException

Specified by:

getContentStreams in class SolrRequest

Throws:

java.io.IOException

getParams

public ModifiableSolrParams getParams()

Specified by:

getParams in class SolrRequest

process

public DocumentAnalysisResponse process(SolrServer server)
                                 throws SolrServerException,
                                        java.io.IOException

Specified by:

process in class SolrRequest

Throws:

SolrServerException

java.io.IOException

getXML

java.lang.String getXML()
                 throws java.io.IOException

Returns the xml be be set as the request body.

Returns:

The xml be be set as the request body.

Throws:

java.io.IOException - When constructing the xml fails

addDocument

public DocumentAnalysisRequest addDocument(SolrInputDocument doc)

Adds a document to be analyzed.

Parameters:

doc - The document to be analyzed.

Returns:

This DocumentAnalysisRequest (fluent interface support).

addDocuments

public DocumentAnalysisRequest addDocuments(java.util.Collection<SolrInputDocument> docs)

Adds a collection of documents to be analyzed.

Parameters:

docs - The documents to be analyzed.

Returns:

This DocumentAnalysisRequest (fluent interface support).

See Also:

addDocument(org.apache.solr.common.SolrInputDocument)

setQuery

public DocumentAnalysisRequest setQuery(java.lang.String query)

Sets the query to be analyzed. By default the query is set to null, meaning no query analysis will be performed.

Parameters:

query - The query to be analyzed.

Returns:

This DocumentAnalysisRequest (fluent interface support).

setShowMatch

public DocumentAnalysisRequest setShowMatch(boolean showMatch)

Sets whether index time tokens that match query time tokens should be marked as a "match". By default this is set to false. Obviously, this flag is ignored if when the query is set to null.

Parameters:

showMatch - Sets whether index time tokens that match query time tokens should be marked as a "match".

Returns:

This DocumentAnalysisRequest (fluent interface support).

getDocuments

public java.util.List<SolrInputDocument> getDocuments()

Returns all documents that will be analyzed when processing the request.

Returns:

All documents that will be analyzed when processing the request.

See Also:

addDocument(org.apache.solr.common.SolrInputDocument)

getQuery

public java.lang.String getQuery()

Returns the query that will be analyzed when processing the request. May return null indicating that no query time analysis is taking place.

Returns:

The query that will be analyzed when processing the request.

See Also:

setQuery(String)

isShowMatch

public boolean isShowMatch()

Returns whether index time tokens that match query time tokens will be marked as a "match".

Returns:

Whether index time tokens that match query time tokens will be marked as a "match".

See Also:

setShowMatch(boolean)