com.iphrase.onestep.beans
Class Breadcrumb.Item

java.lang.Object
  |
  +--com.iphrase.onestep.beans.Breadcrumb.Item
Enclosing class:
Breadcrumb

public class Breadcrumb.Item
extends java.lang.Object

Contains data for formatting of a single breadcrumb entry.


Constructor Summary
Breadcrumb.Item(java.lang.String label, com.iphrase.runtime.query.constraint.Constraint constraint, com.iphrase.runtime.query.result.TallyFeature tallyFeature, boolean isRemoveIndividualTerms)
          Constructs a Item
 
Method Summary
 java.lang.String getId()
          Returns the feature id for constraints or "Mentions" for the search string.
 boolean getIsRemoveIndividualTerms()
          Identical to isRemoveIndividualTerms(), but starts with 'get' in order to expose bean property to JSP/JSTL.
 boolean getIsRequired()
          Identical to isRequired(), but starts with 'get' in order to expose bean property to JSP/JSTL.
 java.lang.String getLabel()
          Returns the feature label for constraints or "Mentions" for the search string.
 int getSize()
          Returns the number of the sibling items.
 TallyValueHandler[] getValues()
          Returns current constraint value (first in the list) followed by all available alternatives.
 boolean isRemoveIndividualTerms()
          Is true if: end-user is allowed to remove individual terms of a text query, and this item is based on a corresponding Mentions constraint.
 boolean isRequired()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Breadcrumb.Item

public Breadcrumb.Item(java.lang.String label,
                       com.iphrase.runtime.query.constraint.Constraint constraint,
                       com.iphrase.runtime.query.result.TallyFeature tallyFeature,
                       boolean isRemoveIndividualTerms)
Constructs a Item
Parameters:
label - a label to be used with the specified Item
constraint - the Constraint of the specified Item
tallyFeature - the TallyFeature of the specified Item
isRemoveIndividualTerms - if true, allow end-user to remove individual terms of a Mentions constraint
Method Detail

getLabel

public java.lang.String getLabel()
Returns the feature label for constraints or "Mentions" for the search string.
Returns:
label of the specific Breadcrumb item

getId

public java.lang.String getId()
Returns the feature id for constraints or "Mentions" for the search string.
Returns:
id of the specific Breadcrumb item

getValues

public TallyValueHandler[] getValues()
Returns current constraint value (first in the list) followed by all available alternatives.
Returns:
array of TallyValueHandler objects

getSize

public int getSize()
Returns the number of the sibling items. A value of "1" indicates that the constraint could not be replaced by another sibling constraint.
Returns:
the number of the sibling items.

isRemoveIndividualTerms

public boolean isRemoveIndividualTerms()
Is true if:

getIsRemoveIndividualTerms

public boolean getIsRemoveIndividualTerms()
Identical to isRemoveIndividualTerms(), but starts with 'get' in order to expose bean property to JSP/JSTL.

isRequired

public boolean isRequired()
Returns:
true if constraint submitted with state 8 REQUIRED (do not permit SWAPPING/REMOVAL)

getIsRequired

public boolean getIsRequired()
Identical to isRequired(), but starts with 'get' in order to expose bean property to JSP/JSTL.

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