Package org.exoplatform.documents.legacy.search.data

Class SearchResult

java.lang.Object

org.exoplatform.documents.legacy.search.data.SearchResult

Direct Known Subclasses:

DocumentFileSearchResult

@Deprecated(forRemoval=true,
            since="6.0.0")
public class SearchResult
extends Object

Deprecated, for removal: This API element is subject to removal in a future version.

Copied from commons-search to this module. Should be reworked to be more simple.

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)	Deprecated, for removal: This API element is subject to removal in a future version. 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)	Deprecated, for removal: This API element is subject to removal in a future version. 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)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
long	getDate()	Deprecated, for removal: This API element is subject to removal in a future version. Get date of result
String	getDetail()	Deprecated, for removal: This API element is subject to removal in a future version. Get detail of result
String	getExcerpt()	Deprecated, for removal: This API element is subject to removal in a future version. Get excerpt of result
Map<String,List<String>>	getExcerpts()	Deprecated, for removal: This API element is subject to removal in a future version.
String	getImageUrl()	Deprecated, for removal: This API element is subject to removal in a future version. Get image url of avatar
String	getPreviewUrl()	Deprecated, for removal: This API element is subject to removal in a future version. Get preview url of result
long	getRelevancy()	Deprecated, for removal: This API element is subject to removal in a future version. Get relevancy of result
String	getTitle()	Deprecated, for removal: This API element is subject to removal in a future version. Get title of result
String	getUrl()	Deprecated, for removal: This API element is subject to removal in a future version. Get url of result
void	setDate(long date)	Deprecated, for removal: This API element is subject to removal in a future version. Set data for result
void	setDetail(String detail)	Deprecated, for removal: This API element is subject to removal in a future version. Set detail for result
void	setExcerpt(String excerpt)	Deprecated, for removal: This API element is subject to removal in a future version. Set excerpt for result
void	setExcerpts(Map<String,List<String>> excerpts)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setImageUrl(String imageUrl)	Deprecated, for removal: This API element is subject to removal in a future version. Set image url for avatar
void	setPreviewUrl(String previewUrl)	Deprecated, for removal: This API element is subject to removal in a future version. Set preview url for result
void	setRelevancy(long relevancy)	Deprecated, for removal: This API element is subject to removal in a future version. Set relevancy
void	setTitle(String title)	Deprecated, for removal: This API element is subject to removal in a future version. Set title for result
void	setUrl(String url)	Deprecated, for removal: This API element is subject to removal in a future version. Set url for result
String	toString()	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class java.lang.Object

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

Constructor Details

SearchResult

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

Deprecated, for removal: This API element is subject to removal in a future version.

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)

Deprecated, for removal: This API element is subject to removal in a future version.

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)

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

getExcerpts

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

Deprecated, for removal: This API element is subject to removal in a future version.

setExcerpts

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

Deprecated, for removal: This API element is subject to removal in a future version.

getUrl

public String getUrl()

Deprecated, for removal: This API element is subject to removal in a future version.

Get url of result

Returns:

String

eXo level API

Experimental

setUrl

public void setUrl(String url)

Deprecated, for removal: This API element is subject to removal in a future version.

Set url for result

Parameters:

url -

eXo level API

Experimental

getPreviewUrl

public String getPreviewUrl()

Deprecated, for removal: This API element is subject to removal in a future version.

Get preview url of result

Returns:

String

eXo level API

Experimental

setPreviewUrl

public void setPreviewUrl(String previewUrl)

Deprecated, for removal: This API element is subject to removal in a future version.

Set preview url for result

Parameters:

previewUrl -

eXo level API

Experimental

getTitle

public String getTitle()

Deprecated, for removal: This API element is subject to removal in a future version.

Get title of result

Returns:

String

eXo level API

Experimental

setTitle

public void setTitle(String title)

Deprecated, for removal: This API element is subject to removal in a future version.

Set title for result

Parameters:

title -

eXo level API

Experimental

getExcerpt

public String getExcerpt()

Deprecated, for removal: This API element is subject to removal in a future version.

Get excerpt of result

Returns:

String

eXo level API

Experimental

setExcerpt

public void setExcerpt(String excerpt)

Deprecated, for removal: This API element is subject to removal in a future version.

Set excerpt for result

Parameters:

excerpt -

eXo level API

Experimental

getDetail

public String getDetail()

Deprecated, for removal: This API element is subject to removal in a future version.

Get detail of result

Returns:

String

eXo level API

Experimental

setDetail

public void setDetail(String detail)

Deprecated, for removal: This API element is subject to removal in a future version.

Set detail for result

Parameters:

detail -

eXo level API

Experimental

getImageUrl

public String getImageUrl()

Deprecated, for removal: This API element is subject to removal in a future version.

Get image url of avatar

Returns:

String

eXo level API

Experimental

setImageUrl

public void setImageUrl(String imageUrl)

Deprecated, for removal: This API element is subject to removal in a future version.

Set image url for avatar

Parameters:

imageUrl -

eXo level API

Experimental

getDate

public long getDate()

Deprecated, for removal: This API element is subject to removal in a future version.

Get date of result

Returns:

Long

eXo level API

Experimental

setDate

public void setDate(long date)

Deprecated, for removal: This API element is subject to removal in a future version.

Set data for result

Parameters:

date -

eXo level API

Experimental

getRelevancy

public long getRelevancy()

Deprecated, for removal: This API element is subject to removal in a future version.

Get relevancy of result

Returns:

Long

eXo level API

Experimental

setRelevancy

public void setRelevancy(long relevancy)

Deprecated, for removal: This API element is subject to removal in a future version.

Set relevancy

Parameters:

relevancy -

eXo level API

Experimental

toString

public String toString()

Deprecated, for removal: This API element is subject to removal in a future version.

Overrides:

toString in class Object