com.exalead.searchapi.xmlv10.client.results.impl

Class RelatedTermImpl

java.lang.Object

com.exalead.searchapi.xmlv10.client.results.impl.RelatedTermImpl

All Implemented Interfaces:

RelatedTerm, Topic, java.io.Serializable

public class RelatedTermImpl
extends java.lang.Object
implements RelatedTerm, java.io.Serializable

See Also:

Serialized Form

Nested Class Summary

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

Topic.State

Constructor Summary

Constructors

Constructor and Description
RelatedTermImpl()

Method Summary

Modifier and Type	Method and Description
int	getCount() Deprecated.
long	getHitCount() Get the number of hits in the result set that have this topic.
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.
long	getScore() Get the "score" of this topic.
Topic.State	getState() Get the refinement state of this topic in the context of this query.
java.lang.String	getTitle() Get the title of the related term, ie the form to use to display it.
java.lang.String	getZapId() Deprecated.
void	setCount(int count) Deprecated.
void	setHitCount(long value)
void	setId(java.lang.String id)
void	setScore(long score)
void	setState(Topic.State state)
void	setTitle(java.lang.String title)
void	setZapId(java.lang.String zapId)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RelatedTermImpl

public RelatedTermImpl()

Method Detail

getId

public java.lang.String getId()

Description copied from interface: RelatedTerm

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 RelatedTerm

Specified by:

getId in interface Topic

setId

public void setId(java.lang.String id)

getTitle

public java.lang.String getTitle()

Description copied from interface: RelatedTerm

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

Specified by:

getTitle in interface RelatedTerm

Specified by:

getTitle in interface Topic

setTitle

public void setTitle(java.lang.String title)

getInfos

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

Description copied from interface: RelatedTerm

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)

Specified by:

getInfos in interface RelatedTerm

getState

public Topic.State getState()

Description copied from interface: Topic

Get the refinement state of this topic in the context of this query.

Specified by:

getState in interface Topic

setState

public void setState(Topic.State state)

getCount

@Deprecated
public int getCount()

Deprecated.

Specified by:

getCount in interface Topic

See Also:

getHitCount()

getHitCount

public long getHitCount()

Description copied from interface: Topic

Get the number of hits in the result set that have this topic.

Specified by:

getHitCount in interface Topic

setHitCount

public void setHitCount(long value)

setCount

@Deprecated
public void setCount(int count)

Deprecated.

See Also:

setHitCount

getScore

public long getScore()

Description copied from interface: Topic

Get the "score" of this topic. The definition of the "score" of a topic depends on the topic type.

Specified by:

getScore in interface Topic

setScore

public void setScore(long score)

getZapId

@Deprecated
public java.lang.String getZapId()

Deprecated.

Description copied from interface: Topic

Get the id to remove this topic from the refinements and, if possible, to refine on its faster.

Specified by:

getZapId in interface Topic

setZapId

public void setZapId(java.lang.String zapId)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object