it.eng.spagobi.commons.presentation.tags
Class ListTag

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by it.eng.spagobi.commons.presentation.tags.ListTag
All Implemented Interfaces:
java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
Direct Known Subclasses:
ListBIParametersTag

public class ListTag
extends javax.servlet.jsp.tagext.TagSupport

Builds and presents all objects list for all admin SpagoBI's list modules. Once a list module has been executed, the list tag builds all the correspondent jsp page and gives the results

See Also:
Serialized Form

Field Summary
protected  java.lang.String _actionName
           
protected  java.lang.String _bundle
           
protected  java.util.Vector _columns
           
protected  it.eng.spago.base.SourceBean _content
           
protected  it.eng.spago.error.EMFErrorHandler _errorHandler
           
protected  java.lang.String _filter
           
protected  java.lang.String _firstUrl
           
protected  java.lang.StringBuffer _htmlStream
           
protected  java.lang.String _lastUrl
           
protected  it.eng.spago.base.SourceBean _layout
           
protected  java.lang.String _moduleName
           
protected  java.lang.String _nextUrl
           
protected  java.util.HashMap _paramsMap
           
protected  java.lang.String _prevUrl
           
protected  java.lang.String _providerURL
           
protected  java.lang.String _refreshUrl
           
protected  it.eng.spago.base.RequestContainer _requestContainer
           
protected  it.eng.spago.base.ResponseContainer _responseContainer
           
protected  java.lang.String _serviceName
           
protected  it.eng.spago.base.SourceBean _serviceRequest
           
protected  it.eng.spago.base.SourceBean _serviceResponse
           
protected  java.util.Vector _titleButton
           
protected  javax.servlet.http.HttpServletRequest httpRequest
           
protected  java.lang.String labelLinkSaltoPagina
           
protected  IMessageBuilder msgBuilder
           
protected  it.eng.spago.security.IEngUserProfile profile
           
protected  java.lang.String requestIdentity
           
protected  IUrlBuilder urlBuilder
           
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAIN
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
ListTag()
          Constructor.
 
Method Summary
protected  java.lang.String createUrl_popup(java.util.HashMap paramsMap)
           
protected  java.lang.String createUrl(java.util.HashMap paramsMap)
          From the parameter HashMap at input, creates the reference navigation url.
protected  void defineColumns()
           
 int doEndTag()
          Do end tag.
 int doStartTag()
           
protected  java.util.HashMap getParametersMap(java.util.List parameters, it.eng.spago.base.SourceBean row)
          Gets all parameter information from a module, putting them into a HashMap.
protected  java.lang.StringBuffer makeButton(java.util.List buttons)
          Starting from the module buttonsSB object, creates all buttons for the jsp list.
protected  void makeColumns()
          Builds Table list columns, reading all request information.
protected  void makeFooterList()
          Builds Table list footer, reading all request information.
protected  void makeForm()
          Creates a form into the jsp page.
protected  void makeNavigationButton()
          Builds list navigation buttons inside the list tag.
protected  void makeRows()
          Builds Table list rows, reading all query information.
protected  java.lang.StringBuffer makeTitleButton(java.util.List buttons)
          Starting from the module buttonsSB object, creates all buttons for the jsp list.
 void setActionName(java.lang.String actionName)
          Traces the setting of an action name.
 void setBundle(java.lang.String bundle)
          Traces the setting of a bundle name.
 void setFilter(java.lang.String filter)
          Sets the filter.
 void setModuleName(java.lang.String moduleName)
          Traces the setting of a module name.
protected  boolean verifyConditions(it.eng.spago.base.SourceBean conditionsSB, it.eng.spago.base.SourceBean row)
           
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_actionName

protected java.lang.String _actionName

_moduleName

protected java.lang.String _moduleName

_bundle

protected java.lang.String _bundle

_serviceName

protected java.lang.String _serviceName

_content

protected it.eng.spago.base.SourceBean _content

_layout

protected it.eng.spago.base.SourceBean _layout

_providerURL

protected java.lang.String _providerURL

_requestContainer

protected it.eng.spago.base.RequestContainer _requestContainer

_serviceRequest

protected it.eng.spago.base.SourceBean _serviceRequest

_responseContainer

protected it.eng.spago.base.ResponseContainer _responseContainer

_serviceResponse

protected it.eng.spago.base.SourceBean _serviceResponse

_errorHandler

protected it.eng.spago.error.EMFErrorHandler _errorHandler

_htmlStream

protected java.lang.StringBuffer _htmlStream

_columns

protected java.util.Vector _columns

_titleButton

protected java.util.Vector _titleButton

labelLinkSaltoPagina

protected java.lang.String labelLinkSaltoPagina

_filter

protected java.lang.String _filter

_prevUrl

protected java.lang.String _prevUrl

_nextUrl

protected java.lang.String _nextUrl

_firstUrl

protected java.lang.String _firstUrl

_lastUrl

protected java.lang.String _lastUrl

_refreshUrl

protected java.lang.String _refreshUrl

profile

protected it.eng.spago.security.IEngUserProfile profile

httpRequest

protected javax.servlet.http.HttpServletRequest httpRequest

urlBuilder

protected IUrlBuilder urlBuilder

msgBuilder

protected IMessageBuilder msgBuilder

_paramsMap

protected java.util.HashMap _paramsMap

requestIdentity

protected java.lang.String requestIdentity
Constructor Detail

ListTag

public ListTag()
Constructor.

Method Detail

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException
Specified by:
doStartTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doStartTag in class javax.servlet.jsp.tagext.TagSupport
Throws:
javax.servlet.jsp.JspException

makeForm

protected void makeForm()
                 throws javax.servlet.jsp.JspException
Creates a form into the jsp page.

Throws:
javax.servlet.jsp.JspException - If any exception occurs.

defineColumns

protected void defineColumns()
                      throws javax.servlet.jsp.JspException
Throws:
javax.servlet.jsp.JspException

makeColumns

protected void makeColumns()
                    throws javax.servlet.jsp.JspException
Builds Table list columns, reading all request information.

Throws:
javax.servlet.jsp.JspException - If any Exception occurs.

makeRows

protected void makeRows()
                 throws javax.servlet.jsp.JspException
Builds Table list rows, reading all query information.

Throws:
javax.servlet.jsp.JspException - If any Exception occurs.

verifyConditions

protected boolean verifyConditions(it.eng.spago.base.SourceBean conditionsSB,
                                   it.eng.spago.base.SourceBean row)
                            throws javax.servlet.jsp.JspException
Throws:
javax.servlet.jsp.JspException

makeNavigationButton

protected void makeNavigationButton()
                             throws javax.servlet.jsp.JspException
Builds list navigation buttons inside the list tag. If the number of elements is higher than 10, they are divided into pages; this methods creates forward and backward arrows and page number information for navigation.

Throws:
javax.servlet.jsp.JspException - If any Exception occurs

makeFooterList

protected void makeFooterList()
                       throws javax.servlet.jsp.JspException
Builds Table list footer, reading all request information.

Throws:
javax.servlet.jsp.JspException - If any Exception occurs.

makeButton

protected java.lang.StringBuffer makeButton(java.util.List buttons)
                                     throws javax.servlet.jsp.JspException
Starting from the module buttonsSB object, creates all buttons for the jsp list.

Parameters:
buttons - The list of the buttons
Throws:
javax.servlet.jsp.JspException - If any exception occurs.

makeTitleButton

protected java.lang.StringBuffer makeTitleButton(java.util.List buttons)
                                          throws javax.servlet.jsp.JspException
Starting from the module buttonsSB object, creates all buttons for the jsp list. These buttons are next to colums names

Parameters:
buttons - The list of the buttons
Throws:
javax.servlet.jsp.JspException - If any exception occurs.

getParametersMap

protected java.util.HashMap getParametersMap(java.util.List parameters,
                                             it.eng.spago.base.SourceBean row)
                                      throws javax.servlet.jsp.JspException
Gets all parameter information from a module, putting them into a HashMap.

Parameters:
parameters - The parameters list
row - The value objects Source Bean
Returns:
The parameters Hash Map
Throws:
javax.servlet.jsp.JspException - If any Exception occurred

createUrl

protected java.lang.String createUrl(java.util.HashMap paramsMap)
From the parameter HashMap at input, creates the reference navigation url.

Parameters:
paramsMap - The parameter HashMap
Returns:
A portletURL object representing the navigation URL

createUrl_popup

protected java.lang.String createUrl_popup(java.util.HashMap paramsMap)

setActionName

public void setActionName(java.lang.String actionName)
Traces the setting of an action name.

Parameters:
actionName - The action name string at input.

setModuleName

public void setModuleName(java.lang.String moduleName)
Traces the setting of a module name.

Parameters:
moduleName - The module name string at input.

setBundle

public void setBundle(java.lang.String bundle)
Traces the setting of a bundle name.

Parameters:
bundle - The bundle name string at input.

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException
Do end tag.

Specified by:
doEndTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doEndTag in class javax.servlet.jsp.tagext.TagSupport
Returns:
the int
Throws:
javax.servlet.jsp.JspException - the jsp exception
See Also:
Tag.doEndTag()

setFilter

public void setFilter(java.lang.String filter)
Sets the filter.

Parameters:
filter - the new filter