A B C D E F G H I J L M N O P Q R S T U V W

A

ArgumentError - exception com.iphrase.runtime.exception.ArgumentError.
Exception class thrown for invalid arguments to ctors and methods.
ArgumentError(String) - Constructor for class com.iphrase.runtime.exception.ArgumentError
Construct an ArgumentError exception from a detail message.
ASCENDING - Static variable in interface com.iphrase.runtime.query.SortFeature.Direction
Sort with increasing order of values.

B

Bool - class com.iphrase.runtime.query.constraint.Bool.
Represent a constraint for a boolean feature type.
BOOL - Static variable in interface com.iphrase.runtime.query.result.FeatureMetaData.BaseTypes
 
Bool(String, boolean) - Constructor for class com.iphrase.runtime.query.constraint.Bool
Construct a Bool constraint.

C

cleanUrl(String) - Static method in class com.iphrase.runtime.Tools
Clean up a URL as necessary.
clearExplicit() - Method in class com.iphrase.runtime.query.constraint.Constraint
Remove the "Explicit" flag.
clearHidden() - Method in class com.iphrase.runtime.query.constraint.Constraint
Reveal the constraint, i.e.
clearNew() - Method in class com.iphrase.runtime.query.constraint.Constraint
Specify that the constraint is carried over from past queries.
clearNotSerialized() - Method in class com.iphrase.runtime.query.constraint.Constraint
Specify that the constraint applies after IR pruning, i.e., make it 'not prepruned'.
clearPrePruned() - Method in class com.iphrase.runtime.query.constraint.Constraint
Specify that the constraint applies after IR pruning, i.e., make it 'not prepruned'.
clearRequired() - Method in class com.iphrase.runtime.query.constraint.Constraint
Optionalize the constraint, i.e.
clearState(int) - Method in class com.iphrase.runtime.query.constraint.Constraint
Clear the custom state
clone(String[]) - Static method in class com.iphrase.runtime.Tools
Clone a source String array by returning either a 0-element String array, if the source array is null, otherwise the source array itself.
close() - Method in class com.iphrase.runtime.Connector
Release this Connector object's resources immediately instead of waiting for them to be automatically released.
com.iphrase.runtime - package com.iphrase.runtime
Top-level package for the Java Runtime API - this is where you can start.
com.iphrase.runtime.exception - package com.iphrase.runtime.exception
Exception classes used throughout the API.
com.iphrase.runtime.query - package com.iphrase.runtime.query
Query classes for building and sending search queries to the API.
com.iphrase.runtime.query.constraint - package com.iphrase.runtime.query.constraint
Constraint and related collection classes for creating and building boolean combinations of query constraints.
com.iphrase.runtime.query.result - package com.iphrase.runtime.query.result
QueryResult and related classes that represent the content and structure of the results of a query execution.
ConfigurationError - error com.iphrase.runtime.exception.ConfigurationError.
Exception class thrown for mis-configurations.
ConfigurationError(String) - Constructor for class com.iphrase.runtime.exception.ConfigurationError
Construct a ConfigurationError exception from a detail message.
Conjunction - class com.iphrase.runtime.query.constraint.Conjunction.
Represent a collection of constraint Disjunction instances ANDed together by this conjunction.
Conjunction() - Constructor for class com.iphrase.runtime.query.constraint.Conjunction
 
Conjunction(String) - Constructor for class com.iphrase.runtime.query.constraint.Conjunction
 
Connector - class com.iphrase.runtime.Connector.
Maintains a collection of iPhrase servers and properties for failover, and creates Query objects that can execute themselves against those servers.
ConnectorFactory - class com.iphrase.runtime.ConnectorFactory.
A ConnectorFactory instance is used to create Connector objects.
ConnectorFactory() - Constructor for class com.iphrase.runtime.ConnectorFactory
 
Constraint - class com.iphrase.runtime.query.constraint.Constraint.
Abstract base class for all atomic constraints.
Constraint.Flags - interface com.iphrase.runtime.query.constraint.Constraint.Flags.
Define Constraint feature flag values.
contains(Constraint) - Method in class com.iphrase.runtime.query.constraint.Conjunction
Determine if the designated constraint is the same as a constraint in one of the disjunctions in this conjunction.
contains(Disjunction) - Method in class com.iphrase.runtime.query.constraint.Conjunction
Determine if the designated disjunction is the same as one of the disjunctions int this conjunction.
copy(String[]) - Static method in class com.iphrase.runtime.Tools
Copy a source String array by allocating a target array of the same length and doing a shallow copy of each source to target element.
createQuery() - Method in class com.iphrase.runtime.Connector
Create a new Query with no prior state.
createQuery(String) - Method in class com.iphrase.runtime.Connector
Create a new Query from a query state string.
cull(Conjunction) - Method in class com.iphrase.runtime.query.constraint.Conjunction
 
cull(Constraint) - Method in class com.iphrase.runtime.query.constraint.Disjunction
Cull a constraint from this disjunction.
cull(Disjunction) - Method in class com.iphrase.runtime.query.constraint.Conjunction
Cull a disjunction from this conjunction.
CUSTOM - Static variable in interface com.iphrase.runtime.query.result.FeatureMetaData.BaseTypes
 

D

DATE_TIME - Static variable in interface com.iphrase.runtime.query.result.FeatureMetaData.BaseTypes
 
DateTime - class com.iphrase.runtime.query.constraint.DateTime.
Represent constraints for datetime feature types.
DateTime.Eq - class com.iphrase.runtime.query.constraint.DateTime.Eq.
Constrain a feature to be equal to a particular date.
DateTime.Eq(String, Calendar) - Constructor for class com.iphrase.runtime.query.constraint.DateTime.Eq
Construct a feature == date constraint.
DateTime.Gt - class com.iphrase.runtime.query.constraint.DateTime.Gt.
Constrain a feature to be greater than a particular date.
DateTime.Gt(String, Calendar) - Constructor for class com.iphrase.runtime.query.constraint.DateTime.Gt
Construct a feature > date constraint.
DateTime.Gte - class com.iphrase.runtime.query.constraint.DateTime.Gte.
Constrain a feature to be greater than or equal to a particular date.
DateTime.Gte(String, Calendar) - Constructor for class com.iphrase.runtime.query.constraint.DateTime.Gte
Construct a feature >= date constraint.
DateTime.Lt - class com.iphrase.runtime.query.constraint.DateTime.Lt.
Constrain a feature to be less than a particular date.
DateTime.Lt(String, Calendar) - Constructor for class com.iphrase.runtime.query.constraint.DateTime.Lt
Construct a feature < date constraint.
DateTime.Lte - class com.iphrase.runtime.query.constraint.DateTime.Lte.
Constrain a feature to be less than or equal to a particular date.
DateTime.Lte(String, Calendar) - Constructor for class com.iphrase.runtime.query.constraint.DateTime.Lte
Construct a feature <= date constraint.
DateTime.Neq - class com.iphrase.runtime.query.constraint.DateTime.Neq.
Constrain a feature to be not equal to a particular date.
DateTime.Neq(String, Calendar) - Constructor for class com.iphrase.runtime.query.constraint.DateTime.Neq
Construct a feature != date constraint.
DateTime.Range - class com.iphrase.runtime.query.constraint.DateTime.Range.
Represent a range-comparison DateTime constraint.
DateTime.Range(DateTime, DateTime) - Constructor for class com.iphrase.runtime.query.constraint.DateTime.Range
Construct a DateTime range constraint from two DateTime constraints.
decode(String, String) - Static method in class com.iphrase.runtime.Tools
Decodes an application/x-www-form-urlencoded string using a specific encoding scheme.
DEFAULT - Static variable in interface com.iphrase.runtime.query.SortFeature.Direction
Sort by the engine-configured default.
DESCENDING - Static variable in interface com.iphrase.runtime.query.SortFeature.Direction
Sort with decreasing order of values.
Disjunction - class com.iphrase.runtime.query.constraint.Disjunction.
Represent a collection of Constraint instances ORed together by this disjunction.
Disjunction() - Constructor for class com.iphrase.runtime.query.constraint.Disjunction
Create an empty constraint disjunction.
Disjunction(Constraint) - Constructor for class com.iphrase.runtime.query.constraint.Disjunction
Construct a disjunction from a single constraint.
DrillDown - class com.iphrase.runtime.query.result.DrillDown.
Represent drill-down navigation information.
DrillSideways - class com.iphrase.runtime.query.result.DrillSideways.
Represent drill-sideways navigation information.

E

elapsed(long, String) - Static method in class com.iphrase.runtime.Timer
Print elapsed time since t0 as well as other timing statistics along with the thread name Timer.setUniqueThreadName(), passed op, and additional adornments.
encode(String, String) - Static method in class com.iphrase.runtime.Tools
Translates a string into application/x-www-form-urlencoded format using a specific encoding scheme.
Enumerated - class com.iphrase.runtime.query.constraint.Enumerated.
Represent constraints for enumerated feature types.
Enumerated.Equals - class com.iphrase.runtime.query.constraint.Enumerated.Equals.
Constrain a feature to be equal to a particular enumerated value.
Enumerated.Equals(String, String) - Constructor for class com.iphrase.runtime.query.constraint.Enumerated.Equals
Construct an Enumerated.Equals constraint.
Enumerated.InList - class com.iphrase.runtime.query.constraint.Enumerated.InList.
Constrain a feature to be within a list of enumerated values.
Enumerated.InList(String, List) - Constructor for class com.iphrase.runtime.query.constraint.Enumerated.InList
Construct an Enumerated.InList constraint.
Enumerated.InList(String, String[]) - Constructor for class com.iphrase.runtime.query.constraint.Enumerated.InList
Construct an Enumerated.InList constraint.
Enumerated.NotEquals - class com.iphrase.runtime.query.constraint.Enumerated.NotEquals.
Constrain a feature to be not equal to a particular enumerated value.
Enumerated.NotEquals(String, String) - Constructor for class com.iphrase.runtime.query.constraint.Enumerated.NotEquals
Construct an Enumerated.NotEquals constraint.
Enumerated.NotInList - class com.iphrase.runtime.query.constraint.Enumerated.NotInList.
Constrain a feature to be not within a list of enumerated values.
Enumerated.NotInList(String, List) - Constructor for class com.iphrase.runtime.query.constraint.Enumerated.NotInList
Construct an Enumerated.NotInList constraint.
Enumerated.NotInList(String, String[]) - Constructor for class com.iphrase.runtime.query.constraint.Enumerated.NotInList
Construct an Enumerated.NotInList constraint.
equals(Object) - Method in class com.iphrase.runtime.query.constraint.Constraint
Determine whether this Constraint is equivalent to another, passed as an Object because this method overrides Object.equals(java.lang.Object).
equals(Object) - Method in class com.iphrase.runtime.query.result.Taxonomy
Override Object.equals(java.lang.Object)
equals(Object) - Method in class com.iphrase.runtime.query.result.ImageUrl
Override Object.equals(java.lang.Object)
equals(Object) - Method in class com.iphrase.runtime.query.result.TextExtract
Override Object.equals(java.lang.Object)
equals(Object) - Method in class com.iphrase.runtime.query.result.TextExtract.Span
Override Object.equals(java.lang.Object)
equals(Object) - Method in class com.iphrase.runtime.query.result.TallyFeature.Value
Override Object.equals(java.lang.Object)
equals(Object) - Method in class com.iphrase.runtime.query.result.Link
Override Object.equals(java.lang.Object)
equals(Object) - Method in class com.iphrase.runtime.query.result.Summarized.Bool
Override Object.equals(java.lang.Object)
equals(Object) - Method in class com.iphrase.runtime.query.result.Summarized.DateTime
Override Object.equals(java.lang.Object)
equals(Object) - Method in class com.iphrase.runtime.query.result.Summarized.Float
Override Object.equals(java.lang.Object)
equals(Object) - Method in class com.iphrase.runtime.query.result.Summarized.Int
Override Object.equals(java.lang.Object)
equals(Object) - Method in class com.iphrase.runtime.query.result.Summarized.Text
Override Object.equals(java.lang.Object)
equals(Object) - Method in class com.iphrase.runtime.query.result.Summarized.TextExtract
Override Object.equals(java.lang.Object)
equals(Object) - Method in class com.iphrase.runtime.query.result.Summarized.Taxonomy
Override Object.equals(java.lang.Object)
equals(Object) - Method in class com.iphrase.runtime.query.result.Summarized.Link
Override Object.equals(java.lang.Object)
equals(Object) - Method in class com.iphrase.runtime.query.result.Summarized.ImageUrl
Override Object.equals(java.lang.Object)
escape(String, String) - Static method in class com.iphrase.runtime.Tools
Escape any occurance of delim in the designated string by doubling it.
escape(String, String[]) - Static method in class com.iphrase.runtime.Tools
Escape any occurance of all delimeters in the designated string by doubling them.
escapeJS(String) - Static method in class com.iphrase.runtime.Tools
Convert problem characters to JavaScript Escaped values.
Example - class com.iphrase.runtime.query.constraint.Example.
Represent a "query by example" constraint.
Example(String, String, List) - Constructor for class com.iphrase.runtime.query.constraint.Example
Create an Example constraint.
Example(String, String, String[]) - Constructor for class com.iphrase.runtime.query.constraint.Example
Create an Example constraint.
execute() - Method in class com.iphrase.runtime.query.Query
Submit this query to an iPhrase server.
execute(Query) - Method in class com.iphrase.runtime.Connector
Submit a Query to an iPhrase server.

F

Feature - class com.iphrase.runtime.query.Feature.
Represent an iPhrase OneStep feature for a query request.
Feature - class com.iphrase.runtime.query.result.Feature.
Represent an iPhrase OneStep feature for a query result.
Feature.Flags - interface com.iphrase.runtime.query.result.Feature.Flags.
Define QueryResult feature flag values.
Feature(String) - Constructor for class com.iphrase.runtime.query.Feature
Construct a feature with id and no flags.
Feature(String, int) - Constructor for class com.iphrase.runtime.query.Feature
Construct a feature with id and flags.
FeatureMetaData - class com.iphrase.runtime.query.result.FeatureMetaData.
Represent the feature metadata for each column of a result set table.
FeatureMetaData.BaseTypes - interface com.iphrase.runtime.query.result.FeatureMetaData.BaseTypes.
Enumerate the currently-supported iPhrase feature base types.
FeatureRow - class com.iphrase.runtime.query.result.FeatureRow.
Represent a single row of a result set table.
FLOAT - Static variable in interface com.iphrase.runtime.query.result.FeatureMetaData.BaseTypes
 

G

GeneralError - exception com.iphrase.runtime.exception.GeneralError.
General exception used as a base class for all other exceptions thrown by Runtime API.
GeneralError(String) - Constructor for class com.iphrase.runtime.exception.GeneralError
Construct a WebServiceError exception from a detail message.
getAddColumnFeatures() - Method in class com.iphrase.runtime.query.Query
Get the features that are requested as additional columns for the result table.
getAddColumnOptions() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the additional column (aka add-column) options for this result set.
getAlt() - Method in class com.iphrase.runtime.query.result.ImageUrl
Get the alt text for this image URL value.
getAnchor() - Method in class com.iphrase.runtime.query.result.Link
Get the anchor for this link value.
getAttributes() - Method in class com.iphrase.runtime.query.result.FeatureMetaData
Get the feature attributes hash table.
getAttributes() - Method in class com.iphrase.runtime.query.result.QueryResult
Get the attributes hash table.
getAtts() - Method in class com.iphrase.runtime.query.result.TextExtract.Span
Get the attributes for this span.
getAutoSummarizeHardLimit() - Method in class com.iphrase.runtime.query.Query
Get the hard count limit for summarization.
getAutoSummarizeSoftLimit() - Method in class com.iphrase.runtime.query.Query
Get the soft limit for summarization.
getBackoffPhrases() - Method in class com.iphrase.runtime.query.result.Voiceover
Get the backoff phrases, for which constraints were backed off.
getBaseType() - Method in class com.iphrase.runtime.query.result.FeatureMetaData
Get the feature base type, a FeatureMetaData.BaseTypes value.
getCause() - Method in class com.iphrase.runtime.exception.GeneralError
Returns cause exception
getChildren() - Method in class com.iphrase.runtime.query.result.TallyFeature.Value
Get the tally feature value children associated with this tally feature value.
getClientIp() - Method in class com.iphrase.runtime.query.Query
Get the client IP address that will be sent with this query.
getComponents() - Method in class com.iphrase.runtime.query.result.Taxonomy
Get the components for this taxonomy value.
getComponents() - Method in class com.iphrase.runtime.query.result.TallyFeature.Value
Get the array of Object components for this tally feature value.
getConnector(List, float, float) - Method in class com.iphrase.runtime.ConnectorFactory
Create and return a properly-constructed Connector.
getConnectorSingleton(List, float, float) - Method in class com.iphrase.runtime.ConnectorFactory
Create and return a properly-constructed Connector singleton.
getConstrainedValue() - Method in class com.iphrase.runtime.query.result.TallyFeature
Get the constrained tally feature value associated with this tally feature.
getConstraint(String) - Method in class com.iphrase.runtime.query.result.TallyFeature.Value
Get a Constraint instance used to compute the tallies for this value.
getConstraintLabel() - Method in class com.iphrase.runtime.query.constraint.Constraint
Gets the (optional) constraint label.
getConstraintLabel() - Method in class com.iphrase.runtime.query.result.TallyFeature.Value
Get the (optional) constraint label used to compute the tallies for this value.
getConstraintOp() - Method in class com.iphrase.runtime.query.result.TallyFeature.Value
Get the constraint op used to compute the tallies for this value.
getConstraints() - Method in class com.iphrase.runtime.query.Query
Get the constraints to be used when retrieving results.
getConstraintSubType() - Method in class com.iphrase.runtime.query.constraint.Constraint
 
getConstraintSubType() - Method in class com.iphrase.runtime.query.constraint.Mentions
Determine subType representation of the non-range inequality constraints
getConstraintSubType() - Method in class com.iphrase.runtime.query.constraint.DateTime
Determine subType representation of the non-range inequality constraints
getConstraintSubType() - Method in class com.iphrase.runtime.query.constraint.DateTime.Range
 
getConstraintSubType() - Method in class com.iphrase.runtime.query.constraint.Null
Determine subType representation of the non-range inequality constraints
getConstraintSubType() - Method in class com.iphrase.runtime.query.constraint.Enumerated
Determine subType representation of the non-range inequality constraints
getConstraintSubType() - Method in class com.iphrase.runtime.query.constraint.Taxonomy
Determine subType representation of the non-range inequality constraints
getConstraintSubType() - Method in class com.iphrase.runtime.query.constraint.Numeric
Determine subType representation of the non-range inequality constraints
getConstraintSubType() - Method in class com.iphrase.runtime.query.constraint.Numeric.Range
Determine subType representation of the non-range inequality constraints
getConstraintSubType() - Method in class com.iphrase.runtime.query.constraint.Text
Determine subType representation of the non-range inequality constraints
getConstraintSubType() - Method in class com.iphrase.runtime.query.constraint.Bool
Determine subType representation of the non-range inequality constraints
getConstraintSubType() - Method in class com.iphrase.runtime.query.constraint.Example
 
getConstraintSubType() - Method in class com.iphrase.runtime.query.constraint.Within
Determine subType representation of the non-range inequality constraints
getConstraintType() - Method in class com.iphrase.runtime.query.result.TallyFeature.Value
Get the constraint type used to compute the tallies for this value.
getCookie() - Method in class com.iphrase.runtime.query.Query
Get the cookie string that will be sent with this query.
getCurrentPage() - Method in class com.iphrase.runtime.query.result.PageContext
Get the current page number for this query result, starting at 0.
getData(String) - Method in class com.iphrase.runtime.query.Query
Get the data value corresponding to "data[key]", where [key] is replaced by its value, resulting from a previous call to Query.setData(java.lang.String, java.lang.String).
getDfltEncName() - Static method in class com.iphrase.runtime.Tools
 
getDirection() - Method in class com.iphrase.runtime.query.SortFeature
Get the sort feature SortFeature.Direction value.
getDirection() - Method in class com.iphrase.runtime.query.result.SortFeature
Get the sorting direction for this feature.
getDirectNavRow() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the direct navigation FeatureRow for this result set, if ResultSet.getQueryType() returns iphrase:direct navigation.
getDirectNavUri() - Method in class com.iphrase.runtime.query.result.Table
Get the direct navigation URI for this table, or null if there is none.
getDirectNavUri() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the direct navigation URI for this result set, if ResultSet.getQueryType() returns iphrase:direct navigation.
getDirectResultSets() - Method in class com.iphrase.runtime.query.result.QueryResult
Get any direct nav or direct answer (presentation rank > 1) result sets.
getDisplayPrefix() - Method in class com.iphrase.runtime.query.constraint.Constraint
Returns constraint display prefix.
getDisplayPrefix() - Method in class com.iphrase.runtime.query.constraint.Taxonomy
Returns constraint display prefix.
getDisplayPrefix() - Method in class com.iphrase.runtime.query.constraint.Within
 
getDrillDown() - Method in class com.iphrase.runtime.query.result.ResultSet
Deprecated. clients should use ResultSet.getDrillDownPlus() instead.
getDrillDownPlus() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the drill-down (aka refine-by) information for this result set.
getDrillSideways() - Method in class com.iphrase.runtime.query.result.ResultSet
Deprecated. clients should use ResultSet.getDrillSidewaysPlus() instead.
getDrillSidewaysPlus() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the drill-sideways (aka breadcrumb) information for this result set.
getEnableAutoSummarize() - Method in class com.iphrase.runtime.query.Query
Determine whether auto-summarization is enabled.
getEnableSearchWithin() - Method in class com.iphrase.runtime.query.Query
Return whether or not this query will search within the current results.
getEndRow() - Method in class com.iphrase.runtime.query.result.PageContext
Get the 0-based number of the row AFTER the last row of this query result.
getExpandDrillDownFeature() - Method in class com.iphrase.runtime.query.Query
Get the drillDown feature to expand (i.e.
getExpandedWords() - Method in class com.iphrase.runtime.query.result.Voiceover
Get the expanded words.
getExpansions() - Method in class com.iphrase.runtime.query.result.Voiceover.WordExpansion
Get the array of expansions for the word.
getExtracts() - Method in class com.iphrase.runtime.query.result.Summarized.TextExtract
Get the array of text strings associated with this summarized text extract.
getFeatureMetaDatas() - Method in class com.iphrase.runtime.query.result.Table
Get the feature metadata array for this table.
getFeatureRows() - Method in class com.iphrase.runtime.query.result.Table
Get the array of feature rows for this table.
getFeatureValue() - Method in class com.iphrase.runtime.query.result.TallyFeature.Value
Get the feature value associated with this tally feature value.
getFeatureValues() - Method in class com.iphrase.runtime.query.result.FeatureRow
Get the array of feature values for this row.
getFlags() - Method in class com.iphrase.runtime.query.result.FeatureMetaData
Get the set of ORed flag values.
getFlags(FeatureMetaData) - Method in class com.iphrase.runtime.query.result.TallyFeature.Value
Get the tally feature flags specialized for this value.
getGroupByFeature() - Method in class com.iphrase.runtime.query.Query
Get the group-by (aka view-by) feature, or null if no group-by feature has been set.
getGroupByOptions() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the group-by (aka view-by) options for this result set.
getGroupBySelected() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the index of the currently selected group-by (aka view-by) option.
getGroupBySortFeature() - Method in class com.iphrase.runtime.query.Query
Get the sort feature by which results are sorted within group-by (aka view-by) groups.
getGroupBySortIsByTally() - Method in class com.iphrase.runtime.query.Query
Determine whether group-by (aka view-by) grouped results are sorted by tally count or not (alphabetically is the default).
getHighlightTerms() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the highlight terms for this result set.
getHooks() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the hooks hash table.
getHooks() - Method in class com.iphrase.runtime.query.result.QueryResult
Get the hooks hash table.
getHref() - Method in class com.iphrase.runtime.query.result.Link
Get the HREF for this link value.
getHtmlBizRule() - Method in class com.iphrase.runtime.query.result.ResultSet
If this result set is an HTML business rule, return the HTML, else null.
getHtmlBizRuleJavaScriptFunctionCall() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the JavaScript function used for click-through logging.
getHtmlBizRuleTitle() - Method in class com.iphrase.runtime.query.result.ResultSet
If this result set is an HTML business rule, this is the HTML business rule title.
getId() - Method in class com.iphrase.runtime.query.Feature
Get the feature id (aka name).
getIdentifier() - Method in class com.iphrase.runtime.query.Query
Gets the identifier feature.
getIdentifier() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the OneStep identifier feature id for this result set.
getImageUrls() - Method in class com.iphrase.runtime.query.result.Summarized.ImageUrl
Get the array of image URLs associated with this summarized image URL.
getIrDrillDownOptions() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the IR feature drill-down options for this result set.
getIsDidYouMeanMode() - Method in class com.iphrase.runtime.query.result.Voiceover.Respelling
 
getIsDirectoryFeature() - Method in class com.iphrase.runtime.query.result.FeatureMetaData
Determine whether this is the directory feature (guided navigation).
getIsIdentifier() - Method in class com.iphrase.runtime.query.result.FeatureMetaData
Determine whether the column is a OneStep identifier feature.
getIsLogClickThrough() - Method in class com.iphrase.runtime.query.result.FeatureMetaData
Determine whether features in this column should log click-through data.
getIsMaxFeaturesExceeded() - Method in class com.iphrase.runtime.query.result.DrillDown
Determine whether the configured maximum # of features has been exceeded.
getIsMaxValuesExceeded() - Method in class com.iphrase.runtime.query.result.FeatureMetaData
Determine whether the configured maximum # of values/feature has been exceeded (drillDown).
getIsMentions() - Method in class com.iphrase.runtime.query.constraint.Constraint
Determine if this constraint is an instance of type Mentions.
getIsRefineShowCounts() - Method in class com.iphrase.runtime.query.result.FeatureMetaData
Determine whether feature should show 'includes counts' option.
getIsRemoveIndividualTerms() - Method in class com.iphrase.runtime.query.result.ResultSet
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.
getIsRenderBreadcrumb() - Method in class com.iphrase.runtime.query.result.ResultSet
Determine whether or not the breadcrumb should be rendered.
getIsRenderPerPageOptions() - Method in class com.iphrase.runtime.query.result.ResultSet
Determine whether or not the per-page options control should be rendered.
getIsRenderSearchWithin() - Method in class com.iphrase.runtime.query.result.ResultSet
Determine whether or not the search within control should be rendered.
getIsSummarized() - Method in class com.iphrase.runtime.query.result.FeatureMetaData
Determine whether the column values are summarized.
getIsTabFeature() - Method in class com.iphrase.runtime.query.result.FeatureMetaData
Determine whether this is the tab feature (drillDown).
getIsTallied() - Method in class com.iphrase.runtime.query.result.FeatureMetaData
Determine whether the column contains tallied feature values.
getIsTruncated() - Method in class com.iphrase.runtime.query.result.Summarized.Text
Determine if the summarized list was truncated (limited) by the server.
getIsTruncated() - Method in class com.iphrase.runtime.query.result.Summarized.TextExtract
Determine if the summarized list was truncated (limited) by the server.
getIsTruncated() - Method in class com.iphrase.runtime.query.result.Summarized.Taxonomy
Determine if the summarized list was truncated (limited) by the server.
getIsTruncated() - Method in class com.iphrase.runtime.query.result.Summarized.Link
Determine if the summarized list was truncated (limited) by the server.
getIsTruncated() - Method in class com.iphrase.runtime.query.result.Summarized.ImageUrl
Determine if the summarized list was truncated (limited) by the server.
getIsViewBy() - Method in class com.iphrase.runtime.query.result.FeatureMetaData
Determine whether the column is the view-by (aka group-by) feature.
getIsViewByFeature() - Method in class com.iphrase.runtime.query.result.FeatureMetaData
Determine whether this is the view-by (aka group-by) feature (drillDown).
getLabel() - Method in class com.iphrase.runtime.query.result.Feature
Get the feature label, i.e.
getLabel() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the display name of this result set.
getLabels() - Method in class com.iphrase.runtime.query.constraint.Mentions
Get the text labels associated with this Mentions constraint.
getLinks() - Method in class com.iphrase.runtime.query.result.Summarized.Link
Get the array of links associated with this summarized link.
getLinkUrl() - Method in class com.iphrase.runtime.query.result.TextExtract
Get the link associated with this TextExtract.
getMainResultSet() - Method in class com.iphrase.runtime.query.result.QueryResult
Get the main (presentation rank == 1) result set.
getMax() - Method in class com.iphrase.runtime.query.result.Summarized.DateTime
Get the maximum value of this summarized type.
getMax() - Method in class com.iphrase.runtime.query.result.Summarized.Float
Get the maximum value of this summarized type.
getMax() - Method in class com.iphrase.runtime.query.result.Summarized.Int
Get the maximum value of this summarized type.
getMin() - Method in class com.iphrase.runtime.query.result.Summarized.DateTime
Get the minimum value of this summarized type.
getMin() - Method in class com.iphrase.runtime.query.result.Summarized.Float
Get the minimum value of this summarized type.
getMin() - Method in class com.iphrase.runtime.query.result.Summarized.Int
Get the minimum value of this summarized type.
getNoContentKnownConcepts() - Method in class com.iphrase.runtime.query.result.Voiceover
Get the known concepts from the query for which there is no indexed content.
getOperatorByTermIndex(int, String, String) - Method in class com.iphrase.runtime.query.constraint.Mentions
Returnes andStr or orStr depends on the boolean operator used for termIndex search
getOriginal() - Method in class com.iphrase.runtime.query.result.Voiceover.Respelling.RespelledWord
Get the original spelling of the word.
getOtherResultSets() - Method in class com.iphrase.runtime.query.result.QueryResult
Get any other (presentation rank > 1) result sets that are neither main nor direct.
getPageContext() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the page context for this result set.
getPageNumber() - Method in class com.iphrase.runtime.query.Query
Get the 0-based page number to return in the query result.
getParam(String) - Method in class com.iphrase.runtime.query.Query
Gets a query parameter by its name
getPassword() - Method in class com.iphrase.runtime.Connector
Get the authentication password.
getPrimarySortByFeature() - Method in class com.iphrase.runtime.query.Query
Get the primary sort feature.
getQuerySubType() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the sub-type of the query which begat this result set.
getQueryType() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the type of the query which begat this result set.
getRank() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the presentation rank of this result set.
getRedirectLocation() - Method in class com.iphrase.runtime.query.result.QueryResult
The URL to redirect to, or empty string if no redirection is required.
getRefererUrl() - Method in class com.iphrase.runtime.query.Query
Get the referer URL that will be sent with this query.
getRemoveIndex(String) - Method in class com.iphrase.runtime.query.constraint.Mentions
 
getResolvedQuery() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the resolved Query which begat this result set.
getResolvedQueryState() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the OneStep serialization String for the resolved Query which begat this result set.
getRespelled() - Method in class com.iphrase.runtime.query.result.Voiceover.Respelling.RespelledWord
Get the respelled version of the word.
getRespelledQuery() - Method in class com.iphrase.runtime.query.result.Voiceover.Respelling
Return the respelled text that would apply the respellings to the query.
getRespelledWords() - Method in class com.iphrase.runtime.query.result.Voiceover.Respelling
Get the array of respelled words.
getRespelling() - Method in class com.iphrase.runtime.query.result.Voiceover
Get the respelling information that took place for this query result.
getResponseHeaders() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the response headers hash table.
getResultSets() - Method in class com.iphrase.runtime.query.result.QueryResult
Get all of the ResultSet instances.
getRetrySeconds() - Method in class com.iphrase.runtime.Connector
Get the retry interval in seconds used by this instance.
getRowsPerPage() - Method in class com.iphrase.runtime.query.Query
Get the number of rows (results) per page.
getSearchByFeatures() - Method in class com.iphrase.runtime.query.Query
Get the features that this query will search.
getSearchByOptions() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the search-by (aka set feature) options for this result set.
getSearchFeatures() - Method in class com.iphrase.runtime.query.Query
Deprecated. call getSearchByFeatures instead
getServers() - Method in class com.iphrase.runtime.Connector
Get the list of servers used by this instance.
getSortByFeatures() - Method in class com.iphrase.runtime.query.Query
Gets the array of SortFeature used to sort results.
getSortByOptions() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the sort-by options for this result set.
getSortBySelected() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the index of the currently selected sort-by option.
getSourceOptions() - Method in class com.iphrase.runtime.query.result.QueryResult
Get the source options for this result set.
getSourceSelected() - Method in class com.iphrase.runtime.query.result.QueryResult
Get the index of the currently selected source option.
getSpans() - Method in class com.iphrase.runtime.query.result.TextExtract
Get the TextExtract.Span array associated with this TextExtract.
getSrc() - Method in class com.iphrase.runtime.query.result.ImageUrl
Get the src URL for this image URL value.
getStartRow() - Method in class com.iphrase.runtime.query.result.PageContext
Get the 0-based number of the first row of this query result.
getState() - Method in class com.iphrase.runtime.query.Query
Get the state string (serialization) of this query.
getState(int) - Method in class com.iphrase.runtime.query.constraint.Constraint
Determine if the custom state is set.
getStopwords() - Method in class com.iphrase.runtime.query.result.Voiceover
Get the stopwords (ignored).
getStrings() - Method in class com.iphrase.runtime.query.result.Summarized.Text
Get the array of text strings associated with this summarized text.
getSummarizationAttribute() - Method in class com.iphrase.runtime.query.result.PageContext
Get the summarization feature for this query result.
getSummarizeByFeatures() - Method in class com.iphrase.runtime.query.Query
Get the features used to summarize results.
getSummarizeByOptions() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the summarize-by options for this result set.
getSummarizeBySelected() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the index of the currently selected summarize-by option.
getSynonymExpansions() - Method in class com.iphrase.runtime.query.result.Voiceover
Get the synonym expansions for this query result.
getTable() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the table for this result set.
getTallyCount() - Method in class com.iphrase.runtime.query.result.TallyFeature.Value
Get the tally count for this tally feature value.
getTallyFeatures() - Method in class com.iphrase.runtime.query.result.DrillSideways
Get the TallyFeature array for this DrillSideways.
getTallyFeatures() - Method in class com.iphrase.runtime.query.result.DrillDown
Get the TallyFeature array for this DrillDown.
getTaxonomies() - Method in class com.iphrase.runtime.query.result.Summarized.Taxonomy
Get the array of taxonomies associated with this summarized taxonomy.
getTerms() - Method in class com.iphrase.runtime.query.constraint.Mentions
Get the text terms associated with this Mentions constraint.
getText() - Method in class com.iphrase.runtime.query.Query
Get the end-user's query text.
getText() - Method in class com.iphrase.runtime.query.result.TextExtract.Span
Get the text string for this span.
getTextHistory() - Method in class com.iphrase.runtime.query.Query
Get the user's query text search within history.
getTextRemoveTerm(Mentions) - Method in class com.iphrase.runtime.query.Query
Get the term to be removed from the end-user's query text.
getTimeoutSeconds() - Method in class com.iphrase.runtime.Connector
Get the timeout in seconds used by this instance.
getTotalItems() - Method in class com.iphrase.runtime.query.result.PageContext
Get the total number of items for the entire query result.
getTotalPages() - Method in class com.iphrase.runtime.query.result.PageContext
Get the total number of pages for the entire query result.
getTotalRows() - Method in class com.iphrase.runtime.query.result.PageContext
Get the total number of rows for the entire query result.
getTruncationCount() - Method in class com.iphrase.runtime.query.Query
Get the truncation count.
getTruncationFeature() - Method in class com.iphrase.runtime.query.Query
Get the truncation feature.
getTruncationTrigger() - Method in class com.iphrase.runtime.query.Query
Get the truncation trigger.
getType() - Method in class com.iphrase.runtime.query.constraint.Constraint
 
getUserAgent() - Method in class com.iphrase.runtime.query.Query
Get the user agent that will be sent with this query.
getUserData() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the userData object.
getUsername() - Method in class com.iphrase.runtime.Connector
Get the authentication username.
getValue() - Method in class com.iphrase.runtime.query.constraint.Constraint
Get the value associated with this constraint.
getValue() - Method in class com.iphrase.runtime.query.constraint.Mentions
Get the value associated with this constraint.
getValue() - Method in class com.iphrase.runtime.query.constraint.DateTime
Get the value associated with this constraint.
getValue() - Method in class com.iphrase.runtime.query.constraint.DateTime.Range
Get the value associated with this constraint.
getValue() - Method in class com.iphrase.runtime.query.constraint.Null
Get the value associated with this constraint.
getValue() - Method in class com.iphrase.runtime.query.constraint.Enumerated
Get the value associated with this constraint.
getValue() - Method in class com.iphrase.runtime.query.constraint.Taxonomy
Get the value associated with this constraint.
getValue() - Method in class com.iphrase.runtime.query.constraint.Numeric
Get the value associated with this constraint.
getValue() - Method in class com.iphrase.runtime.query.constraint.Numeric.Range
Get the value associated with this constraint.
getValue() - Method in class com.iphrase.runtime.query.constraint.Text
Get the value associated with this constraint.
getValue() - Method in class com.iphrase.runtime.query.constraint.Bool
Get the value associated with this constraint.
getValue() - Method in class com.iphrase.runtime.query.constraint.Example
Get the value associated with this constraint.
getValue() - Method in class com.iphrase.runtime.query.constraint.Within
Get the value associated with this constraint.
getValues() - Method in class com.iphrase.runtime.query.result.TallyFeature
Get the tally feature values associated with this tally feature.
getVersion() - Static method in class com.iphrase.runtime.Tools
 
getViewByFeature() - Method in class com.iphrase.runtime.query.Query
Get the view-by (aka group-by) feature, or null if no view-by feature has been set.
getViewByOptions() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the view-by (aka group-by) options for this result set.
getViewBySelected() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the index of the currently selected view-by (aka group-by) option.
getVoiceover() - Method in class com.iphrase.runtime.query.result.ResultSet
Get the voiceover details for this result set.
getWord() - Method in class com.iphrase.runtime.query.result.Voiceover.WordExpansion
Get the original word or concept.

H

hasFalse() - Method in class com.iphrase.runtime.query.result.Summarized.Bool
Return true if the collection of booleans contains a false value.
hasTrue() - Method in class com.iphrase.runtime.query.result.Summarized.Bool
Return true if the collection of booleans contains a true value.

I

IMAGE_URL - Static variable in interface com.iphrase.runtime.query.result.FeatureMetaData.BaseTypes
 
ImageUrl - class com.iphrase.runtime.query.result.ImageUrl.
Represent an image URL feature value.
INT - Static variable in interface com.iphrase.runtime.query.result.FeatureMetaData.BaseTypes
 
isClosed() - Method in class com.iphrase.runtime.Connector
Determine whether this Connector object has been closed via the Connector.close() method.
isDirectAnswer() - Method in class com.iphrase.runtime.query.result.ResultSet
Determine if this result set is of type iphrase:direct answer (i.e.
isDirectNav() - Method in class com.iphrase.runtime.query.result.ResultSet
Determine if this result set is of type iphrase:direct navigation (i.e.
isDirectNavUri() - Method in class com.iphrase.runtime.query.result.FeatureMetaData
Determine whether the column contains the direct navigation URI.
isDirectoryFeature() - Method in class com.iphrase.runtime.query.result.FeatureMetaData
Determine whether this is the directory feature (guided navigation).
isExplicit() - Method in class com.iphrase.runtime.query.constraint.Constraint
Determine if the constraint is 'Explicit'.
isHidden() - Method in class com.iphrase.runtime.query.constraint.Constraint
Determine if the constraint is 'hidden'.
isIdentifier() - Method in class com.iphrase.runtime.query.result.FeatureMetaData
Determine whether the column is a OneStep identifier feature.
isLogClickThrough() - Method in class com.iphrase.runtime.query.result.FeatureMetaData
Determine whether features in this column should log click-through data.
isMaxFeaturesExceeded() - Method in class com.iphrase.runtime.query.result.DrillDown
Determine whether the configured maximum # of features has been exceeded.
isMaxValuesExceeded() - Method in class com.iphrase.runtime.query.result.FeatureMetaData
Determine whether the configured maximum # of values/feature has been exceeded (drillDown).
isMentions() - Method in class com.iphrase.runtime.query.constraint.Constraint
Determine if this constraint is an instance of type Mentions.
isNew() - Method in class com.iphrase.runtime.query.constraint.Constraint
Determine if the constraint is 'new'.
isNew() - Method in class com.iphrase.runtime.query.result.FeatureMetaData
Determine whether the column is new as of this query result.
isNotSerialized() - Method in class com.iphrase.runtime.query.constraint.Constraint
Determine if the constraint is 'prepruned'.
isOptional() - Method in class com.iphrase.runtime.query.result.FeatureMetaData
Determine whether the column is optional (dismissible).
isPrePruned() - Method in class com.iphrase.runtime.query.constraint.Constraint
Determine if the constraint is 'prepruned'.
isRangeConstraintType(String) - Static method in class com.iphrase.runtime.query.constraint.Constraint
Determine whether a String constraint type represents a range constraint.
isRefineShowCounts() - Method in class com.iphrase.runtime.query.result.FeatureMetaData
Determine whether feature should show 'includes counts' option.
isRemoveIndividualTerms() - Method in class com.iphrase.runtime.query.result.ResultSet
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.
isRenderBreadcrumb() - Method in class com.iphrase.runtime.query.result.ResultSet
Determine whether or not the breadcrumb should be rendered.
isRenderPerPageOptions() - Method in class com.iphrase.runtime.query.result.ResultSet
Determine whether or not the per-page options control should be rendered.
isRenderSearchWithin() - Method in class com.iphrase.runtime.query.result.ResultSet
Determine whether or not the search within control should be rendered.
isRequired() - Method in class com.iphrase.runtime.query.constraint.Constraint
Determine if the constraint is 'required'.
isSummarized() - Method in class com.iphrase.runtime.query.result.FeatureMetaData
Determine whether the column values are summarized.
isSummarized(int) - Static method in class com.iphrase.runtime.query.result.FeatureMetaData
Determine whether flags indicate that values are summarized.
isTabFeature() - Method in class com.iphrase.runtime.query.result.FeatureMetaData
Determine whether this is the tab feature (drillDown).
isTallied() - Method in class com.iphrase.runtime.query.result.FeatureMetaData
Determine whether the column contains tallied feature values.
isTrue(String) - Static method in class com.iphrase.runtime.Tools
Determine whether the designated string is one of the many representations of boolean true.
isTruncated() - Method in class com.iphrase.runtime.query.result.Summarized.Text
Determine if the summarized list was truncated (limited) by the server.
isTruncated() - Method in class com.iphrase.runtime.query.result.Summarized.TextExtract
Determine if the summarized list was truncated (limited) by the server.
isTruncated() - Method in class com.iphrase.runtime.query.result.Summarized.Taxonomy
Determine if the summarized list was truncated (limited) by the server.
isTruncated() - Method in class com.iphrase.runtime.query.result.Summarized.Link
Determine if the summarized list was truncated (limited) by the server.
isTruncated() - Method in class com.iphrase.runtime.query.result.Summarized.ImageUrl
Determine if the summarized list was truncated (limited) by the server.
isViewBy() - Method in class com.iphrase.runtime.query.result.FeatureMetaData
Determine whether the column is the view-by (aka group-by) feature.
isViewByFeature() - Method in class com.iphrase.runtime.query.result.FeatureMetaData
Determine whether this is the view-by (aka group-by) feature (drillDown).

J

join(String[], String) - Static method in class com.iphrase.runtime.Tools
Opposite of split.

L

Link - class com.iphrase.runtime.query.result.Link.
Represent a link (anchor + URL) feature value.
LINK - Static variable in interface com.iphrase.runtime.query.result.FeatureMetaData.BaseTypes
 
logChange(String, String) - Method in class com.iphrase.runtime.query.Query
Log a query change as command,attr1,attr2 where attr2 is blank.
logChange(String, String, String) - Method in class com.iphrase.runtime.query.Query
Log a query change as command,attr1,attr2.

M

matches(Constraint) - Method in class com.iphrase.runtime.query.constraint.Disjunction
Determine whether this disjunction has any constraints that match (as defined by Constraint.matches(com.iphrase.runtime.query.constraint.Constraint)) the designated constraint.
matches(Constraint) - Method in class com.iphrase.runtime.query.constraint.Constraint
Determine whether this constraint matches another.
matches(Constraint) - Method in class com.iphrase.runtime.query.constraint.Mentions
Determine whether this Constraint matches another.
matches(Constraint) - Method in class com.iphrase.runtime.query.constraint.DateTime
Determine whether this Constraint matches another.
matches(Constraint) - Method in class com.iphrase.runtime.query.constraint.DateTime.Range
Determine whether this Constraint matches another.
matches(Constraint) - Method in class com.iphrase.runtime.query.constraint.Enumerated
Determine whether this Constraint matches another.
matches(Constraint) - Method in class com.iphrase.runtime.query.constraint.Taxonomy
Determine whether this Constraint matches another.
matches(Constraint) - Method in class com.iphrase.runtime.query.constraint.Numeric
Determine whether this Constraint matches another.
matches(Constraint) - Method in class com.iphrase.runtime.query.constraint.Numeric.Range
Determine whether this Constraint matches another.
matches(Constraint) - Method in class com.iphrase.runtime.query.constraint.Text
Determine whether this Constraint matches another.
matches(Constraint) - Method in class com.iphrase.runtime.query.constraint.Conjunction
Determine whether this conjunction has any constraints that match (as defined by Constraint.matches(com.iphrase.runtime.query.constraint.Constraint)) the designated constraint.
matches(Constraint) - Method in class com.iphrase.runtime.query.constraint.Bool
Determine whether this Constraint matches another.
matches(Constraint) - Method in class com.iphrase.runtime.query.constraint.Example
Determine whether this Constraint matches another.
matches(Constraint) - Method in class com.iphrase.runtime.query.constraint.Within
Determine whether this Constraint matches another.
Mentions - class com.iphrase.runtime.query.constraint.Mentions.
Represent a concept constraint against indexed text feature types.
merge(Conjunction) - Method in class com.iphrase.runtime.query.constraint.Conjunction
 
merge(Constraint) - Method in class com.iphrase.runtime.query.constraint.Disjunction
Merge a constraint into this disjunction.
merge(Disjunction) - Method in class com.iphrase.runtime.query.constraint.Conjunction
Merge a disjunction into this conjunction.

N

newCalendar(int[]) - Static method in class com.iphrase.runtime.Tools
Attempt to create a Calendar object from an iPhrase datetime field array.
newInstance() - Static method in class com.iphrase.runtime.ConnectorFactory
Obtain a singleton instance of a ConnectorFactory.
newInstance(String) - Static method in class com.iphrase.runtime.query.constraint.Disjunction
 
newInstance(String) - Static method in class com.iphrase.runtime.query.constraint.Constraint
Create a new Constraint from a OneStep serialization String.
newInstance(String) - Static method in class com.iphrase.runtime.query.constraint.Mentions
Attempt to create a new Mentions constraint from a OneStep serialization String.
newInstance(String) - Static method in class com.iphrase.runtime.query.constraint.DateTime
Attempt to create a new DateTime constraint from a OneStep serialization String.
newInstance(String) - Static method in class com.iphrase.runtime.query.constraint.DateTime.Range
Attempt to create a new DateTime.Range constraint from a OneStep serialization String.
newInstance(String) - Static method in class com.iphrase.runtime.query.constraint.Null
Attempt to create a new Null constraint from a OneStep serialization String.
newInstance(String) - Static method in class com.iphrase.runtime.query.constraint.Enumerated
Attempt to create a new Enumerated constraint from a OneStep serialization String.
newInstance(String) - Static method in class com.iphrase.runtime.query.constraint.Taxonomy
Attempt to create a new Taxonomy constraint from a OneStep serialization String.
newInstance(String) - Static method in class com.iphrase.runtime.query.constraint.Numeric
Attempt to create a new Numeric constraint from a OneStep serialization String.
newInstance(String) - Static method in class com.iphrase.runtime.query.constraint.Numeric.Range
Attempt to create a new Numeric.Range constraint from a OneStep serialization String.
newInstance(String) - Static method in class com.iphrase.runtime.query.constraint.Text
Attempt to create a new Text constraint from a OneStep serialization String.
newInstance(String) - Static method in class com.iphrase.runtime.query.constraint.Bool
Attempt to create a new Bool constraint from a OneStep serialization String.
newInstance(String) - Static method in class com.iphrase.runtime.query.constraint.Example
Attempt to create a new Example constraint from a OneStep serialization String.
newInstance(String) - Static method in class com.iphrase.runtime.query.constraint.Within
Attempt to create a new Within constraint from a OneStep serialization String.
newInstance(String, String, String, Object) - Static method in class com.iphrase.runtime.query.constraint.Constraint
Create a new Constraint from (drill-down) tally tree data.
newInstance(String, String, String, Object, String) - Static method in class com.iphrase.runtime.query.constraint.Constraint
Create a new Constraint from (drill-down) tally tree data.
now() - Static method in class com.iphrase.runtime.Timer
Get the time right now.
Null - class com.iphrase.runtime.query.constraint.Null.
Constrain any feature type to be either null or non-null.
Null(String, boolean) - Constructor for class com.iphrase.runtime.query.constraint.Null
Construct a Null constraint.
Numeric - class com.iphrase.runtime.query.constraint.Numeric.
Represent constraints for numeric feature types.
Numeric.Eq - class com.iphrase.runtime.query.constraint.Numeric.Eq.
Constrain a feature to be equal to a particular numeric value.
Numeric.Eq(String, double) - Constructor for class com.iphrase.runtime.query.constraint.Numeric.Eq
Construct a numeric feature == value constraint.
Numeric.Gt - class com.iphrase.runtime.query.constraint.Numeric.Gt.
Constrain a feature to be greater than a particular numeric value.
Numeric.Gt(String, double) - Constructor for class com.iphrase.runtime.query.constraint.Numeric.Gt
Construct a numeric feature > value constraint.
Numeric.Gte - class com.iphrase.runtime.query.constraint.Numeric.Gte.
Constrain a feature to be greater than or equal to a particular numeric value.
Numeric.Gte(String, double) - Constructor for class com.iphrase.runtime.query.constraint.Numeric.Gte
Construct a numeric feature >= value constraint.
Numeric.Lt - class com.iphrase.runtime.query.constraint.Numeric.Lt.
Constrain a feature to be less than a particular numeric value.
Numeric.Lt(String, double) - Constructor for class com.iphrase.runtime.query.constraint.Numeric.Lt
Construct a numeric feature < value constraint.
Numeric.Lte - class com.iphrase.runtime.query.constraint.Numeric.Lte.
Constrain a feature to be less than or equal to a particular numeric value.
Numeric.Lte(String, double) - Constructor for class com.iphrase.runtime.query.constraint.Numeric.Lte
Construct a numeric feature <= value constraint.
Numeric.Neq - class com.iphrase.runtime.query.constraint.Numeric.Neq.
Constrain a feature to be not equal to a particular numeric value.
Numeric.Neq(String, double) - Constructor for class com.iphrase.runtime.query.constraint.Numeric.Neq
Construct a numeric feature != value constraint.
Numeric.Range - class com.iphrase.runtime.query.constraint.Numeric.Range.
Represent range-comparison Numeric constraints.
Numeric.Range(Numeric, Numeric) - Constructor for class com.iphrase.runtime.query.constraint.Numeric.Range
Construct a Numeric range constraint from two Numeric constraints.

O

onEndElement(String, String, DeserializationContext) - Method in class com.iphrase.runtime.Timer.Deserializer
 
onStartChild(String, String, String, Attributes, DeserializationContext) - Method in class com.iphrase.runtime.Timer.Deserializer
 
onStartElement(String, String, String, Attributes, DeserializationContext) - Method in class com.iphrase.runtime.Timer.Deserializer
 

P

PageContext - class com.iphrase.runtime.query.result.PageContext.
Represents the page context associated with a result set.

Q

Query - class com.iphrase.runtime.query.Query.
The Query class contains all details of a runtime request to a OneStep server.
Query(Connector, String) - Constructor for class com.iphrase.runtime.query.Query
This Query ctor is public only for Connector.createQuery().
Query(KeyValPair[]) - Constructor for class com.iphrase.runtime.query.Query
This Query ctor is public only for ResultSet.
QueryResult - class com.iphrase.runtime.query.result.QueryResult.
Represent the response from Query.execute().
QueryResult(SearchResult) - Constructor for class com.iphrase.runtime.query.result.QueryResult
Construct a QueryResult from a proxy query result struct (from Axis WSDL2Java).

R

replaceAll(String, String, String) - Static method in class com.iphrase.runtime.Tools
Replace all occurrances of pattern with replacement.
ResultSet - class com.iphrase.runtime.query.result.ResultSet.
Represent a single result set.

S

SENTENCE - Static variable in interface com.iphrase.runtime.query.result.TextExtract.Atts
Sentence-level highlighting attribute.
set(int, String) - Method in class com.iphrase.runtime.query.constraint.Conjunction
Create a constraint Disjunction from a OneStep serialization String and set the new disjunction to the specified index in this conjunction.
setAddColumnFeatures(List) - Method in class com.iphrase.runtime.query.Query
Set the features to be requested as additional columns for each row in the result table.
setAddColumnFeatures(String[]) - Method in class com.iphrase.runtime.query.Query
Set the features to be requested as additional columns for each row in the result table.
setAutoSummarizeHardLimit(int) - Method in class com.iphrase.runtime.query.Query
Set the hard count limit for summarization.
setAutoSummarizeSoftLimit(int) - Method in class com.iphrase.runtime.query.Query
Set the soft limit for summarization.
setCause(Throwable) - Method in class com.iphrase.runtime.exception.GeneralError
Sets the cause of this LayoutsException to the specified value.
setClientIp(String) - Method in class com.iphrase.runtime.query.Query
Set the client IP address that will be sent with this query.
setConstraints(Conjunction) - Method in class com.iphrase.runtime.query.Query
Set the constraints to be used when retrieving results.
setCookie(String) - Method in class com.iphrase.runtime.query.Query
Set the cookie string that will be sent with this query.
setCredentials(String, String) - Method in class com.iphrase.runtime.Connector
Pass login credentials to the underlying web service layer in order to authenticate requests to basic auth and (perhaps) other kinds of protected servers.
setData(String, String) - Method in class com.iphrase.runtime.query.Query
Set an arbitrary data key=value pair that should wind up in the OneStep server logs as "data[key]=[value]", where [key] and [value] are replaced their respective String values and [key] is down-cased.
setDfltEncName(String) - Static method in class com.iphrase.runtime.Tools
 
setDirection(int) - Method in class com.iphrase.runtime.query.SortFeature
Set the sort feature SortFeature.Direction value.
setDirection(int) - Method in class com.iphrase.runtime.query.result.SortFeature
Set the sort feature SortFeature.Direction value.
setEnableAutoSummarize(boolean) - Method in class com.iphrase.runtime.query.Query
Enable or disable auto-summarize, which allows the engine to dynamically summarized based on the summarization limits.
setEnableSearchWithin(boolean) - Method in class com.iphrase.runtime.query.Query
Enable or disable this query to search within the current results.
setExpandDrillDownFeature(String) - Method in class com.iphrase.runtime.query.Query
Set the drillDown feature to expand (i.e.
setExplicit() - Method in class com.iphrase.runtime.query.constraint.Constraint
Specify that the constraint explicitly set by user.
setGroupByFeature(String) - Method in class com.iphrase.runtime.query.Query
Set the group-by (aka view-by) feature, by which results are grouped (ordered) in the query result.
setGroupBySort(SortFeature, boolean) - Method in class com.iphrase.runtime.query.Query
Set the sort parameters by which results are sorted within group-by (aka view-by) groups.
setHidden() - Method in class com.iphrase.runtime.query.constraint.Constraint
Hide the constraint, i.e.
setHidden(boolean) - Method in class com.iphrase.runtime.query.constraint.Constraint
Hide the constraint and set its serialization state.
setHtmlBizRuleJavaScriptFunctionCall(String) - Method in class com.iphrase.runtime.query.result.ResultSet
Set the JavaScript function used for click-through logging.
setIdentifier(String) - Method in class com.iphrase.runtime.query.Query
Sets the identifier feature.
setLogClickThrough(int, String, String) - Method in class com.iphrase.runtime.query.Query
Set the query to log click-through info before serving a redirect.
setNew() - Method in class com.iphrase.runtime.query.constraint.Constraint
Specify that the current query has just added this constraint.
setNotSerialized() - Method in class com.iphrase.runtime.query.constraint.Constraint
Specify that the constraint applies before IR pruning, i.e., make it 'prepruned'.
setPageNumber(int) - Method in class com.iphrase.runtime.query.Query
Set the 0-based page number to return in the query result.
setParam(String, Object) - Method in class com.iphrase.runtime.query.Query
Maps the specified key to the specified value in the query parameters list
setPassword(String) - Method in class com.iphrase.runtime.Connector
Set the authentication password.
setPrePruned() - Method in class com.iphrase.runtime.query.constraint.Constraint
Specify that the constraint applies before IR pruning, i.e., make it 'prepruned'.
setPrimarySortByFeature(SortFeature) - Method in class com.iphrase.runtime.query.Query
Set the requested feature and direction as the primary sort feature.
setRefererUrl(String) - Method in class com.iphrase.runtime.query.Query
Set the referer URL that will be sent with this query.
setRequired() - Method in class com.iphrase.runtime.query.constraint.Constraint
Require the constraint, i.e.
setRowsPerPage(int) - Method in class com.iphrase.runtime.query.Query
Set the number of rows (results) per page.
setSearchByFeatures(List) - Method in class com.iphrase.runtime.query.Query
Set the features that this query will search.
setSearchByFeatures(String[]) - Method in class com.iphrase.runtime.query.Query
Set the features that this query will search.
setSearchFeatures(List) - Method in class com.iphrase.runtime.query.Query
Deprecated. call setSearchByFeatures instead
setSearchFeatures(String[]) - Method in class com.iphrase.runtime.query.Query
Deprecated. call setSearchByFeatures instead
setSortByFeatures(SortFeature[]) - Method in class com.iphrase.runtime.query.Query
Sets the array of features & directions used to sort results.
setState(int) - Method in class com.iphrase.runtime.query.constraint.Constraint
Set the custom state
setState(String) - Method in class com.iphrase.runtime.query.Query
Set multiple query properties with a query state string (serialization).
setSummarizeByFeatures(List) - Method in class com.iphrase.runtime.query.Query
Set the features used to summarize results.
setSummarizeByFeatures(String[]) - Method in class com.iphrase.runtime.query.Query
Set the features used to summarize results.
setText(String) - Method in class com.iphrase.runtime.query.Query
Set the end-user's query text.
setTextHistory(String[]) - Method in class com.iphrase.runtime.query.Query
Set the user's query text search within history.
setTextRemoveTerm(Mentions, String) - Method in class com.iphrase.runtime.query.Query
Set the term to be removed from the end-user's query text.
setTruncation(String, int) - Method in class com.iphrase.runtime.query.Query
Set the truncation feature and count.
setTruncation(String, int, int) - Method in class com.iphrase.runtime.query.Query
Set truncation feature, count, and trigger.
setUniqueThreadName() - Static method in class com.iphrase.runtime.Timer
Set a unique per-thread name for use in subsequent calls to Timer.elapsed(long, java.lang.String).
setUserAgent(String) - Method in class com.iphrase.runtime.query.Query
Set the user agent that will be sent with this query.
setUserData(Object) - Method in class com.iphrase.runtime.query.result.ResultSet
Set the userData object.
setUsername(String) - Method in class com.iphrase.runtime.Connector
Set the authentication username.
setValue(String) - Method in class com.iphrase.runtime.query.constraint.Mentions
Set the value associated with this constraint.
setViewByFeature(String) - Method in class com.iphrase.runtime.query.Query
Set the view-by (aka group-by) feature, by which results are viewed (ordered) in the query result.
SortFeature - class com.iphrase.runtime.query.SortFeature.
Represent an iPhrase OneStep sort feature for a query request.
SortFeature - class com.iphrase.runtime.query.result.SortFeature.
Represent a feature for sorting rows in result set table.
SortFeature.Direction - interface com.iphrase.runtime.query.SortFeature.Direction.
Define sort direction values.
SortFeature.Direction - interface com.iphrase.runtime.query.result.SortFeature.Direction.
Define QueryResult sort direction values.
SortFeature(String) - Constructor for class com.iphrase.runtime.query.SortFeature
Construct a sort feature by feature id and default direction.
SortFeature(String, int) - Constructor for class com.iphrase.runtime.query.SortFeature
Construct a sort feature by feature id and direction.
split(String, String) - Static method in class com.iphrase.runtime.Tools
Unlimited version of Tools.split(String s, String delim, int limit) (i.e.
split(String, String, int) - Static method in class com.iphrase.runtime.Tools
Similar to JDK 1.4 public String[] split(String regex, int limit), except: delim is a simple string, not a regex any occurance of double delim is considered to be a single, escaped delim that does not split, but remains within the string limit == 0 does not remove trailing empty strings from the array. String.split doesn't appear until JDK 1.4: http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html#split(java.lang.String,%20int)
Summarized - class com.iphrase.runtime.query.result.Summarized.
Abstract base class for a summarized feature value.
Summarized.Bool - class com.iphrase.runtime.query.result.Summarized.Bool.
Represent a summarized boolean feature value.
Summarized.DateTime - class com.iphrase.runtime.query.result.Summarized.DateTime.
Represent a summarized datetime feature value.
Summarized.DateTime(Calendar, Calendar) - Constructor for class com.iphrase.runtime.query.result.Summarized.DateTime
Construct a new summarized datetime feature value.
Summarized.Float - class com.iphrase.runtime.query.result.Summarized.Float.
Represent a summarized float feature value.
Summarized.Float(double, double) - Constructor for class com.iphrase.runtime.query.result.Summarized.Float
Construct a new summarized float feature value.
Summarized.ImageUrl - class com.iphrase.runtime.query.result.Summarized.ImageUrl.
Represent a summarized image URL feature value.
Summarized.Int - class com.iphrase.runtime.query.result.Summarized.Int.
Represent a summarized int feature value.
Summarized.Int(int, int) - Constructor for class com.iphrase.runtime.query.result.Summarized.Int
Construct a new summarized int feature value.
Summarized.Link - class com.iphrase.runtime.query.result.Summarized.Link.
Represent a summarized link feature value.
Summarized.Taxonomy - class com.iphrase.runtime.query.result.Summarized.Taxonomy.
Represent a summarized taxonomy feature value.
Summarized.Text - class com.iphrase.runtime.query.result.Summarized.Text.
Represent a summarized text feature value.
Summarized.Text(String[]) - Constructor for class com.iphrase.runtime.query.result.Summarized.Text
Construct a new summarized text feature value.
Summarized.TextExtract - class com.iphrase.runtime.query.result.Summarized.TextExtract.
Represent a summarized text extract feature value.
Summarized() - Constructor for class com.iphrase.runtime.query.result.Summarized
 
swap(Conjunction, Conjunction) - Method in class com.iphrase.runtime.query.constraint.Conjunction
 
swap(Constraint, Constraint) - Method in class com.iphrase.runtime.query.constraint.Conjunction
Replace all instances of one constraint with another, in place.

T

Table - class com.iphrase.runtime.query.result.Table.
Represent results as a 2D array of feature values, along with metadata corresponding to all values of a given feature (column).
TallyFeature - class com.iphrase.runtime.query.result.TallyFeature.
Specialized FeatureMetaData for drill-down and drill-sideways data.
TallyFeature.Value - class com.iphrase.runtime.query.result.TallyFeature.Value.
Represent a tally feature value.
Taxonomy - class com.iphrase.runtime.query.constraint.Taxonomy.
Represent constraints for taxonomy feature types.
Taxonomy - class com.iphrase.runtime.query.result.Taxonomy.
Represent a taxonomy feature value as an array of string components.
TAXONOMY - Static variable in interface com.iphrase.runtime.query.result.FeatureMetaData.BaseTypes
 
Taxonomy.Contains - class com.iphrase.runtime.query.constraint.Taxonomy.Contains.
Constrain a feature to contain a particular taxonomy value.
Taxonomy.Contains(String, String[]) - Constructor for class com.iphrase.runtime.query.constraint.Taxonomy.Contains
Construct a Taxonomy.Contains constraint.
Taxonomy.NotContains - class com.iphrase.runtime.query.constraint.Taxonomy.NotContains.
Constrain a feature to not contain a particular taxonomy value.
Taxonomy.NotContains(String, String[]) - Constructor for class com.iphrase.runtime.query.constraint.Taxonomy.NotContains
Construct a Taxonomy.NotContains constraint.
Taxonomy.NotStartsWith - class com.iphrase.runtime.query.constraint.Taxonomy.NotStartsWith.
Constrain a feature to not start with a particular taxonomy value.
Taxonomy.NotStartsWith(String, String[]) - Constructor for class com.iphrase.runtime.query.constraint.Taxonomy.NotStartsWith
Construct a Taxonomy.NotStartsWith constraint.
Taxonomy.StartsWith - class com.iphrase.runtime.query.constraint.Taxonomy.StartsWith.
Constrain a feature to start with a particular taxonomy value.
Taxonomy.StartsWith(String, String[]) - Constructor for class com.iphrase.runtime.query.constraint.Taxonomy.StartsWith
Construct a Taxonomy.StartsWith constraint.
Taxonomy(String[]) - Constructor for class com.iphrase.runtime.query.result.Taxonomy
Construct a new Taxonomy feature value.
Text - class com.iphrase.runtime.query.constraint.Text.
Represent constraints for text feature types.
TEXT - Static variable in interface com.iphrase.runtime.query.result.FeatureMetaData.BaseTypes
 
TEXT_EXTRACT - Static variable in interface com.iphrase.runtime.query.result.FeatureMetaData.BaseTypes
 
Text.Contains - class com.iphrase.runtime.query.constraint.Text.Contains.
Constrain a feature to contain a particular text value.
Text.Contains(String, String) - Constructor for class com.iphrase.runtime.query.constraint.Text.Contains
Construct a Text.Contains constraint.
Text.EndsWith - class com.iphrase.runtime.query.constraint.Text.EndsWith.
Constrain a feature to end with a particular text value.
Text.EndsWith(String, String) - Constructor for class com.iphrase.runtime.query.constraint.Text.EndsWith
Construct a Text.EndsWith constraint.
Text.Equals - class com.iphrase.runtime.query.constraint.Text.Equals.
Constrain a feature to equal a particular text value.
Text.Equals(String, String) - Constructor for class com.iphrase.runtime.query.constraint.Text.Equals
Construct a Text.Equals constraint.
Text.StartsWith - class com.iphrase.runtime.query.constraint.Text.StartsWith.
Constrain a feature to start with a particular text value.
Text.StartsWith(String, String) - Constructor for class com.iphrase.runtime.query.constraint.Text.StartsWith
Construct a Text.StartsWith constraint.
TextExtract - class com.iphrase.runtime.query.result.TextExtract.
Represent a text extract feature value.
TextExtract.Atts - interface com.iphrase.runtime.query.result.TextExtract.Atts.
Pre-defined text extract attribute values.
TextExtract.Span - class com.iphrase.runtime.query.result.TextExtract.Span.
Represent a single text extract span, consisting of text and attributes.
Timer - class com.iphrase.runtime.Timer.
Timing utilities for measuring runtime performance.
Timer.Deserializer - class com.iphrase.runtime.Timer.Deserializer.
Thin wrapper around org.apache.axis.encoding.ser.BeanDeserializer that calls Timer.elapsed(long, java.lang.String) for the element deserialization operation.
Timer.Deserializer(Class, QName, TypeDesc) - Constructor for class com.iphrase.runtime.Timer.Deserializer
 
Timer() - Constructor for class com.iphrase.runtime.Timer
 
Tools - class com.iphrase.runtime.Tools.
Static utility methods used throughout the API and available for clients.
Tools() - Constructor for class com.iphrase.runtime.Tools
 
toString() - Method in class com.iphrase.runtime.query.Query
Get the state string (serialization) of this query.
toString() - Method in class com.iphrase.runtime.query.constraint.Disjunction
Serialize this disjunction using the OneStep serialization format.
toString() - Method in class com.iphrase.runtime.query.constraint.Mentions
Serialize this constraint using the OneStep serialization format.
toString() - Method in class com.iphrase.runtime.query.constraint.DateTime
Serialize this constraint using the OneStep serialization format.
toString() - Method in class com.iphrase.runtime.query.constraint.DateTime.Range
Serialize this constraint using the OneStep serialization format.
toString() - Method in class com.iphrase.runtime.query.constraint.Null
Serialize this constraint using the OneStep serialization format.
toString() - Method in class com.iphrase.runtime.query.constraint.Enumerated
Serialize this constraint using the OneStep serialization format.
toString() - Method in class com.iphrase.runtime.query.constraint.Taxonomy
Serialize this constraint using the OneStep serialization format.
toString() - Method in class com.iphrase.runtime.query.constraint.Numeric
Serialize this constraint using the OneStep serialization format.
toString() - Method in class com.iphrase.runtime.query.constraint.Numeric.Range
Serialize this constraint using the OneStep serialization format.
toString() - Method in class com.iphrase.runtime.query.constraint.Text
Serialize this constraint using the OneStep serialization format.
toString() - Method in class com.iphrase.runtime.query.constraint.Conjunction
Serialize this conjunction using the OneStep serialization format.
toString() - Method in class com.iphrase.runtime.query.constraint.Bool
Serialize this constraint using the OneStep serialization format.
toString() - Method in class com.iphrase.runtime.query.constraint.Example
Serialize this constraint using the OneStep serialization format.
toString() - Method in class com.iphrase.runtime.query.constraint.Within
Serialize this constraint using the OneStep serialization format.

U

unescape(String, String) - Static method in class com.iphrase.runtime.Tools
Unescape any occurance of double delim in the designated string by singling it.
urlDecode(String) - Static method in class com.iphrase.runtime.Tools
Uses dfltEncName encoding to convert a string that has been encoded for transmission in a URL into a decoded string.
urlDecode(String, String) - Static method in class com.iphrase.runtime.Tools
Converts a string that has been encoded for transmission in a URL into a decoded string.
urlEncode(String) - Static method in class com.iphrase.runtime.Tools
Converts a URL string for reliable HTTP transmission from the Web server to a client.
urlEncode(String, String) - Static method in class com.iphrase.runtime.Tools
Uses dfltEncName encoding to convert a URL string for reliable HTTP transmission from the Web server to a client.

V

valueComplete() - Method in class com.iphrase.runtime.Timer.Deserializer
 
Voiceover - class com.iphrase.runtime.query.result.Voiceover.
Represent the voiceover details for a result set.
Voiceover.Respelling - class com.iphrase.runtime.query.result.Voiceover.Respelling.
Represent the respelling that did or can take place for this query.
Voiceover.Respelling.RespelledWord - class com.iphrase.runtime.query.result.Voiceover.Respelling.RespelledWord.
Represent a single respelled word.
Voiceover.WordExpansion - class com.iphrase.runtime.query.result.Voiceover.WordExpansion.
Represent a word expansion from one word to many expansions.

W

wasApplied() - Method in class com.iphrase.runtime.query.result.Voiceover.Respelling
Indicate whether respelling was applied for this query result.
wasBackoff() - Method in class com.iphrase.runtime.query.result.Voiceover
Determine whether backoff occurred.
WebServiceError - exception com.iphrase.runtime.exception.WebServiceError.
Exception class thrown for web service failures.
WebServiceError(String) - Constructor for class com.iphrase.runtime.exception.WebServiceError
Construct a WebServiceError exception from a detail message.
Within - class com.iphrase.runtime.query.constraint.Within.
Use this constraint to require that matched items fall within a bounded range of the min or max of the current result set.
WORD - Static variable in interface com.iphrase.runtime.query.result.TextExtract.Atts
Word-level highlighting attribute.

A B C D E F G H I J L M N O P Q R S T U V W
© Copyright 2005, 2006. IBM Corporation. All rights reserved.