ddf.catalog.operation.impl

Class QueryResponseImpl

java.lang.Object

ddf.catalog.operation.impl.OperationImpl

ddf.catalog.operation.impl.ResponseImpl<QueryRequest>

ddf.catalog.operation.impl.QueryResponseImpl

All Implemented Interfaces:

Operation, QueryResponse, Response<QueryRequest>, SourceResponse, Serializable

public class QueryResponseImpl
extends ResponseImpl<QueryRequest>
implements QueryResponse

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	QueryResponseImpl.POISON_PILL_RESULT

Field Summary

Fields

Modifier and Type	Field and Description
protected long	hits
protected boolean	isQueueClosed
protected static Result	POISON_PILL_RESULT

Fields inherited from class ddf.catalog.operation.impl.ResponseImpl

request

Fields inherited from interface ddf.catalog.operation.QueryResponse

ELAPSED_TIME, SITE_LIST, TOTAL_HITS, TOTAL_RESULTS_RETURNED

Constructor Summary

Constructors

Constructor and Description
QueryResponseImpl(QueryRequest request) Instantiates a new QueryResponseImpl with a $(@link QueryRequest)
QueryResponseImpl(QueryRequest request, List<Result> results, boolean closeResultQueue, long hits) Instantiates a new QueryResponseImpl with a $(@link QueryRequest), a $List of results, a closeResultQueue indicator, and a number of hits to return
QueryResponseImpl(QueryRequest request, List<Result> results, boolean closeResultQueue, long hits, Map<String,Serializable> properties) Instantiates a new QueryResponseImpl with a $(@link QueryRequest), a $List of results, a closeResultQueue indicator, a number of hits to return, and a $Map of properties
QueryResponseImpl(QueryRequest request, List<Result> results, long totalHits) Instantiates a new QueryResponseImpl with a $(@link QueryRequest) and and a $List of results
QueryResponseImpl(QueryRequest request, Map<String,Serializable> properties) Instantiates a new QueryResponseImpl with a $(@link QueryRequest) and and a $Map of properties
QueryResponseImpl(SourceResponse response, String sourceId) Construct from an underlying SourceResponse

Method Summary

Modifier and Type	Method and Description
void	addResult(Result result, boolean closeQueue) Adds a $Result to this QueryResponse, and specifies whether or not to close the queue
void	addResults(List<Result> results, boolean closeQueue) Adds a $List of $Results to this QueryResponse, and specifies whether or not to close the queue
void	closeResultQueue()
long	getHits() The total number of hits matching the associated Query for the associated Source, -1 if unknown.
Set<ProcessingDetails>	getProcessingDetails() Get any specific details about the execution of the QueryRequest associated with this SourceResponse.
List<Result>	getResults() Get the Results of the associated QueryRequest
boolean	hasMoreResults()
Result	poll()
Result	poll(long timeout)
void	setHits(long hits)
void	setProcessingDetails(Set<ProcessingDetails> set)
Result	take()
List<Result>	take(long size)

Methods inherited from class ddf.catalog.operation.impl.ResponseImpl

getRequest

Methods inherited from class ddf.catalog.operation.impl.OperationImpl

containsPropertyName, getProperties, getPropertyNames, getPropertyValue, hasProperties, setProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface ddf.catalog.operation.Response

getProcessingErrors, getRequest

Methods inherited from interface ddf.catalog.operation.Operation

containsPropertyName, getProperties, getPropertyNames, getPropertyValue, hasProperties

Field Detail

POISON_PILL_RESULT

protected static final Result POISON_PILL_RESULT

hits

protected long hits

isQueueClosed

protected boolean isQueueClosed

Constructor Detail

QueryResponseImpl

public QueryResponseImpl(QueryRequest request)

Instantiates a new QueryResponseImpl with a $(@link QueryRequest)

Parameters:

request - the request

QueryResponseImpl

public QueryResponseImpl(QueryRequest request,
                         Map<String,Serializable> properties)

Instantiates a new QueryResponseImpl with a $(@link QueryRequest) and and a $Map of properties

Parameters:

request - the request

properties -

QueryResponseImpl

public QueryResponseImpl(QueryRequest request,
                         List<Result> results,
                         long totalHits)

Instantiates a new QueryResponseImpl with a $(@link QueryRequest) and and a $List of results

Parameters:

request - the request

results - the results

QueryResponseImpl

public QueryResponseImpl(QueryRequest request,
                         List<Result> results,
                         boolean closeResultQueue,
                         long hits)

Instantiates a new QueryResponseImpl with a $(@link QueryRequest), a $List of results, a closeResultQueue indicator, and a number of hits to return

Parameters:

request - the request

results - the results

hits - the hits

QueryResponseImpl

public QueryResponseImpl(QueryRequest request,
                         List<Result> results,
                         boolean closeResultQueue,
                         long hits,
                         Map<String,Serializable> properties)

Instantiates a new QueryResponseImpl with a $(@link QueryRequest), a $List of results, a closeResultQueue indicator, a number of hits to return, and a $Map of properties

Parameters:

request - the request

results - the results

hits - the hits

properties - the properties

QueryResponseImpl

public QueryResponseImpl(SourceResponse response,
                         String sourceId)

Construct from an underlying SourceResponse

Parameters:

response -

sourceId -

Method Detail

getHits

public long getHits()

Description copied from interface: SourceResponse

The total number of hits matching the associated Query for the associated Source, -1 if unknown. This is typically more than the number of Results returned from SourceResponse.getResults().

Specified by:

getHits in interface SourceResponse

Returns:

long - total hits matching this Query, -1 if unknown.

setHits

public void setHits(long hits)

getProcessingDetails

public Set<ProcessingDetails> getProcessingDetails()

Description copied from interface: SourceResponse

Get any specific details about the execution of the QueryRequest associated with this SourceResponse. Must not be null.

Specified by:

getProcessingDetails in interface QueryResponse

Specified by:

getProcessingDetails in interface SourceResponse

Returns:

the processing details

setProcessingDetails

public void setProcessingDetails(Set<ProcessingDetails> set)

getResults

public List<Result> getResults()

Description copied from interface: SourceResponse

Get the Results of the associated QueryRequest

Specified by:

getResults in interface SourceResponse

Returns:

the results

addResult

public void addResult(Result result,
                      boolean closeQueue)

Adds a $Result to this QueryResponse, and specifies whether or not to close the queue

Parameters:

result - the result

closeQueue - the indicator for closing of the queue

addResults

public void addResults(List<Result> results,
                       boolean closeQueue)

Adds a $List of $Results to this QueryResponse, and specifies whether or not to close the queue

Parameters:

results - the results

closeQueue - the indicator for closing of the queue

hasMoreResults

public boolean hasMoreResults()

Specified by:

hasMoreResults in interface QueryResponse

closeResultQueue

public void closeResultQueue()

poll

public Result poll()

Specified by:

poll in interface QueryResponse

poll

public Result poll(long timeout)

Specified by:

poll in interface QueryResponse

take

public Result take()

Specified by:

take in interface QueryResponse

take

public List<Result> take(long size)

Specified by:

take in interface QueryResponse