com.exalead.searchapi.xmlv10.client

Interface RelatedTerm

All Superinterfaces:

Topic

All Known Implementing Classes:

RelatedTermImpl

public interface RelatedTerm
extends Topic

The RelatedTerm is a component used for the navigation. It represents a term linked with the current query

See Also:

Category

Nested Class Summary

Nested classes/interfaces inherited from interface com.exalead.searchapi.xmlv10.client.Topic

Topic.State

Method Summary

Modifier and Type	Method and Description
java.lang.String	getId() Get the id of the related term.
java.util.Map<java.lang.String,java.lang.String>	getInfos() Get some additional information about this related term.
java.lang.String	getTitle() Get the title of the related term, ie the form to use to display it.

Methods inherited from interface com.exalead.searchapi.xmlv10.client.Topic

getCount, getHitCount, getScore, getState, getZapId

Method Detail

getTitle

java.lang.String getTitle()

Get the title of the related term, ie the form to use to display it.

Specified by:

getTitle in interface Topic

getId

java.lang.String getId()

Get the id of the related term. This is must be used to refine on the related term. To perform an exclusion refinement, it must be prefixed by "-" when using SearchParameter.REFINE). It can be prefixed by "+" for a regular refinement.

Specified by:

getId in interface Topic

getInfos

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

Get some additional information about this related term. The following keys may be available:

• "count", RelatedTerm count (number of occurrences of this related term in the result set)
• "score", RelatedTerm score (sum of the scores of all matching hits)