Page (SIRIUS web 19.0-rc8 API)

java.lang.Object
- sirius.web.controller.Page<E>

Type Parameters:

E - the type of object in the page
```
public class Page<E>
extends Object
```
Represents a slice of a result set which is being "paged through" and can provide filter facets.

Constructor Summary

Constructors
Constructor and Description

Page()

Constructors
Constructor and Description
`Page()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Page<E>`	`addFacet(Facet facet)` Adds a filter facet to this result page.
`Facet`	`addFacet(String field, String title, sirius.kernel.cache.ValueComputer<String,String> translator)` Adds a filter facet with the given name, title and translator.
`Page<E>`	`bindToRequest(WebContext ctx)` Binds the page to the request.
`String`	`createNextPageQueryString()` Creates a query string containing all filters, the search query and a `start` parameter selecting the next page.
`String`	`createPrevPageQueryString()` Creates a query string containing all filters, the search query and a `start` parameter selecting the previous page.
`String`	`createQueryString()` Creates a query string containing all filters and the search query and a `start` parameter selecting the current page.
`String`	`createQueryString(String field, String value, boolean resetStart)` Creates a query string containing all filters and the search query along with a given custom field.
`String`	`createQueryStringForConfigurableStart()` Creates an incomplete query string to be completed by appending the start index.
`int`	`getCurrentPageNumber()` Calculates the current page number
`String`	`getDuration()` Returns the search duration.
`int`	`getEnd()` Returns the absolute index (1 based) of the last item on this page.
`List<Facet>`	`getFacets()` Returns all filter facets available.
`List<E>`	`getItems()` Returns the items on this page.
`int`	`getNextStart()` Returns the index of the next page.
`int`	`getPageSize()` Returns the total page size.
`int`	`getPreviousStart()` Returns the index of the previous page.
`String`	`getQuery()` Returns the query string which was used to create the result set.
`String`	`getRange()` Returns a string representation naming the first and last index contained on this page.
`int`	`getStart()` Returns the absolute index (1 based) of the first item on this page.
`int`	`getTotal()` Returns the total number of items (if known).
`boolean`	`hasFacets()` Determines if there is at least one filter facet with filter items.
`boolean`	`hasLess()` Determines if there is a previous page.
`boolean`	`hasMore()` Determines if there is a next page.
`Page<E>`	`withDuration(String duration)` Specifies the duration (as string) it took to compute (query) the page items.
`Page<E>`	`withFactes(List<Facet> facets)` Specifies the facets available to further filter the page (or underlying data source).
`Page<E>`	`withFactesSupplier(Supplier<List<Facet>> facetsSupplier)` Specifies the supplier used to compute the facets available to further filter the page (or underlying data source).
`Page<E>`	`withHasMore(boolean more)` Specifies the flag which indicates if "more" items are available.
`Page<E>`	`withItems(List<E> items)` Specifies the effective items this page contains.
`Page<E>`	`withLimitedItemsSupplier(Function<sirius.kernel.commons.Limit,List<E>> itemsSupplier)` Easy method for supplying items the page contains to avoid boiler code.
`Page<E>`	`withPageSize(int pageSize)` Specifies the number of items shown per page.
`Page<E>`	`withQuery(String query)` Specifies the query used to compute the result list.
`Page<E>`	`withStart(int start)` Specifies the index of the first item.
`Page<E>`	`withTotalItems(int total)` Specifies the number of total items.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Page
```
public Page()
```
- Method Detail
  - withQuery
```
public Page<E> withQuery(String query)
```
    Specifies the query used to compute the result list.
    
    Parameters:
    
    query - the query string which was used to create the result set
    
    Returns:
    
    the page itself for fluent method calls
  - withStart
```
public Page<E> withStart(int start)
```
    Specifies the index of the first item.
    
    Parameters:
    
    start - the index of the first item shown on this page (relative to the overall list).
    
    Returns:
    
    the page itself for fluent method calls
  - withItems
```
public Page<E> withItems(List<E> items)
```
    Specifies the effective items this page contains.
    
    Parameters:
    
    items - the items contained in the page.
    
    Returns:
    
    the page itself for fluent method calls
  - withLimitedItemsSupplier
```
public Page<E> withLimitedItemsSupplier(Function<sirius.kernel.commons.Limit,List<E>> itemsSupplier)
```
    Easy method for supplying items the page contains to avoid boiler code.
    The supplier provides the Limit of the current page for easy iteration over a result set.
    This method should be supplied with a List which size was determined by the supplied Limit as this method does also is able to determine whether this page has more items to show which are currently not being displayed.
    Using the supplied limit e.g. via Limit.asPredicate() for slicing the provided list results in a list of size pageSize + 1 for easier handling whether there are more elements to determine if there is another page.
    
    Parameters:
    
    itemsSupplier - the supplier to supply items to the current page limited by the provided limit
    
    Returns:
    
    the page itself for fluent method calls
  - withDuration
```
public Page<E> withDuration(String duration)
```
    Specifies the duration (as string) it took to compute (query) the page items.
    
    Parameters:
    
    duration - the duration required to compute the page items.
    
    Returns:
    
    the page itself for fluent method calls
  - withFactes
```
public Page<E> withFactes(List<Facet> facets)
```
    Specifies the facets available to further filter the page (or underlying data source).
    
    Parameters:
    
    facets - the facets available for further filtering
    
    Returns:
    
    the page itself for fluent method calls
  - addFacet
```
public Facet addFacet(String field,
                      String title,
                      @Nullable
                      sirius.kernel.cache.ValueComputer<String,String> translator)
```
    Adds a filter facet with the given name, title and translator.
    
    Parameters:
    
    field - the name of the field being filtered
    
    title - the title of the filter shown to the user
    
    translator - the trnanslater used to convert filter values to visual representations for the user
    
    Returns:
    
    a newly created facet
  - addFacet
```
public Page<E> addFacet(Facet facet)
```
    Adds a filter facet to this result page.
    
    Parameters:
    
    facet - the facet to add
    
    Returns:
    
    the page itself for fluent method calls
  - getCurrentPageNumber
```
public int getCurrentPageNumber()
```
    Calculates the current page number
    
    Returns:
    
    number of the current page
  - bindToRequest
```
public Page<E> bindToRequest(WebContext ctx)
```
    Binds the page to the request.
    This will read start, query and all facet values from the given request.
    
    Parameters:
    
    ctx - the request to parse
    
    Returns:
    
    the page itself for fluent method calls
  - withFactesSupplier
```
public Page<E> withFactesSupplier(Supplier<List<Facet>> facetsSupplier)
```
    Specifies the supplier used to compute the facets available to further filter the page (or underlying data source).
    
    Parameters:
    
    facetsSupplier - the facets supplier computing the facets available for further filtering
    
    Returns:
    
    the page itself for fluent method calls
  - withHasMore
```
public Page<E> withHasMore(boolean more)
```
    Specifies the flag which indicates if "more" items are available.
    
    Parameters:
    
    more - indicates if more items are available or not.
    
    Returns:
    
    the page itself for fluent method calls
  - withPageSize
```
public Page<E> withPageSize(int pageSize)
```
    Specifies the number of items shown per page.
    
    Parameters:
    
    pageSize - the number of items shown per page
    
    Returns:
    
    the page itself for fluent method calls
  - withTotalItems
```
public Page<E> withTotalItems(int total)
```
    Specifies the number of total items.
    
    Parameters:
    
    total - the number of items in the data source (applying the current filters)
    
    Returns:
    
    the page itself for fluent method calls
  - getQuery
```
public String getQuery()
```
    Returns the query string which was used to create the result set.
    
    Returns:
    
    the query string which was used to create the result set
  - getStart
```
public int getStart()
```
    Returns the absolute index (1 based) of the first item on this page.
    
    Returns:
    
    the one based index of the first item on this page
  - getEnd
```
public int getEnd()
```
    Returns the absolute index (1 based) of the last item on this page.
    
    Returns:
    
    the one based index of the last item on this page
  - getItems
```
public List<E> getItems()
```
    Returns the items on this page.
    
    Returns:
    
    the list of items on this page
  - getPreviousStart
```
public int getPreviousStart()
```
    Returns the index of the previous page.
    
    Returns:
    
    the index of the first item of the previous page
  - getNextStart
```
public int getNextStart()
```
    Returns the index of the next page.
    
    Returns:
    
    the index of the first item of the next page
  - hasLess
```
public boolean hasLess()
```
    Determines if there is a previous page.
    
    Returns:
    
    true if there is a page before this one
  - hasMore
```
public boolean hasMore()
```
    Determines if there is a next page.
    
    Returns:
    
    true if there are more items in the underlying result
  - getTotal
```
public int getTotal()
```
    Returns the total number of items (if known).
    
    Returns:
    
    the total number of items
  - getRange
```
public String getRange()
```
    Returns a string representation naming the first and last index contained on this page.
    
    Returns:
    
    a string naming the first and last index of this page
  - getDuration
```
public String getDuration()
```
    Returns the search duration.
    
    Returns:
    
    a string representation of the search duration used to create the underlying result set
  - createPrevPageQueryString
```
public String createPrevPageQueryString()
```
    Creates a query string containing all filters, the search query and a start parameter selecting the previous page.
    
    Returns:
    
    a query string selecting the previous page
  - createNextPageQueryString
```
public String createNextPageQueryString()
```
    Creates a query string containing all filters, the search query and a start parameter selecting the next page.
    
    Returns:
    
    a query string selecting the next page
  - createQueryString
```
public String createQueryString()
```
    Creates a query string containing all filters and the search query and a start parameter selecting the current page.
    
    Returns:
    
    a query string selecting the current page
  - createQueryString
```
public String createQueryString(String field,
                                String value,
                                boolean resetStart)
```
    Creates a query string containing all filters and the search query along with a given custom field.
    
    Parameters:
    
    field - the additional field to set
    
    value - the value of the field to set
    
    resetStart - determines if the start value should be kept (false) or reset to 1 (true)
    
    Returns:
    
    a query string containing all filters, the query and the given parameter
  - createQueryStringForConfigurableStart
```
public String createQueryStringForConfigurableStart()
```
    Creates an incomplete query string to be completed by appending the start index. The Query String will contain all filters and the search query except 'start', for which the value must be appended.
    ex.:
```
 var startIndex = "33";
 $('a.config-start').attr("href", "@prefix/@baseURL?@page.createQueryStringForConfigurableStart()" + startIndex);
 
```
    Returns:
    
    a query string missing the start value
  - getFacets
```
public List<Facet> getFacets()
```
    Returns all filter facets available.
    
    Returns:
    
    all filter facets of the underlying result set
  - hasFacets
```
public boolean hasFacets()
```
    Determines if there is at least one filter facet with filter items.
    
    Returns:
    
    true if there is at least one filter facet with items
  - getPageSize
```
public int getPageSize()
```
    Returns the total page size.
    This not the number of items in the page but rather the general paging size currently being used.
    
    Returns:
    
    the max number of items in a page
    
    See Also:
    
    DEFAULT_PAGE_SIZE

Class Page<E>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Page

Method Detail

withQuery

withStart

withItems

withLimitedItemsSupplier

withDuration

withFactes

addFacet

addFacet

getCurrentPageNumber

bindToRequest

withFactesSupplier

withHasMore

withPageSize

withTotalItems

getQuery

getStart

getEnd

getItems

getPreviousStart

getNextStart

hasLess

hasMore

getTotal

getRange

getDuration

createPrevPageQueryString

createNextPageQueryString

createQueryString

createQueryString

createQueryStringForConfigurableStart

getFacets

hasFacets

getPageSize