|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.solr.request.SolrQueryResponse
public class SolrQueryResponse
SolrQueryResponse
is used by a query handler to return
the response to a query request.
Note On Returnable Data...
A SolrQueryResponse
may contain the following types of
Objects generated by the SolrRequestHandler
that processed
the request.
String
Integer
Long
Float
Double
Boolean
Date
DocList
SolrDocument
(since 1.3)SolrDocumentList
(since 1.3)Map
containing any of the items in this listNamedList
containing any of the items in this listCollection
containing any of the items in this listOther data types may be added to the SolrQueryResponse, but there is no guarantee that QueryResponseWriters will be able to deal with unexpected types.
Field Summary | |
---|---|
protected Set<String> |
defaultReturnFields
|
protected long |
endtime
The endtime of the request in milliseconds. |
protected Exception |
err
|
protected boolean |
httpCaching
Should this response be tagged with HTTP caching headers? |
protected org.apache.solr.common.util.NamedList |
toLog
Container for storing information that should be logged by Solr before returning. |
protected org.apache.solr.common.util.NamedList |
values
Container for user defined values |
Constructor Summary | |
---|---|
SolrQueryResponse()
// another way of returning an error int errCode; String errMsg; |
Method Summary | |
---|---|
void |
add(String name,
Object val)
Appends a named value to the list of named values to be returned. |
void |
addToLog(String name,
Object val)
Add a value to be logged. |
long |
getEndTime()
Get the time in milliseconds when the response officially finished. |
Exception |
getException()
Returns an Exception if there was a fatal error in processing the request. |
org.apache.solr.common.util.NamedList |
getResponseHeader()
Repsonse header to be logged |
Set<String> |
getReturnFields()
Gets the document field names of fields to return by default when returning DocLists |
org.apache.solr.common.util.NamedList |
getToLog()
Get loggable items. |
org.apache.solr.common.util.NamedList |
getValues()
Gets data to be returned in this response |
boolean |
isHttpCaching()
Should this response emit HTTP caching headers? |
void |
setAllValues(org.apache.solr.common.util.NamedList nameValuePairs)
Sets data to be returned in this response |
long |
setEndTime()
Stop the timer for how long this query took. |
long |
setEndTime(long endtime)
Set the in milliseconds when the response officially finished. |
void |
setException(Exception e)
Causes an error to be returned instead of the results. |
void |
setHttpCaching(boolean httpCaching)
Enables or disables the emission of HTTP caching headers for this response. |
void |
setReturnFields(Set<String> fields)
Sets the document field names of fields to return by default when returning DocLists |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected org.apache.solr.common.util.NamedList values
getValues()
,
add(java.lang.String, java.lang.Object)
,
setAllValues(org.apache.solr.common.util.NamedList)
,
Note on Returnable Dataprotected org.apache.solr.common.util.NamedList toLog
protected Set<String> defaultReturnFields
protected Exception err
protected boolean httpCaching
protected long endtime
setEndTime(long)
,
getEndTime()
Constructor Detail |
---|
public SolrQueryResponse()
Method Detail |
---|
public org.apache.solr.common.util.NamedList getValues()
public void setAllValues(org.apache.solr.common.util.NamedList nameValuePairs)
public void setReturnFields(Set<String> fields)
public Set<String> getReturnFields()
public void add(String name, Object val)
name
- the name of the value - may be null if unnamedval
- the value to add - also may be null since null is a legal valuepublic void setException(Exception e)
public Exception getException()
public long getEndTime()
public long setEndTime()
setEndTime(long)
public long setEndTime(long endtime)
setEndTime()
public org.apache.solr.common.util.NamedList getResponseHeader()
public void addToLog(String name, Object val)
name
- name of the thing to logval
- value of the thing to logpublic org.apache.solr.common.util.NamedList getToLog()
public void setHttpCaching(boolean httpCaching)
httpCaching
- true=emit caching headers, false otherwisepublic boolean isHttpCaching()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |