com.ibm.ccd.ui.tags
Class UISearchResultTag

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by com.ibm.ccd.ui.tags.UISearchResultTag
All Implemented Interfaces:
java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.Tag
Direct Known Subclasses:
UISearchUtilResultTag

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

This class is a Tag used to display contents of a Collection. It iterates through a Collection and displays it's content in Tabular Format. If a field is sortable, then the particular column in the table is sortable. If it is a link, then the field is rendered as a HTML Link. If the collection has to be lazily loaded, then the collection is traversed using some links for traversal.

See Also:
Serialized Form

Field Summary
protected  int maxCols
          max displayable cols
protected  java.util.ArrayList metaDataList
          Identifier ArrayList
protected  javax.servlet.jsp.JspWriter out
          Identifier JspWriter
protected  org.apache.jetspeed.portlet.PortletContext portletContext
          Initializing the PortletContext
protected  org.apache.jetspeed.portlet.PortletRequest portletRequest
          Initializing the PortletContext
protected  java.lang.String primaryKey
          Attribute name of Primary key
protected  ResultData resultData
          list of result data elements
protected  java.util.ArrayList resultDataList
          list of result data elements
protected  SearchResultBean resultsBean
          the View Bean
protected  ResultRowData[] rowData
          Identifier ResultRowData[]
static java.lang.String SEARCH_UTIL_PORTLET
           
protected  java.util.ArrayList searchElements
          Contains the list of BaseSearchElement
 
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
UISearchResultTag()
           
 
Method Summary
protected  void constructHeadings()
          This method generates the HTML for the collection headings
protected  java.lang.String constructLink(java.lang.String action)
          Constructs a link for the navigation linkss
protected  void constructNavigationLinks()
          This method generates the HTML for the collection headings
protected  void constructResultTable()
          This method generates the HTML for the collection Form
protected  void constructRows()
          This method generates the HTML for the collection rows
protected  void displayPrimaryKey(java.util.HashMap dataElements)
           
protected  void displayTitle()
           
 int doStartTag()
          This method is the first method to be called.
protected  java.lang.String getDisplayValue(java.lang.String colName, java.lang.String textValue)
           
protected  void orderResultMetaData()
          Ordrs the list according to user selection
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, doEndTag, 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

SEARCH_UTIL_PORTLET

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

out

protected javax.servlet.jsp.JspWriter out
Identifier JspWriter


metaDataList

protected java.util.ArrayList metaDataList
Identifier ArrayList


resultDataList

protected java.util.ArrayList resultDataList
list of result data elements


rowData

protected ResultRowData[] rowData
Identifier ResultRowData[]


resultsBean

protected SearchResultBean resultsBean
the View Bean


resultData

protected ResultData resultData
list of result data elements


maxCols

protected int maxCols
max displayable cols


portletContext

protected org.apache.jetspeed.portlet.PortletContext portletContext
Initializing the PortletContext


portletRequest

protected org.apache.jetspeed.portlet.PortletRequest portletRequest
Initializing the PortletContext


searchElements

protected java.util.ArrayList searchElements
Contains the list of BaseSearchElement


primaryKey

protected java.lang.String primaryKey
Attribute name of Primary key

Constructor Detail

UISearchResultTag

public UISearchResultTag()
Method Detail

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException
This method is the first method to be called. It is used to initialize the objects.

Specified by:
doStartTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doStartTag in class javax.servlet.jsp.tagext.TagSupport
Returns:
an integer which signifies that tags body should not be processed.
Throws:
javax.servlet.jsp.JspException

constructResultTable

protected void constructResultTable()
                             throws java.io.IOException
This method generates the HTML for the collection Form

Throws:
java.io.IOException

constructHeadings

protected void constructHeadings()
                          throws java.io.IOException
This method generates the HTML for the collection headings

Throws:
java.io.IOException

displayTitle

protected void displayTitle()
                     throws java.io.IOException
Throws:
java.io.IOException

constructRows

protected void constructRows()
                      throws java.io.IOException
This method generates the HTML for the collection rows

Throws:
java.io.IOException

displayPrimaryKey

protected void displayPrimaryKey(java.util.HashMap dataElements)
                          throws java.io.IOException
Throws:
java.io.IOException

getDisplayValue

protected java.lang.String getDisplayValue(java.lang.String colName,
                                           java.lang.String textValue)
Parameters:
colName -
textValue -
Returns:
string

constructNavigationLinks

protected void constructNavigationLinks()
                                 throws java.io.IOException
This method generates the HTML for the collection headings

Throws:
java.io.IOException

constructLink

protected java.lang.String constructLink(java.lang.String action)
                                  throws java.io.IOException
Constructs a link for the navigation linkss

Parameters:
action - , for which the link needs to be constructed
Returns:
String representing the link
Throws:
java.io.IOException

orderResultMetaData

protected void orderResultMetaData()
Ordrs the list according to user selection