com.jivesoftware.community.user.profile
Class ProfileSearchResult

java.lang.Object
  com.jivesoftware.community.user.profile.ProfileSearchResult

public class ProfileSearchResult
extends Object

Contains the necessary user information to be displayed during a user search.

Constructor Summary

ProfileSearchResult()

ProfileSearchResult(User user, org.apache.lucene.document.Document document, float score, long points)

Method Summary

org.apache.lucene.document.Document	getDocument() Gets the search Document for this user.
long	getPoints() Gets the StatusLevel points for this user.
float	getRelevance() Gets the search relevance for this user, a floating point number between 0.0 and 1.0.
User	getUser() Gets the user that this search result represents.
void	setDocument(org.apache.lucene.document.Document document) Sets the search Document for this user.
void	setPoints(int points) Sets the StatusLevel points for this user.
void	setRelevance(float relevance) Sets the search relevance for this user, a floating point number between 0.0 and 1.0.
void	setUser(User user) Set the user that this search result represents.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProfileSearchResult

public ProfileSearchResult()

ProfileSearchResult

public ProfileSearchResult(User user,
                           org.apache.lucene.document.Document document,
                           float score,
                           long points)

Method Detail

getUser

public User getUser()

Gets the user that this search result represents.

Returns:

the user that this search result represents.

setUser

public void setUser(User user)

Set the user that this search result represents.

Parameters:

user - the user that this search result represents.

getDocument

public org.apache.lucene.document.Document getDocument()

Gets the search Document for this user. This document comes from the user search index and contains user information.

Returns:

the search Document for this user.

setDocument

public void setDocument(org.apache.lucene.document.Document document)

Sets the search Document for this user. This document comes from the user search index and contains user information.

Parameters:

document - the search Document for this user.

getRelevance

public float getRelevance()

Gets the search relevance for this user, a floating point number between 0.0 and 1.0.

Returns:

the search relevance for this user.

setRelevance

public void setRelevance(float relevance)

Sets the search relevance for this user, a floating point number between 0.0 and 1.0.

Parameters:

relevance - the search relevance for this user.

getPoints

public long getPoints()

Gets the StatusLevel points for this user.

Returns:

the StatusLevel points for this user.

setPoints

public void setPoints(int points)

Sets the StatusLevel points for this user.

Parameters:

points - the StatusLevel points for this user.