org.apache.jetspeed.portlets.selector
Class CategoryPortletSelector

java.lang.Object
  javax.portlet.GenericPortlet
      org.apache.portals.bridges.common.GenericServletPortlet
          org.apache.portals.bridges.velocity.GenericVelocityPortlet
              org.apache.portals.gems.dojo.AbstractDojoVelocityPortlet
                  org.apache.jetspeed.portlets.selector.CategoryPortletSelector

All Implemented Interfaces:

Comparator, javax.portlet.Portlet, javax.portlet.PortletConfig, org.apache.jetspeed.portlet.SupportsHeaderPhase

public class CategoryPortletSelector
extends org.apache.portals.gems.dojo.AbstractDojoVelocityPortlet
implements Comparator

CategoryPortletSelector selects categories organized by categories

Version:

$Id: $

Author:

David Sean Taylor

Nested Class Summary

(package private) class

CategoryPortletSelector.CategoryResult

Field Summary

protected static String	CATEGORIES
private String	CATEGORY
String[]	DEFAULT_IMAGES
private String	FILTER
private String	JSLAYOUT
private String	JSPAGE
protected static String	LAYOUT
protected org.apache.commons.logging.Log	logger
protected static String	PAGE
protected org.apache.jetspeed.page.PageManager	pageManager
private String	PAGENUMNER
static String	PORTLET_ICON
protected static String	PORTLETS
protected org.apache.jetspeed.profiler.Profiler	profiler
protected Random	rand
protected org.apache.jetspeed.components.portletregistry.PortletRegistry	registry
protected org.apache.jetspeed.search.SearchEngine	searchEngine
protected org.apache.jetspeed.security.SecurityAccessController	securityAccessController

Fields inherited from class org.apache.portals.gems.dojo.AbstractDojoVelocityPortlet

headerPage

Fields inherited from class org.apache.portals.bridges.velocity.GenericVelocityPortlet

PORTLET_BRIDGE_CONTEXT

Fields inherited from class org.apache.portals.bridges.common.GenericServletPortlet

PARAM_ACTION_PAGE, PARAM_ALLOW_PREFERENCES, PARAM_CUSTOM_PAGE, PARAM_EDIT_PAGE, PARAM_HELP_PAGE, PARAM_MAX_PAGE, PARAM_VIEW_PAGE

Constructor Summary

CategoryPortletSelector()

Method Summary

private boolean	addPref(String prefName, String keywords, org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite portlet)
protected String	cleanup(String str)
int	compare(Object obj1, Object obj2)
void	doEdit(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
void	doView(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
protected PortletInfo	filterPortlet(org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite portlet, Locale locale) Filters portlets being added to the based on security checks and layout criteria
private int	getEndRow(String sPageNumber, int portletPerPages)
protected org.apache.jetspeed.om.page.Page	getPage(javax.portlet.RenderRequest request)
protected org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite	getPortletFromParsedObject(org.apache.jetspeed.search.ParsedObject po)
private CategoryPortletSelector.CategoryResult	getPortlets(javax.portlet.RenderRequest request, String category, String pageNumber, int portletPerPages, String filter)
private int	getStartRow(String sPageNumber, int portletPerPages)
private Map	getUserPortlet(org.apache.jetspeed.om.page.Page page)
protected void	includeHeaderContent(org.apache.jetspeed.headerresource.HeaderResource headerResource)
void	init(javax.portlet.PortletConfig config)
private boolean	isEmpty(String param)
private List	mergePortletCount(List sysPortlets, javax.portlet.RenderRequest request)
private boolean	modifyPref(String prefName, String keywords, org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite portlet)
void	processAction(javax.portlet.ActionRequest request, javax.portlet.ActionResponse actionResponse)
protected void	processPage(javax.portlet.RenderRequest request)
private boolean	removePref(String prefName, org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite portlet)
List	retrieveCategories(javax.portlet.RenderRequest request)
List	retrievePortlets(javax.portlet.RenderRequest request, String filter)
private boolean	updateNumericPref(String prefName, String param, int max, org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite portlet)

Methods inherited from class org.apache.portals.gems.dojo.AbstractDojoVelocityPortlet

doHeader, include, include

Methods inherited from class org.apache.portals.bridges.velocity.GenericVelocityPortlet

doCustom, doHelp, doPreferencesEdit, getContext, getContext, render, setupPreferencesEdit

Methods inherited from class org.apache.portals.bridges.common.GenericServletPortlet

getDefaultActionPage, getDefaultCustomPage, getDefaultEditPage, getDefaultHelpPage, getDefaultViewPage, processPreferencesAction, setDefaultActionPage, setDefaultCustomPage, setDefaultEditPage, setDefaultHelpPage, setDefaultViewPage

Methods inherited from class javax.portlet.GenericPortlet

destroy, doDispatch, getInitParameter, getInitParameterNames, getPortletConfig, getPortletContext, getPortletName, getResourceBundle, getTitle, init

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

equals

Field Detail

DEFAULT_IMAGES

public final String[] DEFAULT_IMAGES

logger

protected final org.apache.commons.logging.Log logger

PORTLET_ICON

public static final String PORTLET_ICON

See Also:

Constant Field Values

PORTLETS

protected static final String PORTLETS

See Also:

Constant Field Values

CATEGORIES

protected static final String CATEGORIES

See Also:

Constant Field Values

PAGE

protected static final String PAGE

See Also:

Constant Field Values

LAYOUT

protected static final String LAYOUT

See Also:

Constant Field Values

JSPAGE

private final String JSPAGE

See Also:

Constant Field Values

JSLAYOUT

private final String JSLAYOUT

See Also:

Constant Field Values

CATEGORY

private final String CATEGORY

See Also:

Constant Field Values

PAGENUMNER

private final String PAGENUMNER

See Also:

Constant Field Values

FILTER

private final String FILTER

See Also:

Constant Field Values

registry

protected org.apache.jetspeed.components.portletregistry.PortletRegistry registry

searchEngine

protected org.apache.jetspeed.search.SearchEngine searchEngine

pageManager

protected org.apache.jetspeed.page.PageManager pageManager

profiler

protected org.apache.jetspeed.profiler.Profiler profiler

securityAccessController

protected org.apache.jetspeed.security.SecurityAccessController securityAccessController

rand

protected Random rand

Constructor Detail

CategoryPortletSelector

public CategoryPortletSelector()

Method Detail

init

public void init(javax.portlet.PortletConfig config)
          throws javax.portlet.PortletException

Specified by:

init in interface javax.portlet.Portlet

Overrides:

init in class org.apache.portals.gems.dojo.AbstractDojoVelocityPortlet

Throws:

javax.portlet.PortletException

doView

public void doView(javax.portlet.RenderRequest request,
                   javax.portlet.RenderResponse response)
            throws javax.portlet.PortletException,
                   IOException

Overrides:

doView in class org.apache.portals.bridges.velocity.GenericVelocityPortlet

Throws:

javax.portlet.PortletException

IOException

getPage

protected org.apache.jetspeed.om.page.Page getPage(javax.portlet.RenderRequest request)
                                            throws Exception

Throws:

Exception

processPage

protected void processPage(javax.portlet.RenderRequest request)

retrieveCategories

public List retrieveCategories(javax.portlet.RenderRequest request)
                        throws javax.portlet.PortletException

Throws:

javax.portlet.PortletException

retrievePortlets

public List retrievePortlets(javax.portlet.RenderRequest request,
                             String filter)

mergePortletCount

private List mergePortletCount(List sysPortlets,
                               javax.portlet.RenderRequest request)

filterPortlet

protected PortletInfo filterPortlet(org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite portlet,
                                    Locale locale)

Filters portlets being added to the based on security checks and layout criteria

Parameters:

portlet -

Returns:

null if filtered, otherwise PortletInfo to be added to list

cleanup

protected String cleanup(String str)

getPortletFromParsedObject

protected org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite getPortletFromParsedObject(org.apache.jetspeed.search.ParsedObject po)

processAction

public void processAction(javax.portlet.ActionRequest request,
                          javax.portlet.ActionResponse actionResponse)
                   throws javax.portlet.PortletException,
                          IOException

Specified by:

processAction in interface javax.portlet.Portlet

Overrides:

processAction in class org.apache.portals.bridges.velocity.GenericVelocityPortlet

Throws:

javax.portlet.PortletException

IOException

addPref

private boolean addPref(String prefName,
                        String keywords,
                        org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite portlet)

modifyPref

private boolean modifyPref(String prefName,
                           String keywords,
                           org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite portlet)

removePref

private boolean removePref(String prefName,
                           org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite portlet)

updateNumericPref

private boolean updateNumericPref(String prefName,
                                  String param,
                                  int max,
                                  org.apache.jetspeed.om.common.portlet.PortletDefinitionComposite portlet)

isEmpty

private boolean isEmpty(String param)

compare

public int compare(Object obj1,
                   Object obj2)

Specified by:

compare in interface Comparator

includeHeaderContent

protected void includeHeaderContent(org.apache.jetspeed.headerresource.HeaderResource headerResource)

Overrides:

includeHeaderContent in class org.apache.portals.gems.dojo.AbstractDojoVelocityPortlet

doEdit

public void doEdit(javax.portlet.RenderRequest request,
                   javax.portlet.RenderResponse response)
            throws javax.portlet.PortletException,
                   IOException

Overrides:

doEdit in class org.apache.portals.bridges.velocity.GenericVelocityPortlet

Throws:

javax.portlet.PortletException

IOException

getPortlets

private CategoryPortletSelector.CategoryResult getPortlets(javax.portlet.RenderRequest request,
                                                           String category,
                                                           String pageNumber,
                                                           int portletPerPages,
                                                           String filter)

getStartRow

private int getStartRow(String sPageNumber,
                        int portletPerPages)

getEndRow

private int getEndRow(String sPageNumber,
                      int portletPerPages)

getUserPortlet

private Map getUserPortlet(org.apache.jetspeed.om.page.Page page)