org.apache.spark.ui

Interface PagedTable<T>

public interface PagedTable<T>

A paged table that will generate a HTML table for a specified page and also the page navigation.

Method Summary

Modifier and Type	Method and Description
org.apache.spark.ui.PagedDataSource<T>	dataSource()
String	getParameterOtherTable(javax.servlet.http.HttpServletRequest request, String tableTag) Returns parameters of other tables in the page.
scala.Tuple3<String,Object,Object>	getTableParameters(javax.servlet.http.HttpServletRequest request, String tableTag, String defaultSortColumn) Returns parameter of this table.
String	goButtonFormPath() Returns the submission path for the "go to page #" form.
scala.collection.Seq<scala.xml.Node>	headerRow(scala.collection.Seq<scala.Tuple3<String,Object,scala.Option<String>>> headerInfo, boolean desc, int pageSize, String sortColumn, String parameterPath, String tableTag, String headerId)
scala.collection.Seq<scala.xml.Node>	headers()
void	isSortColumnValid(scala.collection.Seq<scala.Tuple3<String,Object,scala.Option<String>>> headerInfo, String sortColumn) Check if given sort column is valid or not.
String	pageLink(int page) Return a link to jump to a page.
scala.collection.Seq<scala.xml.Node>	pageNavigation(int page, int pageSize, int totalPages, String navigationId) Return a page navigation.
String	pageNumberFormField()
String	pageSizeFormField()
scala.collection.Seq<scala.xml.Node>	row(T t)
scala.collection.Seq<scala.xml.Node>	table(int page)
String	tableCssClass()
String	tableId()

Method Detail

dataSource

org.apache.spark.ui.PagedDataSource<T> dataSource()

getParameterOtherTable

String getParameterOtherTable(javax.servlet.http.HttpServletRequest request,
                              String tableTag)

Returns parameters of other tables in the page.

Parameters:

request - (undocumented)

tableTag - (undocumented)

Returns:

(undocumented)

getTableParameters

scala.Tuple3<String,Object,Object> getTableParameters(javax.servlet.http.HttpServletRequest request,
                                                      String tableTag,
                                                      String defaultSortColumn)

Returns parameter of this table.

Parameters:

request - (undocumented)

tableTag - (undocumented)

defaultSortColumn - (undocumented)

Returns:

(undocumented)

goButtonFormPath

String goButtonFormPath()

Returns the submission path for the "go to page #" form.

Returns:

(undocumented)

headerRow

scala.collection.Seq<scala.xml.Node> headerRow(scala.collection.Seq<scala.Tuple3<String,Object,scala.Option<String>>> headerInfo,
                                               boolean desc,
                                               int pageSize,
                                               String sortColumn,
                                               String parameterPath,
                                               String tableTag,
                                               String headerId)

headers

scala.collection.Seq<scala.xml.Node> headers()

isSortColumnValid

void isSortColumnValid(scala.collection.Seq<scala.Tuple3<String,Object,scala.Option<String>>> headerInfo,
                       String sortColumn)

Check if given sort column is valid or not. If invalid then an exception is thrown.

Parameters:

headerInfo - (undocumented)

sortColumn - (undocumented)

pageLink

String pageLink(int page)

Return a link to jump to a page.

Parameters:

page - (undocumented)

Returns:

(undocumented)

pageNavigation

scala.collection.Seq<scala.xml.Node> pageNavigation(int page,
                                                    int pageSize,
                                                    int totalPages,
                                                    String navigationId)

Return a page navigation.

It will create a page navigation including a group of page numbers and a form to submit the page number.

Here are some examples of the page navigation:

 << < 11 12 13* 14 15 16 17 18 19 20 > >>

 This is the first group, so "<<" is hidden.
 < 1 2* 3 4 5 6 7 8 9 10 > >>

 This is the first group and the first page, so "<<" and "<" are hidden.
 1* 2 3 4 5 6 7 8 9 10 > >>

 Assume totalPages is 19. This is the last group, so ">>" is hidden.
 << < 11 12 13* 14 15 16 17 18 19 >

 Assume totalPages is 19. This is the last group and the last page, so ">>" and ">" are hidden.
 << < 11 12 13 14 15 16 17 18 19*

 * means the current page number
 << means jumping to the first page of the previous group.
 < means jumping to the previous page.
 >> means jumping to the first page of the next group.
 > means jumping to the next page.
 

Parameters:

page - (undocumented)

pageSize - (undocumented)

totalPages - (undocumented)

navigationId - (undocumented)

Returns:

(undocumented)

pageNumberFormField

String pageNumberFormField()

pageSizeFormField

String pageSizeFormField()

row

scala.collection.Seq<scala.xml.Node> row(T t)

table

scala.collection.Seq<scala.xml.Node> table(int page)

tableCssClass

String tableCssClass()

tableId

String tableId()