com.communote.server.web.fe.widgets

Class AbstractPagedListWidget<I>

java.lang.Object

com.communote.server.widgets.AbstractWidget

com.communote.server.widgets.AbstractMultipleResultWidget<I>

com.communote.server.web.fe.widgets.AbstractPagedListWidget<I>

Type Parameters:

I - the type of IdentifiableEntityData the widget will return

All Implemented Interfaces:

PagedWidget<I>, Widget

Direct Known Subclasses:

AuthorFilterWidget, BlogListWidget, BlogMemberManagementWidget, BlogTagCloudWidget, ChronologicalPostListWidget, IpRangeListWidget, TagCloudWidget, TopicListWidget, UserGroupListWidget, UserGroupMembersListWidget, UserListWidget, UserManagementListWidget, UserTagCloudWidget

public abstract class AbstractPagedListWidget<I>
extends AbstractMultipleResultWidget<I>
implements PagedWidget<I>

Abstract widget to be used by Widgets which only return a single result

Author:

Communote GmbH - http://www.communote.com/

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	METADATA_KEY_ELEMENTS_CONTAINED Key to be used in the response metadata to denote the number of elements contained in the response.
protected static String	METADATA_KEY_MORE_AVAILABLE Key to be used in the response metadata to denote whether there are more elements available that can be fetched with an additional query.
static String	PARAM_PAGING_INTERVAL Parameter for the paging interval

Fields inherited from class com.communote.server.widgets.AbstractWidget

METADATA_KEY_NO_CONTENT

Fields inherited from interface com.communote.server.web.fe.widgets.PagedWidget

PAGING_MASSAGE_KEY_PREFIX, PARAM_PAGING_MESSAGE_KEY_SUFFIX

Fields inherited from interface com.communote.server.widgets.Widget

PARAM_WIDGET_ID

Constructor Summary

Constructors

Constructor and Description
AbstractPagedListWidget()

Method Summary

Modifier and Type	Method and Description
String	getDefaultPagingMessageKeySuffix() Returns 'default'
PageInformation	getPageInformation() Get the page information of the widget
Map<String,String>	getParameterDescriptions() Get the parameter descriptions: This is a map of the parameter names to a human understanable value, e.g.
protected ResultSpecification	getResultSpecification() Get a result specification using the parameters offset and maxcount
protected SortedResultSpecification	getSortedResultSpecification() Get a sorted specification using the parameters offset and max count
protected abstract PageableList<I>	handleQueryList() hook that actually requests the list on the api
Object	handleRequest() Handle the request and return a result
protected void	initParameters() abstract method hook that initializes the widget's parameters
protected void	setCommonResponseMetadata(PageableList<?> result) Set common meta data extracted from the query result.
protected void	setPageInformation(PageableList<?> result, ResultSpecification resultSpecification) Set the Page Information
protected void	setPageInformation(PageInformation pageInformation)
protected void	setPageInformation(QueryParameters queryParameters, PageableList<? extends IdentifiableEntityData> result) Set the Page Information

Methods inherited from class com.communote.server.widgets.AbstractWidget

determineOutputType, getAttribute, getBooleanParameter, getGroupName, getIntParameter, getIntParameter, getLongArrayParameter, getLongParameter, getLongParameter, getParameter, getParameter, getParameterEscaped, getParameterEscaped, getParameters, getRequest, getResponse, getResponseMetadata, getStringArrayParameter, getViewIdentifier, getWidgetId, isSuccess, setAttribute, setGroupName, setParameter, setRequest, setResponse, setResponseMetadata, setSuccess

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.communote.server.widgets.Widget

getAttribute, getGroupName, getParameter, getParameters, getResponseMetadata, getTile, getViewIdentifier, getWidgetId, isSuccess, setGroupName, setParameter, setRequest, setResponse

Field Detail

METADATA_KEY_MORE_AVAILABLE

protected static final String METADATA_KEY_MORE_AVAILABLE

Key to be used in the response metadata to denote whether there are more elements available that can be fetched with an additional query.

See Also:

Constant Field Values

METADATA_KEY_ELEMENTS_CONTAINED

protected static final String METADATA_KEY_ELEMENTS_CONTAINED

Key to be used in the response metadata to denote the number of elements contained in the response.

See Also:

Constant Field Values

PARAM_PAGING_INTERVAL

public static final String PARAM_PAGING_INTERVAL

Parameter for the paging interval

See Also:

Constant Field Values

Constructor Detail

AbstractPagedListWidget

public AbstractPagedListWidget()

Method Detail

getDefaultPagingMessageKeySuffix

public String getDefaultPagingMessageKeySuffix()

Returns 'default'

Specified by:

getDefaultPagingMessageKeySuffix in interface PagedWidget<I>

Returns:

the message key suffix

See Also:

PagedWidget.getDefaultPagingMessageKeySuffix()

getPageInformation

public PageInformation getPageInformation()

Get the page information of the widget

Specified by:

getPageInformation in interface PagedWidget<I>

Returns:

the page information

getParameterDescriptions

public Map<String,String> getParameterDescriptions()

Get the parameter descriptions: This is a map of the parameter names to a human understanable value, e.g. the full name of the user or the name of a user group. Only the parameter names are set which have been used in the filter. The name can be determined by #getSuppliedParameters()

Specified by:

getParameterDescriptions in interface PagedWidget<I>

Returns:

the parameter descriptions

getResultSpecification

protected ResultSpecification getResultSpecification()

Get a result specification using the parameters offset and maxcount

Returns:

The result specification initialized by the parameters

getSortedResultSpecification

protected SortedResultSpecification getSortedResultSpecification()

Get a sorted specification using the parameters offset and max count

Returns:

The sorted result specification initialized by the parameters

handleQueryList

protected abstract PageableList<I> handleQueryList()

hook that actually requests the list on the api

Specified by:

handleQueryList in class AbstractMultipleResultWidget<I>

Returns:

list of items

handleRequest

public Object handleRequest()

Description copied from class: AbstractMultipleResultWidget

Handle the request and return a result

Specified by:

handleRequest in interface Widget

Overrides:

handleRequest in class AbstractMultipleResultWidget<I>

Returns:

the result

initParameters

protected void initParameters()

abstract method hook that initializes the widget's parameters

Specified by:

initParameters in class AbstractWidget

setCommonResponseMetadata

protected void setCommonResponseMetadata(PageableList<?> result)

Set common meta data extracted from the query result. This includes METADATA_KEY_MORE_AVAILABLE and METADATA_KEY_ELEMENTS_CONTAINED

Parameters:

result - the query result

setPageInformation

protected void setPageInformation(PageableList<?> result,
                                  ResultSpecification resultSpecification)

Set the Page Information

Parameters:

result - the list

resultSpecification - the result specification

setPageInformation

protected void setPageInformation(PageInformation pageInformation)

Parameters:

pageInformation - the pageInformation to set

setPageInformation

protected void setPageInformation(QueryParameters queryParameters,
                                  PageableList<? extends IdentifiableEntityData> result)

Set the Page Information

Parameters:

queryParameters - the instance

result - the list