Package com.atlassian.jira.search.opensearch

Class OpenSearchDocument

java.lang.Object

com.atlassian.jira.search.opensearch.OpenSearchDocument

All Implemented Interfaces:

Document

public class OpenSearchDocument
extends Object
implements Document

A Document implementation that is backed by an OpenSearch hit.

Since:

10.4

Constructor Summary

Constructors

Constructor	Description
OpenSearchDocument(org.opensearch.client.opensearch.core.search.Hit<Void> hit)

Method Summary

Modifier and Type	Method	Description
Optional<Date>	getDate(String fieldName)	Retrieves a date (date and time, support for time-zone).
List<Date>	getDates(String fieldName)	Retrieves dates (date and time, support for time-zone).
Collection<String>	getFieldNames()
org.opensearch.client.opensearch.core.search.Hit<Void>	getHit()
String	getId()
Optional<LocalDate>	getLocalDate(String fieldName)	Retrieves a local date (date only, time-zone independent)
List<LocalDate>	getLocalDates(String fieldName)	Retrieves local dates (date only, time-zone independent)
Optional<Number>	getNumber(String fieldName)
List<Number>	getNumbers(String fieldName)
Optional<String>	getString(String fieldName)
List<String>	getStrings(String fieldName)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.search.Document

get, getValue, getValues

Constructor Details

OpenSearchDocument

public OpenSearchDocument(org.opensearch.client.opensearch.core.search.Hit<Void> hit)

Method Details

getHit

public org.opensearch.client.opensearch.core.search.Hit<Void> getHit()

getId

public String getId()

Specified by:

getId in interface Document

Returns:

the document ID

getFieldNames

public Collection<String> getFieldNames()

Specified by:

getFieldNames in interface Document

getDate

public Optional<Date> getDate(String fieldName)

Description copied from interface: Document

Retrieves a date (date and time, support for time-zone).

Specified by:

getDate in interface Document

Parameters:

fieldName - the name of the field

Returns:

a date

getDates

public List<Date> getDates(String fieldName)

Description copied from interface: Document

Retrieves dates (date and time, support for time-zone).

Specified by:

getDates in interface Document

Parameters:

fieldName - the name of the field

Returns:

dates

getLocalDate

public Optional<LocalDate> getLocalDate(String fieldName)

Description copied from interface: Document

Retrieves a local date (date only, time-zone independent)

Specified by:

getLocalDate in interface Document

Parameters:

fieldName - the name of the field

Returns:

a local date

getLocalDates

public List<LocalDate> getLocalDates(String fieldName)

Description copied from interface: Document

Retrieves local dates (date only, time-zone independent)

Specified by:

getLocalDates in interface Document

Parameters:

fieldName - the name of the field

Returns:

local dates

getString

public Optional<String> getString(String fieldName)

Specified by:

getString in interface Document

getStrings

public List<String> getStrings(String fieldName)

Specified by:

getStrings in interface Document

getNumbers

public List<Number> getNumbers(String fieldName)

Specified by:

getNumbers in interface Document

getNumber

public Optional<Number> getNumber(String fieldName)

Specified by:

getNumber in interface Document

toString

public String toString()

Overrides:

toString in class Object