Class FieldAnalysisRequest
- java.lang.Object
-
- org.apache.solr.client.solrj.SolrRequest<FieldAnalysisResponse>
-
- org.apache.solr.client.solrj.request.FieldAnalysisRequest
-
- All Implemented Interfaces:
Serializable
public class FieldAnalysisRequest extends SolrRequest<FieldAnalysisResponse>
A request for the org.apache.solr.handler.FieldAnalysisRequestHandler.- Since:
- solr.14
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.solr.client.solrj.SolrRequest
SolrRequest.METHOD
-
-
Field Summary
-
Fields inherited from class org.apache.solr.client.solrj.SolrRequest
SUPPORTED_METHODS, useBinaryV2, usev2
-
-
Constructor Summary
Constructors Constructor Description FieldAnalysisRequest()
Constructs a new FieldAnalysisRequest with a default uri of "/fieldanalysis".FieldAnalysisRequest(String uri)
Constructs a new FieldAnalysisRequest with a given uri.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FieldAnalysisRequest
addFieldName(String fieldName)
Adds the given field name for analysis.FieldAnalysisRequest
addFieldType(String fieldTypeName)
Adds the given field type for analysis.protected FieldAnalysisResponse
createResponse(SolrClient client)
Create a new SolrResponse to hold the response from the serverList<String>
getFieldNames()
Returns a list of field names the analysis should be performed on.List<String>
getFieldTypes()
Returns a list of field types the analysis should be performed on.String
getFieldValue()
Returns the field value that will be analyzed when this request is processed.SolrParams
getParams()
String
getQuery()
Returns the query that will be analyzed.boolean
isShowMatch()
Returns whether index time tokens that match query time tokens should be marked as a "match".FieldAnalysisRequest
setFieldNames(List<String> fieldNames)
Sets the field names on which the analysis should be performed.FieldAnalysisRequest
setFieldTypes(List<String> fieldTypes)
Sets the field types on which analysis should be performed.FieldAnalysisRequest
setFieldValue(String fieldValue)
Sets the field value to be analyzed.FieldAnalysisRequest
setQuery(String query)
Sets the query to be analyzed.FieldAnalysisRequest
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
addHeader, getBasePath, getBasicAuthPassword, getBasicAuthUser, getCollection, getContentStreams, getContentWriter, getHeaders, getMethod, getPath, getQueryParams, getResponseParser, getStreamingResponseCallback, getUserPrincipal, process, process, setBasePath, setBasicAuthCredentials, setMethod, setPath, setQueryParams, setResponseParser, setStreamingResponseCallback, setUseBinaryV2, setUserPrincipal, setUseV2
-
-
-
-
Constructor Detail
-
FieldAnalysisRequest
public FieldAnalysisRequest()
Constructs a new FieldAnalysisRequest with a default uri of "/fieldanalysis".
-
FieldAnalysisRequest
public FieldAnalysisRequest(String uri)
Constructs a new FieldAnalysisRequest with a given uri.- Parameters:
uri
- the uri of the request handler.
-
-
Method Detail
-
createResponse
protected FieldAnalysisResponse createResponse(SolrClient client)
Description copied from class:SolrRequest
Create a new SolrResponse to hold the response from the server- Specified by:
createResponse
in classSolrRequest<FieldAnalysisResponse>
- Parameters:
client
- theSolrClient
the request will be sent to
-
getParams
public SolrParams getParams()
- Specified by:
getParams
in classSolrRequest<FieldAnalysisResponse>
-
setFieldValue
public FieldAnalysisRequest setFieldValue(String fieldValue)
Sets the field value to be analyzed.- Parameters:
fieldValue
- The field value to be analyzed.- Returns:
- This FieldAnalysisRequest (fluent interface support).
-
getFieldValue
public String getFieldValue()
Returns the field value that will be analyzed when this request is processed.- Returns:
- The field value that will be analyzed when this request is processed.
-
setQuery
public FieldAnalysisRequest setQuery(String query)
Sets the query to be analyzed. May benull
indicated that no query analysis should take place.- Parameters:
query
- The query to be analyzed.- Returns:
- This FieldAnalysisRequest (fluent interface support).
-
getQuery
public String getQuery()
Returns the query that will be analyzed. May returnnull
indicating that no query analysis will be performed.- Returns:
- The query that will be analyzed. May return
null
indicating that no query analysis will be performed.
-
setShowMatch
public FieldAnalysisRequest setShowMatch(boolean showMatch)
Sets whether index time tokens that match query time tokens should be marked as a "match". By default this is set tofalse
. Obviously, this flag is ignored if when the query is set tonull
.- Parameters:
showMatch
- Sets whether index time tokens that match query time tokens should be marked as a "match".- Returns:
- This FieldAnalysisRequest (fluent interface support).
-
isShowMatch
public boolean isShowMatch()
Returns whether index time tokens that match query time tokens should be marked as a "match".- Returns:
- Whether index time tokens that match query time tokens should be marked as a "match".
- See Also:
setShowMatch(boolean)
-
addFieldName
public FieldAnalysisRequest addFieldName(String fieldName)
Adds the given field name for analysis.- Parameters:
fieldName
- A field name on which the analysis should be performed.- Returns:
- this FieldAnalysisRequest (fluent interface support).
-
setFieldNames
public FieldAnalysisRequest setFieldNames(List<String> fieldNames)
Sets the field names on which the analysis should be performed.- Parameters:
fieldNames
- The field names on which the analysis should be performed.- Returns:
- this FieldAnalysisRequest (fluent interface support).
-
getFieldNames
public List<String> getFieldNames()
Returns a list of field names the analysis should be performed on. May returnnull
indicating that no analysis will be performed on field names.- Returns:
- The field names the analysis should be performed on.
-
addFieldType
public FieldAnalysisRequest addFieldType(String fieldTypeName)
Adds the given field type for analysis.- Parameters:
fieldTypeName
- A field type name on which analysis should be performed.- Returns:
- This FieldAnalysisRequest (fluent interface support).
-
setFieldTypes
public FieldAnalysisRequest setFieldTypes(List<String> fieldTypes)
Sets the field types on which analysis should be performed.- Parameters:
fieldTypes
- The field type names on which analysis should be performed.- Returns:
- This FieldAnalysisRequest (fluent interface support).
-
-