org.ujorm.tools.web.report

Class ReportBuilder<D>

java.lang.Object

org.ujorm.tools.web.report.ReportBuilder<D>

Direct Known Subclasses:

TableBuilder

public class ReportBuilder<D>
extends Object

A HTML page builder for table based report with an AJAX support.

Usage

  ReportBuilder.of("Hotel Report")
          .add(Hotel::getName, "Hotel", NAME)
          .add(Hotel::getCity, "City", CITY)
          .add(Hotel::getStreet, "Street")
          .build(httpServletRequest, httpServletResponse, resource);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReportBuilder.Url URL constants

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	ajaxEnabled is An AJAX enabled?
protected HttpParameter	ajaxRequestParam AJAX request param
protected boolean	autoSubmmitOnLoad Call an autosubmit on first load
protected ReportBuilderConfig	config Table builder config
protected Injector	footer Print an empty text by default
protected Injector	formAdditions Form injector
protected GridBuilder<D>	gridBuilder Grid builder
protected Injector	header Print a config title by default
protected Injector	htmlHeader Extension is empty by default
protected Supplier<Injector>	javascritWriter Javascript writer

Constructor Summary

Constructors

Constructor and Description
ReportBuilder(HtmlConfig config)
ReportBuilder(CharSequence title)
ReportBuilder(ReportBuilderConfig config)
ReportBuilder(ReportBuilderConfig config, GridBuilder<D> builder)

Method Summary

Modifier and Type	Method and Description
<V> ReportBuilder<D>	add(Function<D,V> column)
<V> ReportBuilder<D>	add(Function<D,V> column, CharSequence title)
<V> ReportBuilder<D>	add(Function<D,V> column, CharSequence title, HttpParameter param)
<V> ReportBuilder<D>	add(Function<D,V> column, Injector title)
<V> ReportBuilder<D>	add(Function<D,V> column, Injector title, HttpParameter param)
ReportBuilder<D>	addColumn(Column<D> column, CharSequence title)
ReportBuilder<D>	addColumn(Column<D> column, Injector title)
ReportBuilder<D>	addOrder(CharSequence title) Add new column for a row counting
void	build(javax.servlet.http.HttpServletRequest input, javax.servlet.http.HttpServletResponse output, Function<GridBuilder<D>,Stream<D>> resource) Build the HTML page including a table
void	build(javax.servlet.http.HttpServletRequest input, javax.servlet.http.HttpServletResponse output, Stream<D> resource) Build the HTML page including a table
protected void	doAjax(javax.servlet.http.HttpServletRequest input, JsonBuilder output, Function<GridBuilder<D>,Stream<D>> resource) Return lighlited text in HTML format according a regular expression
ColumnModel<D,?>	getColumn(int index) Get column model by index
int	getColumnSize() Returns a count of columns
ColumnModel<D,?>	getSortedColumn() Get sorted column or a stub of the sorted column was not found
protected void	printHtmlBody(javax.servlet.http.HttpServletRequest input, HtmlElement html, Function<GridBuilder<D>,Stream<D>> resource)
protected void	printTableBody(Element table, javax.servlet.http.HttpServletRequest input, Function<GridBuilder<D>,Stream<D>> resource)
ReportBuilder<D>	setAjaxEnabled(boolean ajaxEnabled) Enable of disable an AJAX feature, default value si true
ReportBuilder<D>	setAjaxRequestParam(HttpParameter ajaxRequestParam)
ReportBuilder<D>	setEmbeddedIcons(boolean embeddedIcons)
ReportBuilder<D>	setFooter(Injector footer)
ReportBuilder<D>	setFormAdditions(Injector formItem) Deprecated.
ReportBuilder<D>	setFormItem(Injector formItem)
ReportBuilder<D>	setHeader(Injector header)
ReportBuilder<D>	setHtmlHeader(Injector htmlHeader)
ReportBuilder<D>	setJavascritWriter(Supplier<Injector> javascritWriter)
protected void	setSort(ColumnModel sort) Mark a column as sortable
<V> ReportBuilder<D>	sortable() Add a sortable indicator to the last column model
<V> ReportBuilder<D>	sortable(boolean ascending) Add a sortable indicator to the last column model
<V> ReportBuilder<D>	sortable(Direction direction) Add a sortable indicator to the last column model

Methods inherited from class java.lang.Object

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

Field Detail

gridBuilder

@Nonnull
protected final GridBuilder<D> gridBuilder

Grid builder

config

protected final ReportBuilderConfig config

Table builder config

ajaxRequestParam

@Nonnull
protected HttpParameter ajaxRequestParam

AJAX request param

htmlHeader

@Nonnull
protected Injector htmlHeader

Extension is empty by default

header

@Nonnull
protected Injector header

Print a config title by default

footer

@Nonnull
protected Injector footer

Print an empty text by default

formAdditions

@Nonnull
protected Injector formAdditions

Form injector

javascritWriter

@Nonnull
protected Supplier<Injector> javascritWriter

Javascript writer

ajaxEnabled

protected boolean ajaxEnabled

is An AJAX enabled?

autoSubmmitOnLoad

protected boolean autoSubmmitOnLoad

Call an autosubmit on first load

Constructor Detail

ReportBuilder

public ReportBuilder(@Nonnull
                     CharSequence title)

ReportBuilder

public ReportBuilder(@Nonnull
                     HtmlConfig config)

ReportBuilder

public ReportBuilder(@Nonnull
                     ReportBuilderConfig config)

ReportBuilder

public ReportBuilder(@Nonnull
                     ReportBuilderConfig config,
                     @Nonnull
                     GridBuilder<D> builder)

Method Detail

add

@Nonnull
public <V> ReportBuilder<D> add(Function<D,V> column)

add

@Nonnull
public <V> ReportBuilder<D> add(Function<D,V> column,
                                         CharSequence title)

add

@Nonnull
public <V> ReportBuilder<D> add(Function<D,V> column,
                                         Injector title)

add

@Nonnull
public <V> ReportBuilder<D> add(Function<D,V> column,
                                         CharSequence title,
                                         @Nullable
                                         HttpParameter param)

add

@Nonnull
public <V> ReportBuilder<D> add(Function<D,V> column,
                                         Injector title,
                                         @Nullable
                                         HttpParameter param)

addColumn

@Nonnull
public ReportBuilder<D> addColumn(@Nonnull
                                           Column<D> column,
                                           @Nonnull
                                           CharSequence title)

addColumn

@Nonnull
public ReportBuilder<D> addColumn(@Nonnull
                                           Column<D> column,
                                           @Nonnull
                                           Injector title)

addOrder

@Nonnull
public ReportBuilder<D> addOrder(@Nonnull
                                          CharSequence title)

Add new column for a row counting

getColumn

public ColumnModel<D,?> getColumn(int index)

Get column model by index

getColumnSize

public int getColumnSize()

Returns a count of columns

sortable

@Nonnull
public <V> ReportBuilder<D> sortable()

Add a sortable indicator to the last column model

Returns:

sortable

@Nonnull
public <V> ReportBuilder<D> sortable(@Nullable
                                              boolean ascending)

Add a sortable indicator to the last column model

Parameters:

ascending - Ascending or descending direction of the sort

Returns:

sortable

@Nonnull
public <V> ReportBuilder<D> sortable(@Nonnull
                                              Direction direction)

Add a sortable indicator to the last column model

Parameters:

direction - The null value shows an unused sorting action.

Returns:

getSortedColumn

@Nonnull
public ColumnModel<D,?> getSortedColumn()

Get sorted column or a stub of the sorted column was not found

setAjaxRequestParam

@Nonnull
public ReportBuilder<D> setAjaxRequestParam(@Nonnull
                                                     HttpParameter ajaxRequestParam)

setHtmlHeader

@Nonnull
public ReportBuilder<D> setHtmlHeader(@Nonnull
                                               Injector htmlHeader)

setHeader

@Nonnull
public ReportBuilder<D> setHeader(@Nonnull
                                           Injector header)

setFooter

@Nonnull
public ReportBuilder<D> setFooter(@Nonnull
                                           Injector footer)

setFormItem

@Nonnull
public ReportBuilder<D> setFormItem(@Nonnull
                                             Injector formItem)

setFormAdditions

@Deprecated
 @Nonnull
public ReportBuilder<D> setFormAdditions(@Nonnull
                                                               Injector formItem)

Deprecated.

Use the method setFormItem(org.ujorm.tools.web.ao.Injector) rather.

setAjaxEnabled

public ReportBuilder<D> setAjaxEnabled(boolean ajaxEnabled)

Enable of disable an AJAX feature, default value si true

setJavascritWriter

public ReportBuilder<D> setJavascritWriter(@Nonnull
                                           Supplier<Injector> javascritWriter)

setEmbeddedIcons

public ReportBuilder<D> setEmbeddedIcons(boolean embeddedIcons)
                                  throws IllegalStateException

Throws:

IllegalStateException

build

public void build(@Nonnull
                  javax.servlet.http.HttpServletRequest input,
                  @Nonnull
                  javax.servlet.http.HttpServletResponse output,
                  @Nonnull
                  Stream<D> resource)

Build the HTML page including a table

build

public void build(@Nonnull
                  javax.servlet.http.HttpServletRequest input,
                  @Nonnull
                  javax.servlet.http.HttpServletResponse output,
                  @Nonnull
                  Function<GridBuilder<D>,Stream<D>> resource)

Build the HTML page including a table

setSort

protected void setSort(@Nonnull
                       ColumnModel sort)

Mark a column as sortable

printHtmlBody

protected void printHtmlBody(@Nonnull
                             javax.servlet.http.HttpServletRequest input,
                             @Nonnull
                             HtmlElement html,
                             @Nonnull
                             Function<GridBuilder<D>,Stream<D>> resource)

printTableBody

protected void printTableBody(@Nonnull
                              Element table,
                              @Nonnull
                              javax.servlet.http.HttpServletRequest input,
                              @Nonnull
                              Function<GridBuilder<D>,Stream<D>> resource)

doAjax

protected void doAjax(@Nonnull
                      javax.servlet.http.HttpServletRequest input,
                      @Nonnull
                      JsonBuilder output,
                      @Nonnull
                      Function<GridBuilder<D>,Stream<D>> resource)
               throws javax.servlet.ServletException,
                      IOException

Return lighlited text in HTML format according a regular expression

Parameters:

input - servlet request

output - A JSON writer

Throws:

javax.servlet.ServletException - if a servlet-specific error occurs

IOException - if an I/O error occurs