|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.iphrase.runtime.query.result.ResultSet
Represent a single result set. The OneStep server may return any number of top-level result sets, from one or more sources (domains).
QueryResult
Method Summary | |
FeatureMetaData[] |
getAddColumnOptions()
Get the additional column (aka add-column) options for this result set. |
FeatureRow |
getDirectNavRow()
Get the direct navigation FeatureRow for this result set, if
getQueryType() returns iphrase:direct navigation . |
java.lang.String |
getDirectNavUri()
Get the direct navigation URI for this result set, if getQueryType() returns iphrase:direct navigation . |
TallyFeature[] |
getDrillDown()
Deprecated. clients should use getDrillDownPlus() instead. |
DrillDown |
getDrillDownPlus()
Get the drill-down (aka refine-by) information for this result set. |
TallyFeature[] |
getDrillSideways()
Deprecated. clients should use getDrillSidewaysPlus() instead. |
DrillSideways |
getDrillSidewaysPlus()
Get the drill-sideways (aka breadcrumb) information for this result set. |
FeatureMetaData[] |
getGroupByOptions()
Get the group-by (aka view-by) options for this result set. |
int |
getGroupBySelected()
Get the index of the currently selected group-by (aka view-by) option. |
java.lang.String[] |
getHighlightTerms()
Get the highlight terms for this result set. |
java.util.Hashtable |
getHooks()
Get the hooks hash table. |
java.lang.String |
getHtmlBizRule()
If this result set is an HTML business rule, return the HTML, else null. |
java.lang.String |
getHtmlBizRuleJavaScriptFunctionCall()
Get the JavaScript function used for click-through logging. |
java.lang.String |
getHtmlBizRuleTitle()
If this result set is an HTML business rule, this is the HTML business rule title. |
java.lang.String |
getIdentifier()
Get the OneStep identifier feature id for this result set. |
FeatureMetaData[] |
getIrDrillDownOptions()
Get the IR feature drill-down options for this result set. |
boolean |
getIsRemoveIndividualTerms()
Determine whether or not individual terms of a text query should be removable, as opposed to removing (disimissing the constraint for) the entire text query. |
boolean |
getIsRenderBreadcrumb()
Determine whether or not the breadcrumb should be rendered. |
boolean |
getIsRenderPerPageOptions()
Determine whether or not the per-page options control should be rendered. |
boolean |
getIsRenderSearchWithin()
Determine whether or not the search within control should be rendered. |
java.lang.String |
getLabel()
Get the display name of this result set. |
PageContext |
getPageContext()
Get the page context for this result set. |
java.lang.String |
getQuerySubType()
Get the sub-type of the query which begat this result set. |
java.lang.String |
getQueryType()
Get the type of the query which begat this result set. |
int |
getRank()
Get the presentation rank of this result set. |
Query |
getResolvedQuery()
Get the resolved Query
which begat this result set. |
java.lang.String |
getResolvedQueryState()
Get the OneStep serialization String for the resolved Query
which begat this result set. |
java.util.Hashtable |
getResponseHeaders()
Get the response headers hash table. |
FeatureMetaData[] |
getSearchByOptions()
Get the search-by (aka set feature) options for this result set. |
SortFeature[] |
getSortByOptions()
Get the sort-by options for this result set. |
int |
getSortBySelected()
Get the index of the currently selected sort-by option. |
FeatureMetaData[] |
getSummarizeByOptions()
Get the summarize-by options for this result set. |
int |
getSummarizeBySelected()
Get the index of the currently selected summarize-by option. |
Table |
getTable()
Get the table for this result set. |
java.lang.Object |
getUserData()
Get the userData object. |
FeatureMetaData[] |
getViewByOptions()
Get the view-by (aka group-by) options for this result set. |
int |
getViewBySelected()
Get the index of the currently selected view-by (aka group-by) option. |
Voiceover |
getVoiceover()
Get the voiceover details for this result set. |
boolean |
isDirectAnswer()
Determine if this result set is of type iphrase:direct answer
(i.e. |
boolean |
isDirectNav()
Determine if this result set is of type iphrase:direct navigation
(i.e. |
boolean |
isRemoveIndividualTerms()
Determine whether or not individual terms of a text query should be removable, as opposed to removing (disimissing the constraint for) the entire text query. |
boolean |
isRenderBreadcrumb()
Determine whether or not the breadcrumb should be rendered. |
boolean |
isRenderPerPageOptions()
Determine whether or not the per-page options control should be rendered. |
boolean |
isRenderSearchWithin()
Determine whether or not the search within control should be rendered. |
void |
setHtmlBizRuleJavaScriptFunctionCall(java.lang.String htmlBizRuleJavaScriptFunctionCall)
Set the JavaScript function used for click-through logging. |
void |
setUserData(java.lang.Object userData)
Set the userData object. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public final Query getResolvedQuery()
Query
which begat this result set. Do NOT modify this query directly;
you should only use it for read-only access to properties.public java.lang.String getResolvedQueryState()
String
for the resolved Query
which begat this result set. This can be the point of departure for a
follow up query via Connector.createQuery(String state)
.public java.lang.String getQueryType()
iphrase:dynamic report
iphrase:direct answer
iphrase:direct navigation
iphrase:freeform
String
query type.public java.lang.String getQuerySubType()
getQueryType()
value "iphrase:freeform", and can be one of:
INIT
NO_RESULTS
ALL_STOPWORDS
String
query type.public boolean isDirectNav()
iphrase:direct navigation
(i.e. if getQueryType()
returns iphrase:direct navigation
).true
if this is a direct navigation resultpublic FeatureRow getDirectNavRow()
FeatureRow
for this result set, if
getQueryType()
returns iphrase:direct navigation
.FeatureRow
, or null if there is no direct nav rowpublic java.lang.String getDirectNavUri()
getQueryType()
returns iphrase:direct navigation
.
The client may choose to serve a redirect to the direct navigation URL.String
URI, or null if there is no direct nav URIpublic boolean isDirectAnswer()
iphrase:direct answer
(i.e. if getQueryType()
returns iphrase:direct answer
).boolean
true if this is a direct answer resultpublic int getRank()
int
rankpublic boolean isRenderSearchWithin()
boolean
true or falsepublic boolean getIsRenderSearchWithin()
isRenderSearchWithin()
, but starts with 'get' in order to
expose bean property to JSP/JSTL.boolean
true or falsepublic boolean isRenderPerPageOptions()
boolean
true or falsepublic boolean getIsRenderPerPageOptions()
isRenderPerPageOptions()
, but starts with 'get' in order to
expose bean property to JSP/JSTL.boolean
true or falsepublic boolean isRenderBreadcrumb()
boolean
true or falsepublic boolean getIsRenderBreadcrumb()
isRenderBreadcrumb()
, but starts with 'get' in order to
expose bean property to JSP/JSTL.boolean
true or falsepublic boolean isRemoveIndividualTerms()
boolean
true or falsepublic boolean getIsRemoveIndividualTerms()
isRemoveIndividualTerms()
, but starts with 'get' in order to
expose bean property to JSP/JSTL.boolean
true or falsepublic java.lang.String getIdentifier()
String
feature id.public java.lang.String getLabel()
String
label.public java.lang.String getHtmlBizRuleJavaScriptFunctionCall()
htmlBizRuleJavaScriptFunctionCall
- String
a JavaScript function call,
possibly with leading args, that accepts these three additional args:
public void setHtmlBizRuleJavaScriptFunctionCall(java.lang.String htmlBizRuleJavaScriptFunctionCall)
htmlBizRuleJavaScriptFunctionCall
- String
a JavaScript function call,
possibly with leading args, that accepts these three additional args:
public java.lang.String getHtmlBizRuleTitle()
public java.lang.String getHtmlBizRule()
setHtmlBizRuleJavaScriptFunctionCall(java.lang.String)
.
If htmlBizRuleJavaScriptFunctionCall
wasn't set, the links will remain as is (untransformed).
For example:
String
HTML source or null if there is no HTML bizrulepublic Table getTable()
Table
public Voiceover getVoiceover()
Voiceover
or null if there are no voiceover
details for this result set.public PageContext getPageContext()
PageContext
or null if there is no
page context for this result set.public TallyFeature[] getDrillDown()
getDrillDownPlus()
instead.
TallyFeature
[] array, which will have 0 elements if there
is no drill-down tally tree for this result set.public DrillDown getDrillDownPlus()
DrillDown
public TallyFeature[] getDrillSideways()
getDrillSidewaysPlus()
instead.
TallyFeature
[] array, which will have 0 elements if there
is no drill-sideways tally tree for this result set.public DrillSideways getDrillSidewaysPlus()
DrillSideways
public FeatureMetaData[] getGroupByOptions()
Query.setGroupByFeature(java.lang.String)
can view (group) results by one of these features.FeatureMetaData
array, which will have 0 elements if there
are no view-by options for this result set.public FeatureMetaData[] getViewByOptions()
Query.setViewByFeature(java.lang.String)
can view (group) results by one of these features.FeatureMetaData
array, which will have 0 elements if there
are no view-by options for this result set.getGroupByOptions()
public int getGroupBySelected()
int
option index, or -1 if no option is selected.getGroupByOptions()
public int getViewBySelected()
int
option index, or -1 if no option is selected.getGroupBySelected()
public FeatureMetaData[] getSummarizeByOptions()
Query.setSummarizeByFeatures(java.util.List)
can summarize results by one or more of these features.FeatureMetaData
array, which will have 0 elements if there
are no summarize-by options for this result set.public int getSummarizeBySelected()
int
option index, or -1 if no option is selected.getSummarizeByOptions()
public FeatureMetaData[] getSearchByOptions()
Query.setSearchFeatures(java.util.List)
can restrict a text query to one or more of these features.FeatureMetaData
array, which will have 0 elements if there
are no search-by options for this result set (no restriction possible).public FeatureMetaData[] getAddColumnOptions()
Query.setAddColumnFeatures(java.util.List)
will add one or more of these columns to the result table.FeatureMetaData
array, which will have 0 elements if there
are no additional column options for this result set.public FeatureMetaData[] getIrDrillDownOptions()
FeatureMetaData
array, which will have 0 elements if there
are no IR feature drill-down options for this result set.public SortFeature[] getSortByOptions()
SortFeature
array or null if there are no
sort-by options for this result set.public int getSortBySelected()
int
option index, or -1 if no option is selected.getSortByOptions()
public java.lang.String[] getHighlightTerms()
String
array of terms to highlight in rendered page,
or null if there are no highlight terms for this result set.public java.util.Hashtable getResponseHeaders()
String
.Hashtable
response header key/val pairs.public java.lang.Object getUserData()
Object
user defined data previously set to this
particular ResultSet.public void setUserData(java.lang.Object userData)
{@link
- Object} user defined object.public java.util.Hashtable getHooks()
String
.Hashtable
key/value pairs of custom data set by hooks
|
© Copyright 2005, 2006. IBM Corporation. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |