Package io.jmix.search.searching.impl

Class SearchResultImpl

java.lang.Object

io.jmix.search.searching.impl.SearchResultImpl

All Implemented Interfaces:

SearchResult

public class SearchResultImpl
extends Object
implements SearchResult

Field Summary

Fields

Modifier and Type	Field	Description
protected final Collection<SearchResultEntry>	allEntries
protected int	effectiveOffset
protected final Map<String,Collection<SearchResultEntry>>	entriesByEntityName
protected boolean	moreDataAvailable
protected SearchContext	searchContext
protected SearchStrategy	searchStrategy
protected int	size
protected long	totalHits

Constructor Summary

Constructors

Constructor	Description
SearchResultImpl(SearchContext searchContext, SearchStrategy searchStrategy)

Method Summary

Modifier and Type	Method	Description
void	addEntry(SearchResultEntry searchResultEntry)
SearchContext	createNextPageSearchContext()	Creates new SearchContext based on current one and describes next-page search
Collection<SearchResultEntry>	getAllEntries()	Gets all SearchResultEntry
int	getEffectiveOffset()	Gets search offset currently applied to load content of this SearchResult including post-load security filtration
Collection<String>	getEntityNames()	Gets names of all entities presented in this SearchResult.
Collection<SearchResultEntry>	getEntriesByEntityName(String entityName)	Gets all SearchResultEntry specific for provided entity.
SearchContext	getSearchContext()	Gets SearchContext that was used to gain this SearchResult.
SearchStrategy	getSearchStrategy()	Gets SearchStrategy that was used to gain this SearchResult.
String	getSearchText()	Gets text search has been performed with.
int	getSize()	Gets amount of objects in this SearchResult
long	getTotalHits()	Gets total amount of hits in this SearchResult.
void	incrementOffset()
boolean	isEmpty()	Checks if there is any data in result.
boolean	isMoreDataAvailable()	Checks if there are more objects suitable for next-page search.
void	setMoreDataAvailable(boolean moreDataAvailable)
void	setTotalHits(long totalHits)	Sets the total number of hits for this SearchResult.

Methods inherited from class java.lang.Object

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

Field Details

searchContext

protected SearchContext searchContext

entriesByEntityName

protected final Map<String,Collection<SearchResultEntry>> entriesByEntityName

allEntries

protected final Collection<SearchResultEntry> allEntries

size

protected int size

totalHits

protected long totalHits

effectiveOffset

protected int effectiveOffset

moreDataAvailable

protected boolean moreDataAvailable

searchStrategy

protected SearchStrategy searchStrategy

Constructor Details

SearchResultImpl

public SearchResultImpl(SearchContext searchContext,
 SearchStrategy searchStrategy)

Method Details

addEntry

public void addEntry(SearchResultEntry searchResultEntry)

getEntriesByEntityName

public Collection<SearchResultEntry> getEntriesByEntityName(String entityName)

Description copied from interface: SearchResult

Gets all SearchResultEntry specific for provided entity.

Specified by:

getEntriesByEntityName in interface SearchResult

Parameters:

entityName - entity name

Returns:

collection of SearchResultEntry

getAllEntries

public Collection<SearchResultEntry> getAllEntries()

Description copied from interface: SearchResult

Gets all SearchResultEntry

Specified by:

getAllEntries in interface SearchResult

Returns:

collection of SearchResultEntry

isEmpty

public boolean isEmpty()

Description copied from interface: SearchResult

Checks if there is any data in result.

Specified by:

isEmpty in interface SearchResult

Returns:

true if this SearchResult contains any SearchResultEntry, false otherwise

getEntityNames

public Collection<String> getEntityNames()

Description copied from interface: SearchResult

Gets names of all entities presented in this SearchResult.

Specified by:

getEntityNames in interface SearchResult

Returns:

collection of entity names

getSearchText

public String getSearchText()

Description copied from interface: SearchResult

Gets text search has been performed with.

Specified by:

getSearchText in interface SearchResult

Returns:

search text

getSize

public int getSize()

Description copied from interface: SearchResult

Gets amount of objects in this SearchResult

Specified by:

getSize in interface SearchResult

Returns:

amount of objects

getTotalHits

public long getTotalHits()

Description copied from interface: SearchResult

Gets total amount of hits in this SearchResult.

Specified by:

getTotalHits in interface SearchResult

Returns:

total hits

setTotalHits

public void setTotalHits(long totalHits)

Description copied from interface: SearchResult

Sets the total number of hits for this SearchResult.

Specified by:

setTotalHits in interface SearchResult

Parameters:

totalHits - the total number of hits to be set.

getEffectiveOffset

public int getEffectiveOffset()

Description copied from interface: SearchResult

Gets search offset currently applied to load content of this SearchResult including post-load security filtration

Use this offset to perform next-page search.

Specified by:

getEffectiveOffset in interface SearchResult

Returns:

effective offset

incrementOffset

public void incrementOffset()

getSearchContext

public SearchContext getSearchContext()

Description copied from interface: SearchResult

Gets SearchContext that was used to gain this SearchResult.

Specified by:

getSearchContext in interface SearchResult

Returns:

SearchContext

isMoreDataAvailable

public boolean isMoreDataAvailable()

Description copied from interface: SearchResult

Checks if there are more objects suitable for next-page search.

Specified by:

isMoreDataAvailable in interface SearchResult

Returns:

true if index contains more suitable data, false otherwise

getSearchStrategy

public SearchStrategy getSearchStrategy()

Description copied from interface: SearchResult

Gets SearchStrategy that was used to gain this SearchResult.

Specified by:

getSearchStrategy in interface SearchResult

Returns:

SearchStrategy

createNextPageSearchContext

public SearchContext createNextPageSearchContext()

Description copied from interface: SearchResult

Creates new SearchContext based on current one and describes next-page search

Specified by:

createNextPageSearchContext in interface SearchResult

Returns:

SearchContext

setMoreDataAvailable

public void setMoreDataAvailable(boolean moreDataAvailable)