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

java.lang.Object
  extended by org.apache.solr.client.solrj.SolrRequest
      extended by org.apache.solr.client.solrj.request.DocumentAnalysisRequest
All Implemented Interfaces:
Serializable

public class DocumentAnalysisRequest
extends SolrRequest

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

Since:
solr 1.4
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.solr.client.solrj.SolrRequest
SolrRequest.METHOD
 
Constructor Summary
DocumentAnalysisRequest()
          Constructs a new request with a default uri of "/documentanalysis".
DocumentAnalysisRequest(String uri)
          Constructs a new request with the given request handler uri.
 
Method Summary
 DocumentAnalysisRequest addDocument(SolrInputDocument doc)
          Adds a document to be analyzed.
 DocumentAnalysisRequest addDocuments(Collection<SolrInputDocument> docs)
          Adds a collection of documents to be analyzed.
 Collection<ContentStream> getContentStreams()
          
 List<SolrInputDocument> getDocuments()
          Returns all documents that will be analyzed when processing the request.
 ModifiableSolrParams getParams()
          
 String getQuery()
          Returns the query that will be analyzed when processing the request.
 boolean isShowMatch()
          Returns whether index time tokens that match query time tokens will be marked as a "match".
 DocumentAnalysisResponse process(SolrServer server)
          
 DocumentAnalysisRequest setQuery(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, getStreamingResponseCallback, setMethod, setPath, setResponseParser, setStreamingResponseCallback
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DocumentAnalysisRequest

public DocumentAnalysisRequest()
Constructs a new request with a default uri of "/documentanalysis".


DocumentAnalysisRequest

public DocumentAnalysisRequest(String uri)
Constructs a new request with the given request handler uri.

Parameters:
uri - The of the request handler.
Method Detail

getContentStreams

public Collection<ContentStream> getContentStreams()
                                            throws IOException

Specified by:
getContentStreams in class SolrRequest
Throws:
IOException

getParams

public ModifiableSolrParams getParams()

Specified by:
getParams in class SolrRequest

process

public DocumentAnalysisResponse process(SolrServer server)
                                 throws SolrServerException,
                                        IOException

Specified by:
process in class SolrRequest
Throws:
SolrServerException
IOException

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(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(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 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 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)


Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.