com.amazonaws.services.cloudsearchdomain.model

Class SearchResult

java.lang.Object

com.amazonaws.services.cloudsearchdomain.model.SearchResult

All Implemented Interfaces:

Serializable

public class SearchResult
extends Object
implements Serializable

The result of a Search request. Contains the documents that match the specified search criteria and any requested fields, highlights, and facet information.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SearchResult()

Method Summary

Methods

Modifier and Type	Method and Description
SearchResult	addFacetsEntry(String key, BucketInfo value) The requested facet information.
SearchResult	clearFacetsEntries() Removes all the entries added into Facets.
boolean	equals(Object obj)
Map<String,BucketInfo>	getFacets() The requested facet information.
Hits	getHits() The documents that match the search criteria.
SearchStatus	getStatus() The status information returned for the search request.
int	hashCode()
void	setFacets(Map<String,BucketInfo> facets) The requested facet information.
void	setHits(Hits hits) The documents that match the search criteria.
void	setStatus(SearchStatus status) The status information returned for the search request.
String	toString() Returns a string representation of this object; useful for testing and debugging.
SearchResult	withFacets(Map<String,BucketInfo> facets) The requested facet information.
SearchResult	withHits(Hits hits) The documents that match the search criteria.
SearchResult	withStatus(SearchStatus status) The status information returned for the search request.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchResult

public SearchResult()

Method Detail

getStatus

public SearchStatus getStatus()

The status information returned for the search request.

Returns:

The status information returned for the search request.

setStatus

public void setStatus(SearchStatus status)

The status information returned for the search request.

Parameters:

status - The status information returned for the search request.

withStatus

public SearchResult withStatus(SearchStatus status)

The status information returned for the search request.

Returns a reference to this object so that method calls can be chained together.

Parameters:

status - The status information returned for the search request.

Returns:

A reference to this updated object so that method calls can be chained together.

getHits

public Hits getHits()

The documents that match the search criteria.

Returns:

The documents that match the search criteria.

setHits

public void setHits(Hits hits)

The documents that match the search criteria.

Parameters:

hits - The documents that match the search criteria.

withHits

public SearchResult withHits(Hits hits)

The documents that match the search criteria.

Returns a reference to this object so that method calls can be chained together.

Parameters:

hits - The documents that match the search criteria.

Returns:

A reference to this updated object so that method calls can be chained together.

getFacets

public Map<String,BucketInfo> getFacets()

The requested facet information.

Returns:

The requested facet information.

setFacets

public void setFacets(Map<String,BucketInfo> facets)

The requested facet information.

Parameters:

facets - The requested facet information.

withFacets

public SearchResult withFacets(Map<String,BucketInfo> facets)

The requested facet information.

Returns a reference to this object so that method calls can be chained together.

Parameters:

facets - The requested facet information.

Returns:

A reference to this updated object so that method calls can be chained together.

addFacetsEntry

public SearchResult addFacetsEntry(String key,
                          BucketInfo value)

The requested facet information.

The method adds a new key-value pair into Facets parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into Facets.

value - The corresponding value of the entry to be added into Facets.

clearFacetsEntries

public SearchResult clearFacetsEntries()

Removes all the entries added into Facets.

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object