com.exalead.searchapi.xmlv10.client

Interface Hit

All Superinterfaces:

java.lang.Comparable<Hit>

All Known Implementing Classes:

HitImpl, HitImpl

public interface Hit
extends java.lang.Comparable<Hit>

Holds the informations related to a search result. The informations are separated within the metas and the category groups which allow search navigation

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Hit.InfoKey

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBuildGroup() Get the CloudView build group on which this search result was pushed.
CategoryGroup	getCategoryGroup(java.lang.String id) Get a facet for this search result, by its id.
java.util.Collection<CategoryGroup>	getCategoryGroups() Get all facets for this search result.
int	getCollapsedHits() Get the number of original hits that have been collapsed onto this one.
long	getDid() Get the internal document identifier of this search result.
java.lang.String	getInfo(Hit.InfoKey key)
java.lang.String	getInfo(Hit.InfoKey key, java.lang.String defaultValue)
java.lang.String	getInfo(java.lang.String key)
java.lang.String	getInfo(java.lang.String key, java.lang.String defaultValue)
java.util.Map<java.lang.String,java.lang.String>	getInfos() Get various information about the hit.
Meta	getMeta(java.lang.String name) Get a meta by its name.
java.util.Collection<Meta>	getMetas() Get all meta for this search result.
long	getScore() Get the score of this search result.
int	getSlice() Get the internal slice of this search result.
java.lang.String	getSource() Get the source of the search result.
java.lang.String	getUrl() Get the URL of the search result.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getUrl

java.lang.String getUrl()

Get the URL of the search result. The URL identifies the search result, within the context of a source and a build group. Depending on the case, this URL might or might no be suitable for fetching this document through the CloudView fetch API, for getting its thumbnail, or for a public access to the document.

getSource

java.lang.String getSource()

Get the source of the search result. The source identifies how this document was pushed to CloudView. Together with the URL and the buildgroup, it uniquely identifies a document in a CloudView instance.

getBuildGroup

java.lang.String getBuildGroup()

Get the CloudView build group on which this search result was pushed. Together with the source and the buildgroup, it uniquely identifies a document in a CloudView instance.

getDid

long getDid()

Get the internal document identifier of this search result.

getSlice

int getSlice()

Get the internal slice of this search result.

getScore

long getScore()

Get the score of this search result.

getCollapsedHits

int getCollapsedHits()

Get the number of original hits that have been collapsed onto this one.

getInfos

java.util.Map<java.lang.String,java.lang.String> getInfos()

Get various information about the hit.

getInfo

java.lang.String getInfo(java.lang.String key)

getInfo

java.lang.String getInfo(Hit.InfoKey key)

getInfo

java.lang.String getInfo(java.lang.String key,
                         java.lang.String defaultValue)

getInfo

java.lang.String getInfo(Hit.InfoKey key,
                         java.lang.String defaultValue)

getMetas

java.util.Collection<Meta> getMetas()

Get all meta for this search result.

getMeta

Meta getMeta(java.lang.String name)

Get a meta by its name.

getCategoryGroups

java.util.Collection<CategoryGroup> getCategoryGroups()

Get all facets for this search result. The categories contained in these groups can used as refinements for the navigation.

getCategoryGroup

CategoryGroup getCategoryGroup(java.lang.String id)

Get a facet for this search result, by its id. The categories contained in this group can used as refinements for the navigation.