org.apache.jetspeed.portlets.selector
Class CategoryPortletSelector

java.lang.Object
  extended by javax.portlet.GenericPortlet
      extended by org.apache.portals.bridges.common.GenericServletPortlet
          extended by org.apache.portals.bridges.velocity.GenericVelocityPortlet
              extended by org.apache.portals.gems.dojo.AbstractDojoVelocityPortlet
                  extended by org.apache.jetspeed.portlets.selector.CategoryPortletSelector
All Implemented Interfaces:
java.util.Comparator, javax.portlet.Portlet, javax.portlet.PortletConfig, SupportsHeaderPhase

public class CategoryPortletSelector
extends AbstractDojoVelocityPortlet
implements java.util.Comparator

CategoryPortletSelector selects categories organized by categories

Version:
$Id: $
Author:
David Sean Taylor

Field Summary
protected static java.lang.String CATEGORIES
           
 java.lang.String[] DEFAULT_IMAGES
           
protected static java.lang.String LAYOUT
           
protected  org.apache.commons.logging.Log logger
           
protected static java.lang.String PAGE
           
protected  PageManager pageManager
           
static java.lang.String PORTLET_ICON
           
protected static java.lang.String PORTLETS
           
protected  Profiler profiler
           
protected  java.util.Random rand
           
protected  PortletRegistry registry
           
protected  SearchEngine searchEngine
           
protected  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
protected  java.lang.String cleanup(java.lang.String str)
           
 int compare(java.lang.Object obj1, java.lang.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(PortletDefinitionComposite portlet, java.util.Locale locale)
          Filters portlets being added to the based on security checks and layout criteria
protected  Page getPage(javax.portlet.RenderRequest request)
           
protected  PortletDefinitionComposite getPortletFromParsedObject(ParsedObject po)
           
protected  void includeHeaderContent(HeaderResource headerResource)
           
 void init(javax.portlet.PortletConfig config)
           
 void processAction(javax.portlet.ActionRequest request, javax.portlet.ActionResponse actionResponse)
           
protected  void processPage(javax.portlet.RenderRequest request)
           
 java.util.List retrieveCategories(javax.portlet.RenderRequest request)
           
 java.util.List retrievePortlets(javax.portlet.RenderRequest request, java.lang.String filter)
           
 
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 java.lang.String[] DEFAULT_IMAGES

logger

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

PORTLET_ICON

public static final java.lang.String PORTLET_ICON
See Also:
Constant Field Values

PORTLETS

protected static final java.lang.String PORTLETS
See Also:
Constant Field Values

CATEGORIES

protected static final java.lang.String CATEGORIES
See Also:
Constant Field Values

PAGE

protected static final java.lang.String PAGE
See Also:
Constant Field Values

LAYOUT

protected static final java.lang.String LAYOUT
See Also:
Constant Field Values

registry

protected PortletRegistry registry

searchEngine

protected SearchEngine searchEngine

pageManager

protected PageManager pageManager

profiler

protected Profiler profiler

securityAccessController

protected SecurityAccessController securityAccessController

rand

protected java.util.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 AbstractDojoVelocityPortlet
Throws:
javax.portlet.PortletException

doView

public void doView(javax.portlet.RenderRequest request,
                   javax.portlet.RenderResponse response)
            throws javax.portlet.PortletException,
                   java.io.IOException
Overrides:
doView in class org.apache.portals.bridges.velocity.GenericVelocityPortlet
Throws:
javax.portlet.PortletException
java.io.IOException

getPage

protected Page getPage(javax.portlet.RenderRequest request)
                throws java.lang.Exception
Throws:
java.lang.Exception

processPage

protected void processPage(javax.portlet.RenderRequest request)

retrieveCategories

public java.util.List retrieveCategories(javax.portlet.RenderRequest request)
                                  throws javax.portlet.PortletException
Throws:
javax.portlet.PortletException

retrievePortlets

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

filterPortlet

protected PortletInfo filterPortlet(PortletDefinitionComposite portlet,
                                    java.util.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 java.lang.String cleanup(java.lang.String str)

getPortletFromParsedObject

protected PortletDefinitionComposite getPortletFromParsedObject(ParsedObject po)

processAction

public void processAction(javax.portlet.ActionRequest request,
                          javax.portlet.ActionResponse actionResponse)
                   throws javax.portlet.PortletException,
                          java.io.IOException
Specified by:
processAction in interface javax.portlet.Portlet
Overrides:
processAction in class org.apache.portals.bridges.velocity.GenericVelocityPortlet
Throws:
javax.portlet.PortletException
java.io.IOException

compare

public int compare(java.lang.Object obj1,
                   java.lang.Object obj2)
Specified by:
compare in interface java.util.Comparator

includeHeaderContent

protected void includeHeaderContent(HeaderResource headerResource)
Overrides:
includeHeaderContent in class AbstractDojoVelocityPortlet

doEdit

public void doEdit(javax.portlet.RenderRequest request,
                   javax.portlet.RenderResponse response)
            throws javax.portlet.PortletException,
                   java.io.IOException
Overrides:
doEdit in class org.apache.portals.bridges.velocity.GenericVelocityPortlet
Throws:
javax.portlet.PortletException
java.io.IOException


Copyright © 1999-2009 Apache Software Foundation. All Rights Reserved.