org.bremersee.pagebuilder

Class PageControlFactory

java.lang.Object

org.bremersee.pagebuilder.PageControlFactory

public abstract class PageControlFactory
extends Object

Factory to create PageControlDtos.

A PageControlDto can be used to display a Page on a web site.

Author:

Christian Bremer

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_PAGINATION_LINKS Default value.
static int	DEFAULT_PAGE_SIZE_SELECTOR_MAX_VALUE Default value.
static int	DEFAULT_PAGE_SIZE_SELECTOR_MIN_VALUE Default value.
static int	DEFAULT_PAGE_SIZE_SELECTOR_STEP Default value.
static boolean	DEFAULT_SELECT_ALL_ENTRIES_AVAILABLE Default value.
protected static String	RESOURCE_BUNDLE_BASE_NAME The base name of the resource bundle.

Constructor Summary

Constructors

Constructor and Description
PageControlFactory()

Method Summary

Modifier and Type	Method and Description
org.bremersee.comparator.ComparatorItemTransformer	getComparatorItemTransformer() Gets the comparator item transformer, that reads and writes the comparator item query parameter.
String	getComparatorParamName() Gets the name of the comparator query parameter.
int	getMaxPaginationLinks() Returns the maximum numbers of pagination links.
int	getMaxResultsSelectorMaxValue() Gets the maximum value, that the page size selector can have.
String	getPageNumberParamName() Gets the name of the page number query parameter.
String	getPageSizeParamName() Gets the name of the page size query parameter.
int	getPageSizeSelectorMinValue() Gets the minimum value, that the page size selector can have.
int	getPageSizeSelectorStep() Gets the step size of the page size selector.
String	getQueryParamName() Gets the name of the query parameter.
boolean	isQuerySupported() Specifies whether a query field should be displayed on the page or not.
boolean	isSelectAllEntriesAvailable() Returns true if the page size selector has an item to choose all available entries, otherwise false.
static PageControlFactory	newInstance() Returns a new factory instance.
static PageControlFactory	newInstance(String factoryClassName) Returns a new factory instance of the given class.
static PageControlFactory	newInstance(String factoryClassName, ClassLoader classLoader) Returns a new factory instance of the given class.
<E,T> PageControlDto	newPageControl(Page<E> page, PageEntryTransformer<T,E> transformer, String pageUrl, Locale locale) Creates a new PageControlDto from the given page.
abstract <E> PageControlDto	newPageControl(Page<E> page, String pageUrl, Locale locale) Creates a new PageControlDto from the given page.
PageControlFactory	setComparatorItemTransformer(org.bremersee.comparator.ComparatorItemTransformer comparatorItemTransformer) Sets the comparator item transformer, that reads and writes the comparator item query parameter.
PageControlFactory	setComparatorParamName(String comparatorParamName) Sets the name of the comparator query parameter.
PageControlFactory	setMaxPaginationLinks(int maxPaginationLinks) Sets the maximum numbers of pagination links.
PageControlFactory	setPageNumberParamName(String pageNumberParamName) Sets the name of the page number query parameter.
PageControlFactory	setPageSizeParamName(String pageSizeParamName) Sets the name page size query parameter.
PageControlFactory	setPageSizeSelectorMaxValue(int pageSizeSelectorMaxValue) Sets the maximum value, that the page size selector can have.
PageControlFactory	setPageSizeSelectorMinValue(int pageSizeSelectorMinValue) Sets the minimum value, that the page size selector can have.
PageControlFactory	setPageSizeSelectorStep(int pageSizeSelectorStep) Sets the step size of the page size selector.
PageControlFactory	setQueryParamName(String queryParamName) Sets the name of the query parameter.
PageControlFactory	setQuerySupported(boolean isQuerySupported) Specifies whether a query field should be displayed on the page or not.
PageControlFactory	setSelectAllEntriesAvailable(boolean selectAllEntriesAvailable) Specifies whether the maximum results per page selector has an item to choose all available entries or not.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE_BUNDLE_BASE_NAME

protected static final String RESOURCE_BUNDLE_BASE_NAME

The base name of the resource bundle.

See Also:

Constant Field Values

DEFAULT_MAX_PAGINATION_LINKS

public static final int DEFAULT_MAX_PAGINATION_LINKS

Default value.

See Also:

Constant Field Values

DEFAULT_PAGE_SIZE_SELECTOR_MIN_VALUE

public static final int DEFAULT_PAGE_SIZE_SELECTOR_MIN_VALUE

Default value.

See Also:

Constant Field Values

DEFAULT_PAGE_SIZE_SELECTOR_MAX_VALUE

public static final int DEFAULT_PAGE_SIZE_SELECTOR_MAX_VALUE

Default value.

See Also:

Constant Field Values

DEFAULT_PAGE_SIZE_SELECTOR_STEP

public static final int DEFAULT_PAGE_SIZE_SELECTOR_STEP

Default value.

See Also:

Constant Field Values

DEFAULT_SELECT_ALL_ENTRIES_AVAILABLE

public static final boolean DEFAULT_SELECT_ALL_ENTRIES_AVAILABLE

Default value.

See Also:

Constant Field Values

Constructor Detail

PageControlFactory

public PageControlFactory()

Method Detail

newInstance

public static PageControlFactory newInstance()

Returns a new factory instance.

newInstance

public static PageControlFactory newInstance(String factoryClassName)
                                      throws InstantiationException,
                                             IllegalAccessException,
                                             ClassNotFoundException

Returns a new factory instance of the given class.

Parameters:

factoryClassName - the class name

Returns:

the new factory instance

Throws:

InstantiationException - if creating of the factory fails

IllegalAccessException - if creating of the factory fails

ClassNotFoundException - if creating of the factory fails

newInstance

public static PageControlFactory newInstance(String factoryClassName,
                                             ClassLoader classLoader)
                                      throws InstantiationException,
                                             IllegalAccessException,
                                             ClassNotFoundException

Returns a new factory instance of the given class.

Parameters:

factoryClassName - the class name

classLoader - the class loader to use

Returns:

the new factory instance

Throws:

InstantiationException - if creating of the factory fails

IllegalAccessException - if creating of the factory fails

ClassNotFoundException - if creating of the factory fails

getComparatorItemTransformer

public org.bremersee.comparator.ComparatorItemTransformer getComparatorItemTransformer()

Gets the comparator item transformer, that reads and writes the comparator item query parameter.

Returns:

the comparator item transformer

setComparatorItemTransformer

public PageControlFactory setComparatorItemTransformer(org.bremersee.comparator.ComparatorItemTransformer comparatorItemTransformer)

Sets the comparator item transformer, that reads and writes the comparator item query parameter.
Default is ComparatorItemTransformerImpl.

Parameters:

comparatorItemTransformer - the comparator item transformer

Returns:

the page control factory

getQueryParamName

public String getQueryParamName()

Gets the name of the query parameter. Default is 'q'.

Returns:

the name of the query parameter

setQueryParamName

public PageControlFactory setQueryParamName(String queryParamName)

Sets the name of the query parameter. Default is 'q'.

Parameters:

queryParamName - the name of the query parameter

Returns:

the page control factory

getPageSizeParamName

public String getPageSizeParamName()

Gets the name of the page size query parameter. Default is 's'.

Returns:

the name of the page size query parameter

setPageSizeParamName

public PageControlFactory setPageSizeParamName(String pageSizeParamName)

Sets the name page size query parameter. Default is 's'.

Parameters:

pageSizeParamName - the name of page size query parameter

Returns:

the page control factory

getPageNumberParamName

public String getPageNumberParamName()

Gets the name of the page number query parameter. Default is 'p'.

Returns:

the name of the page number query parameter

setPageNumberParamName

public PageControlFactory setPageNumberParamName(String pageNumberParamName)

Sets the name of the page number query parameter. Default is 'p'.

Parameters:

pageNumberParamName - the name of the page number query parameter

Returns:

the page control factory

getComparatorParamName

public String getComparatorParamName()

Gets the name of the comparator query parameter. Default is 'c'.

Returns:

the name of the comparator query parameter

setComparatorParamName

public PageControlFactory setComparatorParamName(String comparatorParamName)

Sets the name of the comparator query parameter. Default is 'c'.

Parameters:

comparatorParamName - the name of the comparator query parameter

Returns:

the page control factory

getPageSizeSelectorMinValue

public int getPageSizeSelectorMinValue()

Gets the minimum value, that the page size selector can have. Default is '10'.

Returns:

the minimum value

setPageSizeSelectorMinValue

public PageControlFactory setPageSizeSelectorMinValue(int pageSizeSelectorMinValue)

Sets the minimum value, that the page size selector can have. Default is '10'.

Parameters:

pageSizeSelectorMinValue - the minimum value

Returns:

the page control factory

getMaxResultsSelectorMaxValue

public int getMaxResultsSelectorMaxValue()

Gets the maximum value, that the page size selector can have. Default is '100'.

Returns:

the maximum value

setPageSizeSelectorMaxValue

public PageControlFactory setPageSizeSelectorMaxValue(int pageSizeSelectorMaxValue)

Sets the maximum value, that the page size selector can have. Default is '100'.

Parameters:

pageSizeSelectorMaxValue - the maximum value

Returns:

the page control factory

getPageSizeSelectorStep

public int getPageSizeSelectorStep()

Gets the step size of the page size selector. Default is '10'.

Returns:

the step size of the page size selector

setPageSizeSelectorStep

public PageControlFactory setPageSizeSelectorStep(int pageSizeSelectorStep)

Sets the step size of the page size selector. Default is '10'.

Parameters:

pageSizeSelectorStep - the step size of the page size selector

Returns:

the page control factory

isSelectAllEntriesAvailable

public boolean isSelectAllEntriesAvailable()

Returns true if the page size selector has an item to choose all available entries, otherwise false. Default is 'true'.

setSelectAllEntriesAvailable

public PageControlFactory setSelectAllEntriesAvailable(boolean selectAllEntriesAvailable)

Specifies whether the maximum results per page selector has an item to choose all available entries or not. Default is 'true'.

Parameters:

selectAllEntriesAvailable - true or false

Returns:

the page control factory

getMaxPaginationLinks

public int getMaxPaginationLinks()

Returns the maximum numbers of pagination links. Default is '7'.

Returns:

the maximum numbers of pagination links

setMaxPaginationLinks

public PageControlFactory setMaxPaginationLinks(int maxPaginationLinks)

Sets the maximum numbers of pagination links. Default is '7'.

Parameters:

maxPaginationLinks - the maximum numbers of pagination links

Returns:

the page control factory

isQuerySupported

public boolean isQuerySupported()

Specifies whether a query field should be displayed on the page or not. Default is 'true'.

Returns:

true if a query field should be displayed on the page, otherwise false

setQuerySupported

public PageControlFactory setQuerySupported(boolean isQuerySupported)

Specifies whether a query field should be displayed on the page or not. Default is 'true'.

Parameters:

isQuerySupported - true if a query field should be displayed on the page, otherwise false

Returns:

the page control factory

newPageControl

public <E,T> PageControlDto newPageControl(Page<E> page,
                                           PageEntryTransformer<T,E> transformer,
                                           String pageUrl,
                                           Locale locale)

Creates a new PageControlDto from the given page.
The page URL must be the plain URL (with no page control query parameters), e. g.: http://example.org/myapp/mypage.html
If the locale is not present, the default locale will be used.

Parameters:

page - the page

transformer - the page entry transformer (may be null)

pageUrl - the plain page URL

locale - the locale

Returns:

the created page control

newPageControl

public abstract <E> PageControlDto newPageControl(Page<E> page,
                                                  String pageUrl,
                                                  Locale locale)

Creates a new PageControlDto from the given page.
The page URL must be the plain URL (with no page control query parameters), e. g.: http://example.org/myapp/mypage.html
If the locale is not present, the default locale will be used.

Parameters:

page - the page

pageUrl - the plain page URL

locale - the locale

Returns:

the created page control