|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.portlet.GenericPortlet
org.apache.portals.bridges.common.GenericServletPortlet
org.apache.portals.bridges.velocity.GenericVelocityPortlet
org.apache.portals.gems.browser.BrowserPortlet
public class BrowserPortlet
AbstractBrowserPortlet
Field Summary | |
---|---|
protected static java.lang.String |
BROWSER_ACTION_KEY
|
protected static java.lang.String |
BROWSER_ITERATOR
|
protected static java.lang.String |
BROWSER_TABLE_SIZE
|
protected static java.lang.String |
BROWSER_TITLE_ITERATOR
|
protected javax.portlet.PortletContext |
context
|
protected static java.lang.String |
CUSTOMIZE_TEMPLATE
|
protected static java.lang.String |
FILTER
|
protected static java.lang.String |
FILTERED
|
protected static java.lang.String |
FIND
|
protected static java.lang.String |
FIRST
|
protected static java.lang.String |
LAST
|
protected static java.lang.String |
LINKS_READ
|
protected org.apache.commons.logging.Log |
log
Static initialization of the logger for this class |
protected static java.lang.String |
NEXT
|
protected static java.lang.String |
PEID
|
protected static java.lang.String |
POOLNAME
|
protected static java.lang.String |
PREVIOUS
|
protected static java.lang.String |
ROW_LINK
|
protected static java.lang.String |
ROW_LINK_IDS
|
protected static java.lang.String |
ROW_LINK_TARGETS
|
protected static java.lang.String |
ROW_LINK_TYPES
|
protected static java.lang.String |
SEARCH_COLUMN
|
protected static java.lang.String |
SEARCH_STRING
|
protected static java.lang.String |
SORT_COLUMN_NAME
|
protected static java.lang.String |
SQL
|
protected static java.lang.String |
SQL_PARAM_PREFIX
|
protected java.util.List |
sqlParameters
|
protected SSOProvider |
sso
|
protected static java.lang.String |
START
|
protected static java.lang.String |
TABLE_LINK
|
protected static java.lang.String |
TABLE_LINK_IDS
|
protected static java.lang.String |
TABLE_LINK_TARGETS
|
protected static java.lang.String |
TABLE_LINK_TYPES
|
protected static java.lang.String |
USER_OBJECT_NAMES
|
protected static java.lang.String |
USER_OBJECT_TYPES
|
protected static java.lang.String |
USER_OBJECTS
|
protected static java.lang.String |
VELOCITY_NULL_ENTRY
|
protected static java.lang.String |
WINDOW_SIZE
|
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 | |
---|---|
BrowserPortlet()
|
Method Summary | |
---|---|
protected void |
clearBrowserIterator(javax.portlet.PortletRequest request)
Centralizes the calls to session - to clear the BrowserIterator from the temp storage. |
void |
doEdit(javax.portlet.RenderRequest request,
javax.portlet.RenderResponse response)
|
void |
doView(javax.portlet.RenderRequest request,
javax.portlet.RenderResponse response)
|
boolean |
filter(java.util.List row,
javax.portlet.RenderRequest request)
|
int |
find(BrowserIterator iterator,
java.lang.String searchString,
java.lang.String searchColumn)
|
protected BrowserIterator |
getBrowserIterator(javax.portlet.PortletRequest request)
Centralizes the calls to session - to retrieve the BrowserIterator. |
protected java.lang.String |
getPreference(javax.portlet.RenderRequest request,
java.lang.String attrName,
java.lang.String attrDefValue)
|
java.lang.String |
getQueryString(javax.portlet.RenderRequest request)
|
protected java.lang.String |
getQueryString(javax.portlet.RenderRequest request,
org.apache.velocity.context.Context context)
This method returns the sql from the getQuery method which can be overwritten according to the needs of the application. |
void |
getRows(javax.portlet.RenderRequest request,
java.lang.String sql,
int windowSize)
|
void |
getRows(javax.portlet.RenderRequest request,
java.lang.String sql,
int windowSize,
java.lang.String filter)
|
protected int |
getStartIndex()
to be used if sorting behavior to be overwritten |
protected int |
getStartVariable(javax.portlet.RenderRequest request,
java.lang.String attrName,
java.lang.String sortColName,
BrowserIterator iterator)
|
void |
init(javax.portlet.PortletConfig config)
|
void |
populate(int rowIndex,
int columnIndex,
java.util.List row)
This method should be overwritten every time the user object needs to be populated with some user specific constraints. |
void |
processAction(javax.portlet.ActionRequest request,
javax.portlet.ActionResponse response)
|
void |
publishStatusMessage(javax.portlet.PortletRequest request,
java.lang.String portlet,
java.lang.String topic,
java.lang.Throwable e,
java.lang.String message)
|
protected void |
readLinkParameters(javax.portlet.RenderRequest request,
org.apache.velocity.context.Context context)
|
protected void |
readSqlParameters(javax.portlet.RenderRequest request)
|
protected void |
readUserParameters(javax.portlet.RenderRequest request,
org.apache.velocity.context.Context context)
|
protected void |
setBrowserIterator(javax.portlet.RenderRequest request,
BrowserIterator iterator)
Centralizes the calls to session - to set the BrowserIterator. |
void |
setSQLParameters(java.util.List parameters)
|
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 |
Field Detail |
---|
protected static final java.lang.String SQL
protected static final java.lang.String POOLNAME
protected static final java.lang.String START
protected static final java.lang.String FIND
protected static final java.lang.String SEARCH_STRING
protected static final java.lang.String SEARCH_COLUMN
protected static final java.lang.String FILTERED
protected static final java.lang.String FILTER
protected static final java.lang.String CUSTOMIZE_TEMPLATE
protected static final java.lang.String WINDOW_SIZE
protected static final java.lang.String USER_OBJECT_NAMES
protected static final java.lang.String USER_OBJECT_TYPES
protected static final java.lang.String USER_OBJECTS
protected static final java.lang.String SQL_PARAM_PREFIX
protected static final java.lang.String LINKS_READ
protected static final java.lang.String ROW_LINK
protected static final java.lang.String TABLE_LINK
protected static final java.lang.String ROW_LINK_IDS
protected static final java.lang.String ROW_LINK_TYPES
protected static final java.lang.String ROW_LINK_TARGETS
protected static final java.lang.String TABLE_LINK_IDS
protected static final java.lang.String TABLE_LINK_TYPES
protected static final java.lang.String TABLE_LINK_TARGETS
protected static final java.lang.String BROWSER_TABLE_SIZE
protected static final java.lang.String BROWSER_ACTION_KEY
protected static final java.lang.String BROWSER_ITERATOR
protected static final java.lang.String BROWSER_TITLE_ITERATOR
protected static final java.lang.String NEXT
protected static final java.lang.String PREVIOUS
protected static final java.lang.String FIRST
protected static final java.lang.String LAST
protected static final java.lang.String VELOCITY_NULL_ENTRY
protected static final java.lang.String PEID
protected static final java.lang.String SORT_COLUMN_NAME
protected java.util.List sqlParameters
protected javax.portlet.PortletContext context
protected SSOProvider sso
protected org.apache.commons.logging.Log log
Constructor Detail |
---|
public BrowserPortlet()
Method Detail |
---|
public void init(javax.portlet.PortletConfig config) throws javax.portlet.PortletException
init
in interface javax.portlet.Portlet
init
in class org.apache.portals.bridges.velocity.GenericVelocityPortlet
javax.portlet.PortletException
public void getRows(javax.portlet.RenderRequest request, java.lang.String sql, int windowSize) throws java.lang.Exception
getRows
in interface Browser
java.lang.Exception
public void getRows(javax.portlet.RenderRequest request, java.lang.String sql, int windowSize, java.lang.String filter) throws java.lang.Exception
java.lang.Exception
public void doView(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response) throws javax.portlet.PortletException, java.io.IOException
doView
in class org.apache.portals.bridges.velocity.GenericVelocityPortlet
javax.portlet.PortletException
java.io.IOException
public void doEdit(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response) throws javax.portlet.PortletException, java.io.IOException
doEdit
in class org.apache.portals.bridges.velocity.GenericVelocityPortlet
javax.portlet.PortletException
java.io.IOException
public void processAction(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response) throws javax.portlet.PortletException, java.io.IOException
processAction
in interface javax.portlet.Portlet
processAction
in class org.apache.portals.bridges.velocity.GenericVelocityPortlet
javax.portlet.PortletException
java.io.IOException
protected BrowserIterator getBrowserIterator(javax.portlet.PortletRequest request)
data
- The turbine rundata context for this request.protected void setBrowserIterator(javax.portlet.RenderRequest request, BrowserIterator iterator)
data
- The turbine rundata context for this request.iterator.
- protected void clearBrowserIterator(javax.portlet.PortletRequest request)
data
- The turbine rundata context for this request.protected int getStartVariable(javax.portlet.RenderRequest request, java.lang.String attrName, java.lang.String sortColName, BrowserIterator iterator)
protected int getStartIndex()
protected java.lang.String getQueryString(javax.portlet.RenderRequest request, org.apache.velocity.context.Context context)
public java.lang.String getQueryString(javax.portlet.RenderRequest request)
protected java.lang.String getPreference(javax.portlet.RenderRequest request, java.lang.String attrName, java.lang.String attrDefValue)
protected void readUserParameters(javax.portlet.RenderRequest request, org.apache.velocity.context.Context context)
protected void readSqlParameters(javax.portlet.RenderRequest request)
public void setSQLParameters(java.util.List parameters)
protected void readLinkParameters(javax.portlet.RenderRequest request, org.apache.velocity.context.Context context)
public void populate(int rowIndex, int columnIndex, java.util.List row)
populate
in interface Browser
public boolean filter(java.util.List row, javax.portlet.RenderRequest request)
filter
in interface Browser
public void publishStatusMessage(javax.portlet.PortletRequest request, java.lang.String portlet, java.lang.String topic, java.lang.Throwable e, java.lang.String message)
public int find(BrowserIterator iterator, java.lang.String searchString, java.lang.String searchColumn)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |