This project has retired. For details please refer to its Attic page.

org.apache.jetspeed.modules.actions.portlets
Class RegistryBrowseAction

java.lang.Object
  org.apache.turbine.modules.Assembler
      org.apache.turbine.modules.Action
          org.apache.turbine.modules.ActionEvent
              org.apache.jetspeed.modules.actions.portlets.PortletActionEvent
                  org.apache.jetspeed.modules.actions.portlets.PortletAction
                      org.apache.jetspeed.modules.actions.portlets.GenericMVCAction
                          org.apache.jetspeed.modules.actions.portlets.RegistryBrowseAction

Direct Known Subclasses:

PortletBrowseAction

public class RegistryBrowseAction

extends GenericMVCAction

This action enables to browse any of the system registries for displaying available entries and information on these entries

Version:

$ID$

Author:

Raphaël Luta

Field Summary

static java.lang.String	FILTER_FIELDS
static java.lang.String	FILTER_VALUES
static java.lang.String	FILTERED_RESULTS
static java.lang.String	PREFIX
static java.lang.String	REFRESH
static java.lang.String	RESULTS
static java.lang.String	START

Fields inherited from class org.apache.jetspeed.modules.actions.portlets.GenericMVCAction

logger

Fields inherited from class org.apache.turbine.modules.ActionEvent

BUTTON, BUTTON_LENGTH, LENGTH, METHOD_NAME_LENGTH, METHOD_NAME_PREFIX

Constructor Summary

RegistryBrowseAction()

Method Summary

protected void	buildNormalContext(Portlet portlet, org.apache.velocity.context.Context context, org.apache.turbine.util.RunData rundata) Subclasses must override this method to provide default behavior for the portlet action
void	doFilter(org.apache.turbine.util.RunData rundata, org.apache.velocity.context.Context context) Adds a filter over the available portlets list based on category
protected java.util.List	filter(java.util.List entries, java.lang.String[] fields, java.lang.String[] values) Method that filters the registry entries.

Methods inherited from class org.apache.jetspeed.modules.actions.portlets.GenericMVCAction

buildConfigureContext, buildMaximizedContext, checkAdministrativeAction, doPerform, getAttribute, getAttribute, getPortletInstance, perform, setAttribute

Methods inherited from class org.apache.jetspeed.modules.actions.portlets.PortletAction

doPerform, getContext, getPortlet, getTemplate, resetTemplate, setTemplate, setTemplate

Methods inherited from class org.apache.jetspeed.modules.actions.portlets.PortletActionEvent

executeEvents, fireEvent

Methods inherited from class org.apache.turbine.modules.ActionEvent

executeEvents, formatString

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final java.lang.String PREFIX

See Also:

Constant Field Values

REFRESH

public static final java.lang.String REFRESH

See Also:

Constant Field Values

FILTER_FIELDS

public static final java.lang.String FILTER_FIELDS

See Also:

Constant Field Values

FILTER_VALUES

public static final java.lang.String FILTER_VALUES

See Also:

Constant Field Values

START

public static final java.lang.String START

See Also:

Constant Field Values

RESULTS

public static final java.lang.String RESULTS

See Also:

Constant Field Values

FILTERED_RESULTS

public static final java.lang.String FILTERED_RESULTS

See Also:

Constant Field Values

Constructor Detail

RegistryBrowseAction

public RegistryBrowseAction()

Method Detail

buildNormalContext

protected void buildNormalContext(Portlet portlet,
                                  org.apache.velocity.context.Context context,
                                  org.apache.turbine.util.RunData rundata)

Subclasses must override this method to provide default behavior for the portlet action

Overrides:

buildNormalContext in class GenericMVCAction

doFilter

public void doFilter(org.apache.turbine.util.RunData rundata,
                     org.apache.velocity.context.Context context)
              throws java.lang.Exception

Adds a filter over the available portlets list based on category

Parameters:

rundata - The turbine rundata context for this request.

context - The velocity context for this request.

Throws:

java.lang.Exception

filter

protected java.util.List filter(java.util.List entries,
                                java.lang.String[] fields,
                                java.lang.String[] values)

Method that filters the registry entries. This should be overridden in child classes to determine what filters each browser will support. By default, this implemenation does no filtering.

Parameters:

entries - The list of registry entries to filter.

fields - The array of filter names

values - The array of filter values. This should be in a 1:1 ratio with the fitler names.

Returns:

The list of filtered portlets.