The Spring Framework

## org.springframework.beans.support
Class RefreshablePagedListHolder

    java.lang.Object
      org.springframework.beans.support.PagedListHolder
          org.springframework.beans.support.RefreshablePagedListHolder

All Implemented Interfaces:
  Serializable

Deprecated. as of Spring 2.5, to be removed in Spring 3.0

    public class RefreshablePagedListHolder

extends PagedListHolder

RefreshablePagedListHolder is a PagedListHolder subclass with reloading capabilities. It automatically re-requests the List from the source provider, in case of Locale or filter changes.

Data binding works just like with PagedListHolder. The locale can be specified in Locale's toString syntax, e.g. "locale=en_US". The filter object can be of any custom class, preferably a bean for easy data binding from a request. An instance will simply get passed through to `PagedListSourceProvider.loadList`. A filter property can be specified via "filter.myFilterProperty", for example.

The scenario in the controller could be: `RefreshablePagedListHolder holder = request.getSession("mySessionAttr");
if (holder == null) {
holder = new RefreshablePagedListHolder();
holder.setSourceProvider(new MyAnonymousOrEmbeddedSourceProvider());
holder.setFilter(new MyAnonymousOrEmbeddedFilter());
request.getSession().setAttribute("mySessionAttr", holder);
}
holder.refresh(false); BindException ex = BindUtils.bind(request, listHolder, "myModelAttr");
return ModelAndView("myViewName", ex.getModel());
...
private class MyAnonymousOrEmbeddedSourceProvider implements PagedListSourceProvider {
public List loadList(Locale locale, Object filter) {
MyAnonymousOrEmbeddedFilter filter = (MyAnonymousOrEmbeddedFilter) filter;<br< // an empty name mask should lead to all objects being loaded return myBusinessService.loadMyObjectsByNameMask(filter.getName());
}
private class MyAnonymousOrEmbeddedFilter {
private String name = "";
public String getName() {
return name;<br< }
public void setName(String name) {
this.name = name;
}
}
`

Since:
  24.05.2003
Author:
  Jean-Pierre Pawlak, Juergen Hoeller
See Also:
  `PagedListSourceProvider`, `LocaleEditor`, Serialized Form

Field Summary

Fields inherited from class org.springframework.beans.support.PagedListHolder
`DEFAULT_MAX_LINKED_PAGES, DEFAULT_PAGE_SIZE`

Constructor Summary
`RefreshablePagedListHolder()` Deprecated. Create a new list holder.
`RefreshablePagedListHolder(PagedListSourceProvider sourceProvider)` Deprecated. Create a new list holder with the given source provider.

Method Summary
`Object` `getFilter()` Deprecated. Return the filter that the source provider should use for loading the list.
`Locale` `getLocale()` Deprecated. Return the Locale that the source provider should use for loading the list.
`PagedListSourceProvider` `getSourceProvider()` Deprecated. Return the callback class for reloading the List when necessary.
`void` `refresh(boolean force)` Deprecated. Reload the underlying list from the source provider if necessary (i.e. if the locale and/or the filter has changed), and resort it.
`void` `setFilter(Object filter)` Deprecated. Set the filter object that the source provider should use for loading the list.
`void` `setLocale(Locale locale)` Deprecated. Set the Locale that the source provider should use for loading the list.
`void` `setSourceProvider(PagedListSourceProvider sourceProvider)` Deprecated. Set the callback class for reloading the List when necessary.

Methods inherited from class org.springframework.beans.support.PagedListHolder
`copySortDefinition, doSort, getFirstElementOnPage, getFirstLinkedPage, getLastElementOnPage, getLastLinkedPage, getMaxLinkedPages, getNrOfElements, getPage, getPageCount, getPageList, getPageSize, getRefreshDate, getSort, getSource, isFirstPage, isLastPage, nextPage, previousPage, resort, setMaxLinkedPages, setPage, setPageSize, setSort, setSource`

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

Constructor Detail

### RefreshablePagedListHolder

    public RefreshablePagedListHolder()

  Deprecated.
  Create a new list holder. You'll need to set a source provider to be able to use the holder.

  See Also:
    `setSourceProvider(org.springframework.beans.support.PagedListSourceProvider)`

### RefreshablePagedListHolder

    public RefreshablePagedListHolder(PagedListSourceProvider sourceProvider)

  Deprecated.
  Create a new list holder with the given source provider.

Method Detail

### setSourceProvider

    public void setSourceProvider(PagedListSourceProvider sourceProvider)

  Deprecated.
  Set the callback class for reloading the List when necessary. If the list is definitely not modifiable, i.e. not locale aware and no filtering, use PagedListHolder.

  See Also:
    `PagedListHolder`

### getSourceProvider

    public PagedListSourceProvider getSourceProvider()

  Deprecated.
  Return the callback class for reloading the List when necessary.

### setLocale

    public void setLocale(Locale locale)

  Deprecated.
  Set the Locale that the source provider should use for loading the list. This can either be populated programmatically (e.g. with the request locale), or via binding (using Locale's toString syntax, e.g. "locale=en_US").

  Parameters:
    `locale` - the current Locale, or `null`

### getLocale

    public Locale getLocale()

  Deprecated.
  Return the Locale that the source provider should use for loading the list.

  Returns:
    the current Locale, or `null`

### setFilter

    public void setFilter(Object filter)

  Deprecated.
  Set the filter object that the source provider should use for loading the list. This will typically be a bean, for easy data binding.

  Parameters:
    `filter` - the filter object, or `null`

### getFilter

    public Object getFilter()

  Deprecated.
  Return the filter that the source provider should use for loading the list.

  Returns:
    the current filter, or `null`

### refresh

    public void refresh(boolean force)

  Deprecated.
  Reload the underlying list from the source provider if necessary (i.e. if the locale and/or the filter has changed), and resort it.

  Parameters:
    `force` - whether a reload should be performed in any case

The Spring Framework

Copyright © 2002-2008 The Spring Framework.