Package org.opencms.search.galleries
Class CmsGallerySearchResultList
- java.lang.Object
-
- java.util.AbstractCollection<E>
-
- java.util.AbstractList<E>
-
- java.util.ArrayList<CmsGallerySearchResult>
-
- org.opencms.search.galleries.CmsGallerySearchResultList
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,java.lang.Iterable<CmsGallerySearchResult>
,java.util.Collection<CmsGallerySearchResult>
,java.util.List<CmsGallerySearchResult>
,java.util.RandomAccess
public class CmsGallerySearchResultList extends java.util.ArrayList<CmsGallerySearchResult>
The search result list for the gallery search index.- Since:
- 8.0.0
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description CmsGallerySearchResultList()
Creates a new result list with a default initial capacity of 100.CmsGallerySearchResultList(int initialCapacity)
Creates a new result list with the specified initial capacity.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
append(CmsGallerySearchResultList moreResults)
Appends the results from another search result list.void
calculatePages(int pageIndex, int matchesPerPage)
Calculates the result pages.int
getHitCount()
Returns the hit count of all results found in the last search.int
getPageCount()
Returns the total number of search result pages.int
getResultPage()
Returns the index of the current result page.void
setHitCount(int hitCount)
Sets the hit count of all results found in the last search.-
Methods inherited from class java.util.ArrayList
add, add, addAll, addAll, clear, clone, contains, ensureCapacity, equals, forEach, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize
-
-
-
-
Constructor Detail
-
CmsGallerySearchResultList
public CmsGallerySearchResultList()
Creates a new result list with a default initial capacity of 100.
-
CmsGallerySearchResultList
public CmsGallerySearchResultList(int initialCapacity)
Creates a new result list with the specified initial capacity.- Parameters:
initialCapacity
- the initial capacity
-
-
Method Detail
-
append
public void append(CmsGallerySearchResultList moreResults)
Appends the results from another search result list.- Parameters:
moreResults
- the second search result list
-
getHitCount
public int getHitCount()
Returns the hit count of all results found in the last search.Since this list will only contain the result objects for the current display page, the size of the list is usually much less then the hit count of all results found.
- Returns:
- the hit count of all results found in the last search
-
getPageCount
public int getPageCount()
Returns the total number of search result pages.- Returns:
- the total number of search result pages
- See Also:
getHitCount()
,getResultPage()
-
getResultPage
public int getResultPage()
Returns the index of the current result page.- Returns:
- the index of the current result page
- See Also:
getHitCount()
,getPageCount()
-
setHitCount
public void setHitCount(int hitCount)
Sets the hit count of all results found in the last search.Since this list will only contain the result objects for the current display page, the size of the list is usually much less then the hit count of all results found.
- Parameters:
hitCount
- the hit count to set
-
calculatePages
public void calculatePages(int pageIndex, int matchesPerPage)
Calculates the result pages.- Parameters:
pageIndex
- the index of the current pagematchesPerPage
- the matches per page
-
-