Package org.exoplatform.commons.api.search.data

Class SearchResult

java.lang.Object

org.exoplatform.commons.api.search.data.SearchResult

public class SearchResult
extends Object

Search result returned by SearchService and all of its connectors, for rendering their search results on UI in a unified format.

eXo level API

Experimental

Constructor Summary

Constructors

Constructor	Description
SearchResult(String url, String title, String excerpt, String detail, String imageUrl, long date, long relevancy)	Constructor that helps to create search result by the unique way
SearchResult(String url, String previewUrl, String title, String excerpt, String detail, String imageUrl, long date, long relevancy)	Constructor that helps to create search result by the unique way (keeping the other constructor without previewUrl for backward compatibility reasons)
SearchResult(String url, String title, Map<String,List<String>> excerpts, String excerpt, String detail, String imageUrl, Long date, long relevancy)

Method Summary

Modifier and Type	Method	Description
long	getDate()	Get date of result
String	getDetail()	Get detail of result
String	getExcerpt()	Get excerpt of result
Map<String,List<String>>	getExcerpts()
String	getImageUrl()	Get image url of avatar
String	getPreviewUrl()	Get preview url of result
long	getRelevancy()	Get relevancy of result
String	getTitle()	Get title of result
String	getUrl()	Get url of result
void	setDate(long date)	Set data for result
void	setDetail(String detail)	Set detail for result
void	setExcerpt(String excerpt)	Set excerpt for result
void	setExcerpts(Map<String,List<String>> excerpts)
void	setImageUrl(String imageUrl)	Set image url for avatar
void	setPreviewUrl(String previewUrl)	Set preview url for result
void	setRelevancy(long relevancy)	Set relevancy
void	setTitle(String title)	Set title for result
void	setUrl(String url)	Set url for result
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchResult

public SearchResult(String url,
                    String title,
                    String excerpt,
                    String detail,
                    String imageUrl,
                    long date,
                    long relevancy)

Constructor that helps to create search result by the unique way

Parameters:

url - Url of this result

title - Title to be displayed on UI

excerpt - The excerpt to be displayed on UI

detail - Details information

imageUrl - An image to be displayed on UI

date - Created or modified date, for sorting on UI

relevancy - The result's relevancy, for sorting on UI

eXo level API

Experimental

SearchResult

public SearchResult(String url,
                    String previewUrl,
                    String title,
                    String excerpt,
                    String detail,
                    String imageUrl,
                    long date,
                    long relevancy)

Constructor that helps to create search result by the unique way (keeping the other constructor without previewUrl for backward compatibility reasons)

Parameters:

url - Url of this result

previewUrl - Preview url of this result

title - Title to be displayed on UI

excerpt - The excerpt to be displayed on UI

detail - Details information

imageUrl - An image to be displayed on UI

date - Created or modified date, for sorting on UI

relevancy - The result's relevancy, for sorting on UI

eXo level API

Experimental

SearchResult

public SearchResult(String url,
                    String title,
                    Map<String,List<String>> excerpts,
                    String excerpt,
                    String detail,
                    String imageUrl,
                    Long date,
                    long relevancy)

Method Detail

getExcerpts

public Map<String,List<String>> getExcerpts()

setExcerpts

public void setExcerpts(Map<String,List<String>> excerpts)

getUrl

public String getUrl()

Get url of result

Returns:

String

eXo level API

Experimental

setUrl

public void setUrl(String url)

Set url for result

Parameters:

url -

eXo level API

Experimental

getPreviewUrl

public String getPreviewUrl()

Get preview url of result

Returns:

String

eXo level API

Experimental

setPreviewUrl

public void setPreviewUrl(String previewUrl)

Set preview url for result

Parameters:

previewUrl -

eXo level API

Experimental

getTitle

public String getTitle()

Get title of result

Returns:

String

eXo level API

Experimental

setTitle

public void setTitle(String title)

Set title for result

Parameters:

title -

eXo level API

Experimental

getExcerpt

public String getExcerpt()

Get excerpt of result

Returns:

String

eXo level API

Experimental

setExcerpt

public void setExcerpt(String excerpt)

Set excerpt for result

Parameters:

excerpt -

eXo level API

Experimental

getDetail

public String getDetail()

Get detail of result

Returns:

String

eXo level API

Experimental

setDetail

public void setDetail(String detail)

Set detail for result

Parameters:

detail -

eXo level API

Experimental

getImageUrl

public String getImageUrl()

Get image url of avatar

Returns:

String

eXo level API

Experimental

setImageUrl

public void setImageUrl(String imageUrl)

Set image url for avatar

Parameters:

imageUrl -

eXo level API

Experimental

getDate

public long getDate()

Get date of result

Returns:

Long

eXo level API

Experimental

setDate

public void setDate(long date)

Set data for result

Parameters:

date -

eXo level API

Experimental

getRelevancy

public long getRelevancy()

Get relevancy of result

Returns:

Long

eXo level API

Experimental

setRelevancy

public void setRelevancy(long relevancy)

Set relevancy

Parameters:

relevancy -

eXo level API

Experimental

toString

public String toString()

Overrides:

toString in class Object