com.iphrase.onestep.beans
Class DrillDownTabs

java.lang.Object
  |
  +--com.iphrase.onestep.beans.DrillDownTabs

public class DrillDownTabs
extends java.lang.Object

Contains data required for formatting of the tabs component. The Tabs component is built upon the feature defined as a RENDER_TAB_FEATURE in the default.prp file. Each tab represents a single tabbed feature value. The data structure of this class is optimized for access from JSP. The single instance of DrillDownTabs is created by the QueryHandler and set in the request-scope.


Constructor Summary
DrillDownTabs(com.iphrase.runtime.query.result.ResultSet resultsSet, com.iphrase.runtime.query.Query query)
          Constructs the DrillDownTabs object
 
Method Summary
 TallyValueHandler getActiveTabValue()
          Returns the value of the active tab.
 int getAllTabTallyCount()
          Returns the sum of all the tallies for each tab that meets the current constraints.
 boolean getIsAllTabOn()
          Indicates if the "All" tab is selected
 TallyValueHandler[] getTabs()
          Returns tabs in an order specified by tabsOrderLabels
 int getTabsCount()
          Gets the number of available tabs (not including the "All" tab).
 java.lang.String getTabsFeatureId()
          Returns the value of RENDER_TAB_FEATURE property in the default.prp file.
static com.iphrase.runtime.query.result.TallyFeature LookupTabsTallyFeature(com.iphrase.runtime.query.result.DrillDown drillDown)
          Returns a feature marked as RENDER_TAB_FEATURE in the default.prp file
 void setTabsOrder(java.lang.String tabsOrderLabels)
          Set the order of the tabs.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DrillDownTabs

public DrillDownTabs(com.iphrase.runtime.query.result.ResultSet resultsSet,
                     com.iphrase.runtime.query.Query query)
Constructs the DrillDownTabs object
Parameters:
resultsSet - a query ResultSet (usually MainResult set)
query - a Query object used to produce the result set
Method Detail

LookupTabsTallyFeature

public static com.iphrase.runtime.query.result.TallyFeature LookupTabsTallyFeature(com.iphrase.runtime.query.result.DrillDown drillDown)
Returns a feature marked as RENDER_TAB_FEATURE in the default.prp file
Parameters:
drillDown - DrillDown list of features to search within
Returns:
tabbed TallyFeature

getTabs

public TallyValueHandler[] getTabs()
Returns tabs in an order specified by tabsOrderLabels
Returns:
array of TallyValueHandler objects

getIsAllTabOn

public boolean getIsAllTabOn()
Indicates if the "All" tab is selected
Returns:
true if the "All" tab is selected

getAllTabTallyCount

public int getAllTabTallyCount()
Returns the sum of all the tallies for each tab that meets the current constraints.
Returns:
int the number of items returned when the "All" tab is pressed.

getTabsFeatureId

public java.lang.String getTabsFeatureId()
Returns the value of RENDER_TAB_FEATURE property in the default.prp file.
Returns:
the tabbed feature ID

setTabsOrder

public void setTabsOrder(java.lang.String tabsOrderLabels)
Set the order of the tabs. If this is not set, the order of the tabs will be the order of the values returned by the OneStep server.
Parameters:
tabsOrderLabels - a ";" separated list of tab labels (as they appear in the constraint string) See the Look and Feel Chapter of the User's Guide for additional details.

getActiveTabValue

public TallyValueHandler getActiveTabValue()
Returns the value of the active tab.
Returns:
active tab TallyValueHandler

getTabsCount

public int getTabsCount()
Gets the number of available tabs (not including the "All" tab). A Count of "0" is a legal value and indicates that tabs should be hidden.
Returns:
tabsCount property

© Copyright 2005, 2006. IBM Corporation. All rights reserved.