Package com.day.cq.commons.servlets

Class AbstractListServlet

java.lang.Object

javax.servlet.GenericServlet

org.apache.sling.api.servlets.SlingSafeMethodsServlet

org.apache.sling.api.servlets.SlingAllMethodsServlet

com.day.cq.commons.servlets.AbstractPredicateServlet

com.day.cq.commons.servlets.AbstractListServlet

All Implemented Interfaces:

Serializable, Servlet, ServletConfig

Direct Known Subclasses:

AbstractReplicableListServlet

public class AbstractListServlet
extends AbstractPredicateServlet

The AbstractListServlet provides base functionality such as sorting and paging for servlets that feed Ext grids (like in the SiteAdmin) with JSON. Normally, the list of children of the addressed resource are returned. Alternatively, the paging index of an item can be requested.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AbstractListServlet.ListItem	The ListItem interface defines a sortable item of the list.
class	AbstractListServlet.ListItemComparator	The ListItemComparator compares public fields of AbstractListServlet.ListItems.

Field Summary

Fields

Modifier and Type	Field	Description
static String	PAGE_INDEX	Parameter to use in conjunction with PATH to determine the paging index of an item.
static String	PAGE_LIMIT	Parameter to specify the limit of items per page when using paging.
static String	PAGE_START	Parameter to specify the start index with when using paging.
static String	PATH	Parameter to use in conjunction with PAGE_INDEX to determine the paging index of an item.
static String	PROP	Parameter to use to specify the name(s) of custom properties that should be returned for each item in the list.
static String	SORT_ASCENDING	Value to use for SORT_DIR to use ascending order (default).
static String	SORT_DESCENDING	Value to use for SORT_DIR to use descending order.
static String	SORT_DIR	Parameter to specify the direction to use for sorting.
static String	SORT_KEY	Parameter to specify which property use for sorting.
static String	TIDY	Parameter to use for tidy JSON.

Fields inherited from class com.day.cq.commons.servlets.AbstractPredicateServlet

FILTER_PARAM, PATH_PARAM, PREDICATE_PARAM

Constructor Summary

Constructors

Constructor	Description
AbstractListServlet()

Method Summary

Methods inherited from class com.day.cq.commons.servlets.AbstractPredicateServlet

getPredicate

Methods inherited from class org.apache.sling.api.servlets.SlingSafeMethodsServlet

getServletInfo, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

TIDY

public static final String TIDY

Parameter to use for tidy JSON. If present, indentation and line breaks are added for better legibility.

See Also:

Constant Field Values

PAGE_START

public static final String PAGE_START

Parameter to specify the start index with when using paging. Typically used in conjunction with PAGE_LIMIT. For the items of the page n, use a start index of limit + (n - 1).

See Also:

Constant Field Values

PAGE_LIMIT

public static final String PAGE_LIMIT

Parameter to specify the limit of items per page when using paging. Typically used in conjunction with PAGE_START.

See Also:

Constant Field Values

SORT_KEY

public static final String SORT_KEY

Parameter to specify which property use for sorting. Defaults to "index".

See Also:

Constant Field Values

SORT_DIR

public static final String SORT_DIR

Parameter to specify the direction to use for sorting. Defaults to SORT_ASCENDING.

See Also:

Constant Field Values

SORT_ASCENDING

public static final String SORT_ASCENDING

Value to use for SORT_DIR to use ascending order (default).

See Also:

Constant Field Values

SORT_DESCENDING

public static final String SORT_DESCENDING

Value to use for SORT_DIR to use descending order.

See Also:

Constant Field Values

PATH

public static final String PATH

Parameter to use in conjunction with PAGE_INDEX to determine the paging index of an item. If both parameters are present, the paging index of the item with the specified path will be returned instead of the list of children.

See Also:

Constant Field Values

PAGE_INDEX

public static final String PAGE_INDEX

Parameter to use in conjunction with PATH to determine the paging index of an item. If this parameter is present, the paging index of the item with the path specified in PATH will be returned instead of the list of children.

See Also:

Constant Field Values

PROP

public static final String PROP

Parameter to use to specify the name(s) of custom properties that should be returned for each item in the list. If the properties exist on the item's resource, their values will be returned as additional JSON properties.

See Also:

Constant Field Values

Constructor Detail

AbstractListServlet

public AbstractListServlet()