com.atlassian.confluence.search.v2.elasticsearch

Class ESSearchResult

java.lang.Object

com.atlassian.confluence.search.v2.AbstractSearchResult

com.atlassian.confluence.search.v2.elasticsearch.ESSearchResult

All Implemented Interfaces:

BaseSearchResult, SearchResult

@ParametersAreNonnullByDefault
public class ESSearchResult
extends AbstractSearchResult

Since:

5.10

Field Summary

Fields inherited from interface com.atlassian.confluence.search.v2.SearchResult

HIGHLIGHT_END, HIGHLIGHT_START

Constructor Summary

Constructors

Constructor and Description
ESSearchResult(com.google.common.base.Function<String,ConfluenceUser> userLookup, Map<String,Object> sourceDoc)
ESSearchResult(com.google.common.base.Function<String,ConfluenceUser> userLookup, Map<String,Object> sourceDoc, Map<String,String> highlight, Optional<String> explain)

Method Summary

Modifier and Type	Method and Description
String	getDisplayTitleWithHighlights() Gets the title of the search result appropriate for displaying to a user with matches highlighted.
Optional<String>	getExplain() Returns query explanation if it is requested see ISearch.isExplain().
String	getFieldValue(String fieldName) Return a string value of a field of a given document, if the field has multiple values then return last value, if there is no such field then return null.
Set<String>	getFieldValues(String fieldName) Return set of string values of a field of a given document, if the field has single value then return singleton set of that value, if there is no such field then return empty set.
String	getResultExcerptWithHighlights() Gets excerpt from the context of the search result, as SearchResult.getResultExcerpt(), but in a HTML-safe manner.
boolean	isFieldRequested(String fieldName) Deprecated.

Methods inherited from class com.atlassian.confluence.search.v2.AbstractSearchResult

getContent, getContentVersion, getCreationDate, getCreator, getCreatorUser, getDateResult, getDisplayTitle, getExtraFields, getField, getHandle, getIntegerResult, getLabels, getLastModificationDate, getLastModifier, getLastModifierUser, getLastUpdateDescription, getOwnerTitle, getOwnerType, getPersonalLabels, getResultExcerpt, getResultExcerpt, getSanitisedContent, getSpaceKey, getSpaceName, getStringResult, getType, getUrlPath, getUserResult, hasLabels, isHomePage, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ESSearchResult

public ESSearchResult(com.google.common.base.Function<String,ConfluenceUser> userLookup,
                      Map<String,Object> sourceDoc)

ESSearchResult

public ESSearchResult(com.google.common.base.Function<String,ConfluenceUser> userLookup,
                      Map<String,Object> sourceDoc,
                      Map<String,String> highlight,
                      Optional<String> explain)

Method Detail

getFieldValue

public String getFieldValue(String fieldName)

Description copied from class: AbstractSearchResult

Return a string value of a field of a given document, if the field has multiple values then return last value, if there is no such field then return null.

Specified by:

getFieldValue in class AbstractSearchResult

Returns:

a string value of a field

getFieldValues

public Set<String> getFieldValues(String fieldName)

Description copied from class: AbstractSearchResult

Return set of string values of a field of a given document, if the field has single value then return singleton set of that value, if there is no such field then return empty set.

Specified by:

getFieldValues in interface BaseSearchResult

Specified by:

getFieldValues in class AbstractSearchResult

Returns:

a string value of a field

getResultExcerptWithHighlights

public String getResultExcerptWithHighlights()

Description copied from interface: SearchResult

Gets excerpt from the context of the search result, as SearchResult.getResultExcerpt(), but in a HTML-safe manner. Implementations should highlight hits with SearchResult.HIGHLIGHT_START and SearchResult.HIGHLIGHT_END. The default implementation simply HTML-encode the result of SearchResult.getResultExcerpt().

Returns:

excerpt of the content of the search result with matches highlighted

getDisplayTitleWithHighlights

public String getDisplayTitleWithHighlights()

Description copied from interface: SearchResult

Gets the title of the search result appropriate for displaying to a user with matches highlighted. All results should return something useful for this method.

Returns:

the title of the search result appropriate for display on a page with matches highlighted

isFieldRequested

@Deprecated
public boolean isFieldRequested(String fieldName)

Deprecated.

check to see if this SearchFieldName has been requested during the search, if this method returns false then getField will throw a FieldNotRequestedException

Returns:

getExplain

public Optional<String> getExplain()

Description copied from interface: SearchResult

Returns query explanation if it is requested see ISearch.isExplain().