ddf.catalog.operation.impl

Class SourceResponseImpl

java.lang.Object

ddf.catalog.operation.impl.OperationImpl

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

ddf.catalog.operation.impl.SourceResponseImpl

All Implemented Interfaces:

Operation, Response<QueryRequest>, SourceResponse, Serializable

public class SourceResponseImpl
extends ResponseImpl<QueryRequest>
implements SourceResponse

The SourceResponseImpl represents a default implementation of the SourceResponse.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected long	hits
protected Set<SourceProcessingDetails>	sourceProcessingDetails

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

request

Constructor Summary

Constructors

Constructor and Description
SourceResponseImpl(QueryRequest request, List<Result> results) Instantiates a new SourceResponseImpl with the original query request and results from the query being executed.
SourceResponseImpl(QueryRequest request, List<Result> results, Long totalHits) Instantiates a new SourceResponseImpl.
SourceResponseImpl(QueryRequest request, Map<String,Serializable> properties, List<Result> results) Instantiates a new SourceResponseImpl with properties.
SourceResponseImpl(QueryRequest request, Map<String,Serializable> properties, List<Result> results, long totalHits) Instantiates a new SourceResponseImpl with properties and when the total number of hits is known.

Method Summary

Modifier and Type	Method and Description
boolean	containsPropertyName(String name)
long	getHits() The total number of hits matching the associated Query for the associated Source, -1 if unknown.
Set<SourceProcessingDetails>	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
void	setHits(long hits) Sets the hits.
void	setWarnings(List<String> warnings) Sets the warnings associated with the Source.

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

getRequest

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

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

getProperties, getPropertyNames, getPropertyValue, hasProperties

Field Detail

hits

protected long hits

sourceProcessingDetails

protected Set<SourceProcessingDetails> sourceProcessingDetails

Constructor Detail

SourceResponseImpl

public SourceResponseImpl(QueryRequest request,
                          List<Result> results)

Instantiates a new SourceResponseImpl with the original query request and results from the query being executed.

Parameters:

request - the original request

results - the results associated with the query

SourceResponseImpl

public SourceResponseImpl(QueryRequest request,
                          List<Result> results,
                          Long totalHits)

Instantiates a new SourceResponseImpl. Use when the total amount of hits is known.

Parameters:

request - the original request

results - the hits associated with the query

totalHits - the total results associated with the query.

SourceResponseImpl

public SourceResponseImpl(QueryRequest request,
                          Map<String,Serializable> properties,
                          List<Result> results)

Instantiates a new SourceResponseImpl with properties.

Parameters:

request - the original request

properties - the properties associated with the operation

results - the results associated with the query

SourceResponseImpl

public SourceResponseImpl(QueryRequest request,
                          Map<String,Serializable> properties,
                          List<Result> results,
                          long totalHits)

Instantiates a new SourceResponseImpl with properties and when the total number of hits is known.

Parameters:

request - the original request

properties - the properties associated with the operation

results - the results associated with the query

totalHits - the total hits

Method Detail

containsPropertyName

public boolean containsPropertyName(String name)

Specified by:

containsPropertyName in interface Operation

Overrides:

containsPropertyName in class OperationImpl

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)

Sets the hits.

Parameters:

hits - the new hits

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

getProcessingDetails

public Set<SourceProcessingDetails> 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 SourceResponse

Returns:

the processing details

setWarnings

public void setWarnings(List<String> warnings)

Sets the warnings associated with the Source.

Parameters:

warnings - the new warnings associated with the Source.