com.iphrase.runtime.query.result
Class FeatureMetaData

java.lang.Object
  |
  +--com.iphrase.runtime.query.Feature
        |
        +--com.iphrase.runtime.query.result.Feature
              |
              +--com.iphrase.runtime.query.result.FeatureMetaData
Direct Known Subclasses:
TallyFeature

public class FeatureMetaData
extends Feature

Represent the feature metadata for each column of a result set table.

See Also:
ResultSet

Inner Class Summary
static interface FeatureMetaData.BaseTypes
          Enumerate the currently-supported iPhrase feature base types.
 
Inner classes inherited from class com.iphrase.runtime.query.result.Feature
Feature.Flags
 
Method Summary
 java.util.Hashtable getAttributes()
          Get the feature attributes hash table.
 int getBaseType()
          Get the feature base type, a FeatureMetaData.BaseTypes value.
 int getFlags()
          Get the set of ORed flag values.
 boolean getIsDirectoryFeature()
          Determine whether this is the directory feature (guided navigation).
 boolean getIsIdentifier()
          Determine whether the column is a OneStep identifier feature.
 boolean getIsLogClickThrough()
          Determine whether features in this column should log click-through data.
 boolean getIsMaxValuesExceeded()
          Determine whether the configured maximum # of values/feature has been exceeded (drillDown).
 boolean getIsRefineShowCounts()
          Determine whether feature should show 'includes counts' option.
 boolean getIsSummarized()
          Determine whether the column values are summarized.
 boolean getIsTabFeature()
          Determine whether this is the tab feature (drillDown).
 boolean getIsTallied()
          Determine whether the column contains tallied feature values.
 boolean getIsViewBy()
          Determine whether the column is the view-by (aka group-by) feature.
 boolean getIsViewByFeature()
          Determine whether this is the view-by (aka group-by) feature (drillDown).
 boolean isDirectNavUri()
          Determine whether the column contains the direct navigation URI.
 boolean isDirectoryFeature()
          Determine whether this is the directory feature (guided navigation).
 boolean isIdentifier()
          Determine whether the column is a OneStep identifier feature.
 boolean isLogClickThrough()
          Determine whether features in this column should log click-through data.
 boolean isMaxValuesExceeded()
          Determine whether the configured maximum # of values/feature has been exceeded (drillDown).
 boolean isNew()
          Determine whether the column is new as of this query result.
 boolean isOptional()
          Determine whether the column is optional (dismissible).
 boolean isRefineShowCounts()
          Determine whether feature should show 'includes counts' option.
 boolean isSummarized()
          Determine whether the column values are summarized.
static boolean isSummarized(int flags)
          Determine whether flags indicate that values are summarized.
 boolean isTabFeature()
          Determine whether this is the tab feature (drillDown).
 boolean isTallied()
          Determine whether the column contains tallied feature values.
 boolean isViewBy()
          Determine whether the column is the view-by (aka group-by) feature.
 boolean isViewByFeature()
          Determine whether this is the view-by (aka group-by) feature (drillDown).
 
Methods inherited from class com.iphrase.runtime.query.result.Feature
getLabel
 
Methods inherited from class com.iphrase.runtime.query.Feature
getId
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getBaseType

public int getBaseType()
Get the feature base type, a FeatureMetaData.BaseTypes value.
Returns:
int base type

getAttributes

public java.util.Hashtable getAttributes()
Get the feature attributes hash table. All values are String.
Returns:
Hashtable attribute key/val pairs

getFlags

public int getFlags()
Get the set of ORed flag values.
Returns:
int flags

isNew

public boolean isNew()
Determine whether the column is new as of this query result.
Returns:
true if new

isOptional

public boolean isOptional()
Determine whether the column is optional (dismissible).
Returns:
true if optional

isSummarized

public static boolean isSummarized(int flags)
Determine whether flags indicate that values are summarized.
Returns:
true if flags indicates summarized

isSummarized

public boolean isSummarized()
Determine whether the column values are summarized.
Returns:
true if summarized

getIsSummarized

public boolean getIsSummarized()
Determine whether the column values are summarized. Identical to isSummarized(int), but starts with 'get' in order to expose bean property to JSP/JSTL.
Returns:
true if summarized

isTallied

public boolean isTallied()
Determine whether the column contains tallied feature values.
Returns:
true if tallied

getIsTallied

public boolean getIsTallied()
Determine whether the column contains tallied feature values. Identical to isTallied(), but starts with 'get' in order to expose bean property to JSP/JSTL.
Returns:
true if tallied

isDirectNavUri

public boolean isDirectNavUri()
Determine whether the column contains the direct navigation URI. This will be the case for a direct navigation result.
Returns:
true if direct nav URI

isIdentifier

public boolean isIdentifier()
Determine whether the column is a OneStep identifier feature.
Returns:
true if OneStep identifier feature

getIsIdentifier

public boolean getIsIdentifier()
Determine whether the column is a OneStep identifier feature. Identical to isIdentifier(), but starts with 'get' in order to expose bean property to JSP/JSTL.
Returns:
true if OneStep identifier feature

isViewBy

public boolean isViewBy()
Determine whether the column is the view-by (aka group-by) feature.
Returns:
true if view-by feature

getIsViewBy

public boolean getIsViewBy()
Determine whether the column is the view-by (aka group-by) feature. Identical to isViewBy(), but starts with 'get' in order to expose bean property to JSP/JSTL.
Returns:
true if view-by feature

isMaxValuesExceeded

public boolean isMaxValuesExceeded()
Determine whether the configured maximum # of values/feature has been exceeded (drillDown).
Returns:
true if exceeded

getIsMaxValuesExceeded

public boolean getIsMaxValuesExceeded()
Determine whether the configured maximum # of values/feature has been exceeded (drillDown). Identical to isMaxValuesExceeded(), but starts with 'get' in order to expose bean property to JSP/JSTL.
Returns:
true if exceeded

isTabFeature

public boolean isTabFeature()
Determine whether this is the tab feature (drillDown).
Returns:
true if tab feature

getIsTabFeature

public boolean getIsTabFeature()
Determine whether this is the tab feature (drillDown). Identical to isTabFeature(), but starts with 'get' in order to expose bean property to JSP/JSTL.
Returns:
true if tab feature

isDirectoryFeature

public boolean isDirectoryFeature()
Determine whether this is the directory feature (guided navigation).
Returns:
true if directory feature

getIsDirectoryFeature

public boolean getIsDirectoryFeature()
Determine whether this is the directory feature (guided navigation). Identical to isDirectoryFeature(), but starts with 'get' in order to expose bean property to JSP/JSTL.
Returns:
true if directory feature

isLogClickThrough

public boolean isLogClickThrough()
Determine whether features in this column should log click-through data.
Returns:
true if click-through data should be logged

getIsLogClickThrough

public boolean getIsLogClickThrough()
Determine whether features in this column should log click-through data. Identical to isLogClickThrough(), but starts with 'get' in order to expose bean property to JSP/JSTL.
Returns:
true if click-through data should be logged

isViewByFeature

public boolean isViewByFeature()
Determine whether this is the view-by (aka group-by) feature (drillDown).
Returns:
true if view-by feature

getIsViewByFeature

public boolean getIsViewByFeature()
Determine whether this is the view-by (aka group-by) feature (drillDown). Identical to isViewByFeature(), but starts with 'get' in order to expose bean property to JSP/JSTL.
Returns:
true if view-by feature

getIsRefineShowCounts

public boolean getIsRefineShowCounts()
Determine whether feature should show 'includes counts' option. Identical to isRefineShowCounts(), but starts with 'get' in order to expose bean property to JSP/JSTL.
Returns:
true if view-by feature

isRefineShowCounts

public boolean isRefineShowCounts()
Determine whether feature should show 'includes counts' option.
Returns:
true if should show counts

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