Package org.apache.solr.client.solrj.request

Class LukeRequest

java.lang.Object

org.apache.solr.client.solrj.SolrRequest<T>

org.apache.solr.client.solrj.request.CollectionRequiringSolrRequest<LukeResponse>

org.apache.solr.client.solrj.request.LukeRequest

All Implemented Interfaces:

Serializable

public class LukeRequest
extends CollectionRequiringSolrRequest<LukeResponse>

Since:

solr 1.3

See Also:

Serialized Form

Nested Class Summary

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

SolrRequest.METHOD, SolrRequest.SolrClientContext, SolrRequest.SolrRequestType

Field Summary

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

SUPPORTED_METHODS, useBinaryV2, usev2

Constructor Summary

Constructors

Constructor	Description
LukeRequest()
LukeRequest(String path)

Method Summary

Modifier and Type	Method	Description
void	addField(String f)
protected LukeResponse	createResponse(SolrClient client)	Create a new SolrResponse to hold the response from the server
boolean	getIncludeIndexFieldFlags()
int	getNumTerms()
SolrParams	getParams()
String	getRequestType()	This method defines the type of this Solr request.
boolean	isShowSchema()
void	setFields(List<String> f)
void	setIncludeIndexFieldFlags(boolean shouldInclude)	Choose whether /luke should return the index-flags for each field
void	setNumTerms(int count)	the number of terms to return for a given field.
void	setShowSchema(boolean showSchema)

Methods inherited from class org.apache.solr.client.solrj.request.CollectionRequiringSolrRequest

requiresCollection

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

addHeader, addHeaders, getBasePath, getBasicAuthPassword, getBasicAuthUser, getCollection, getContentStreams, getContentWriter, getHeaders, getMethod, getPath, getPreferredNodes, getQueryParams, getResponseParser, getStreamingResponseCallback, getUserPrincipal, process, process, setBasePath, setBasicAuthCredentials, setMethod, setPath, setPreferredNodes, setQueryParams, setResponseParser, setStreamingResponseCallback, setUseBinaryV2, setUserPrincipal, setUseV2

Methods inherited from class java.lang.Object

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

Constructor Detail

LukeRequest

public LukeRequest()

LukeRequest

public LukeRequest(String path)

Method Detail

addField

public void addField(String f)

setFields

public void setFields(List<String> f)

isShowSchema

public boolean isShowSchema()

setShowSchema

public void setShowSchema(boolean showSchema)

getNumTerms

public int getNumTerms()

setNumTerms

public void setNumTerms(int count)

the number of terms to return for a given field. If the number is 0, it will not traverse the terms.

setIncludeIndexFieldFlags

public void setIncludeIndexFieldFlags(boolean shouldInclude)

Choose whether /luke should return the index-flags for each field

Fetching and returning the index-flags for each field in your index has non-zero cost, and can slow down requests to /luke. Users who do not care about these values can tell Solr to avoid generating them by setting the 'includeIndexFieldFlags' flag to false, saving their requests some processing.

getIncludeIndexFieldFlags

public boolean getIncludeIndexFieldFlags()

createResponse

protected LukeResponse createResponse(SolrClient client)

Description copied from class: SolrRequest

Create a new SolrResponse to hold the response from the server

Specified by:

createResponse in class SolrRequest<LukeResponse>

Parameters:

client - the SolrClient the request will be sent to

getParams

public SolrParams getParams()

Specified by:

getParams in class SolrRequest<LukeResponse>

getRequestType

public String getRequestType()

Description copied from class: SolrRequest

This method defines the type of this Solr request.

Specified by:

getRequestType in class SolrRequest<LukeResponse>