com.iphrase.onestep.beans
Class TallyValueHandler

java.lang.Object
  |
  +--com.iphrase.onestep.beans.ValueHandler
        |
        +--com.iphrase.onestep.beans.TallyValueHandler

public class TallyValueHandler
extends ValueHandler

A helper bean used to make it easier for JSP programmers to access various properties of any OneStep value types used in the DrillDown and breadcrumbs components.


Inner classes inherited from class com.iphrase.onestep.beans.ValueHandler
ValueHandler.BaseValue, ValueHandler.BooleanValue, ValueHandler.CustomValue, ValueHandler.DateTimeValue, ValueHandler.FloatValue, ValueHandler.ImageUrlValue, ValueHandler.IntValue, ValueHandler.LinkValue, ValueHandler.TaxonomyValue, ValueHandler.TextExtractValue, ValueHandler.TextValue
 
Constructor Summary
TallyValueHandler(java.lang.Object obj)
          Constructs an instance of the ValueHandler class when its type is not available.
TallyValueHandler(java.lang.Object obj, int type, boolean summarized, int recursionLevel, int tallyCount, java.lang.String featureID, boolean logClickThrough)
          Constructs an instance of the TallyValueHandler class.
TallyValueHandler(java.lang.Object obj, int type, boolean summarized, int recursionLevel, int tallyCount, java.lang.String featureID, boolean logClickThrough, java.lang.String constraintLabel)
          Constructs an instance of the TallyValueHandler class.
 
Method Summary
 java.lang.String getConstraintLabel()
          Gets the (optional) constraint label.
 boolean getIsRefineShowCounts()
           
 boolean getIsTallied()
          Overrides ValueHandler.getIsTallied() but returns a value of true
 int getRecursionLevel()
          Gets the recursion level.
 void setIsRefineShowCounts(boolean isRefineShowCounts)
          Sets whether the "refine counts" should be shown or not
 
Methods inherited from class com.iphrase.onestep.beans.ValueHandler
CreateInstance, escapeHTML, getBool, getConstraint, getCustom, getDateTime, getFeatureId, getFeatureValue, getFloat, getImageUrl, getInt, getIsNull, getIsSummarized, getLink, getMatchesConstraint, getShouldEscape, getTallyCount, getTaxonomy, getText, getTextExtract, getValue, InitConstraint, isNull, setTallyCount
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TallyValueHandler

public TallyValueHandler(java.lang.Object obj,
                         int type,
                         boolean summarized,
                         int recursionLevel,
                         int tallyCount,
                         java.lang.String featureID,
                         boolean logClickThrough)
Constructs an instance of the TallyValueHandler class.
Parameters:
obj - OneStep Runtime API value
type - one of FeatureMetaData.BaseTypes
summarized - true if the value represents a summarized value
recursionLevel - the recursion level where the value is located
tallyCount - the number of items in the result set matching this value
featureID - the ID of the feature
logClickThrough - true if the clicks-through should be logged

TallyValueHandler

public TallyValueHandler(java.lang.Object obj,
                         int type,
                         boolean summarized,
                         int recursionLevel,
                         int tallyCount,
                         java.lang.String featureID,
                         boolean logClickThrough,
                         java.lang.String constraintLabel)
Constructs an instance of the TallyValueHandler class.
Parameters:
obj - OneStep Runtime API value
type - one of FeatureMetaData.BaseTypes
summarized - true if the value represents a summarized value
recursionLevel - the recursion level where the value is located
tallyCount - the number of items in the result set matching this value
featureID - the ID of the feature
logClickThrough - true if the clicks-through should be logged
constraintLabel - optional String label for drill-down/sideways constraint

TallyValueHandler

public TallyValueHandler(java.lang.Object obj)
Constructs an instance of the ValueHandler class when its type is not available.
Parameters:
obj - an instance of OneStep Runtime API value
Method Detail

getConstraintLabel

public java.lang.String getConstraintLabel()
Gets the (optional) constraint label.
Overrides:
getConstraintLabel in class ValueHandler
Returns:
constraintLabel property

getRecursionLevel

public int getRecursionLevel()
Gets the recursion level. This is currently used for hierarchical drilldown features only.
Returns:
recursionLevel property

getIsTallied

public boolean getIsTallied()
Overrides ValueHandler.getIsTallied() but returns a value of true
Overrides:
getIsTallied in class ValueHandler
Returns:
isTallied property

getIsRefineShowCounts

public boolean getIsRefineShowCounts()
Returns:
true if "refine counts" should be shown

setIsRefineShowCounts

public void setIsRefineShowCounts(boolean isRefineShowCounts)
Sets whether the "refine counts" should be shown or not

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