This class is used to configure search options which apply for the overall search (for all tables being searched).


The following tables list the members exposed by NetricsSearchOpts.

Public Constructors

  Name Description
Public method NetricsSearchOpts Constructs empty opts object.
Top

Public Methods

  Name Description
Public method addCustomTiebreak Can be used to specify how to break ties between two records that have identical textual similarity.
Public method baseBgColor Specify a background non-match color for HTML text.
Public method baseColor Specify a non-match color for HTML text.
Public method boldThresh Specify the threshold beyond which to bold text.
Public method Equals Determines whether the specified Object is equal to the current Object. (inherited from Object)
Public method GetHashCode Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table. (inherited from Object)
Public method GetType Gets the Type of the current instance. (inherited from Object)
Public method italicsThresh Specify the threshold beyond which to italicize text.
Public method matchBgColor Specify a background match color for HTML text.
Public method matchColor Specify a match color for HTML text.
Public method maxFontSize Specify the maximum font size of matching text.
Public method scoreType Overloaded. This specifies the type of score to be used for ordering records.
Public method setDetailedStats Enable detailed statistics for this search.
Public method setEmptyScore Sets the score a comparison gets when empty data is encountered.
Public method setFailEmptyPred Set whether the predicate fails on empty data.
Public method setFailInvalidPred Set whether a failed predicate is considered true or false.
Public method setFetchSize Tuning parameter, use only on the advice of your TIBCO representative.
Public method setGipFiltered Enable gip filtering for this table (default).
Public method setGpuCallParallelism Set the number of simultaneous GPU calls used in the search.
Public method setGpuEnabled Set whether the search uses GPU-enabled indexing.
Public method setGpuTableBlocksPerCall Set the number of table-blocks evaluated per GPU call.
Public method setInvalidScore Sets the score a comparison gets when an error occurs.
Public method setMatchesRequested Set the number of matches returned by the Netrics Server (default 10).
Public method setPCSize Tuning parameter, use only on the advice of your TIBCO representative.
Public method setPhonetic Enable phonetic searches for this table.
Public method setPsiDensity Set the density of suffixes produced from query field values. It is recommended that you contact your TIBCO representative for advice before using this option.
Public method setPsiFiltered Enable PSI filtering for this table.
Public method setPsiLookupFields Set the fields used to lookup a record in the sort filter
Public method setQCSize Tuning parameter, use only on the advice of your TIBCO representative.
Public method setRlModelName This method specifies the rlink model name to use for this search.
Public method setRlPreds Set the predicates used as features by the Netrics Decision Engine.
Public method setSortFiltered Enable SORT filtering for this table.
Public method setSortLookupFields Set the fields used to lookup a record in the sort filter
Public method setStartMatch Set the rank of the first match to be returned by the Netrics Server (default 1).
Public method setThesaurusWeight Use the specified thesaurus weight in determining matching records.
Public method setVisStyle Sets the visualization style you want returned.
Public method setXparm Overloaded. Use this method only on the advice of your TIBCO representative.
Public method ToString Returns a String that represents the current Object. (inherited from Object)
Public method underlineThresh Specify the threshold beyond which to underline text.
Public method useAbsoluteCutoff Cut off the result set at a specific absolute value.
Public method useEphemeralThesaurus Use an empheral thesaurus in determining matching records.
Public method useExactPlusScoreCutoff Return all search results which are exact matches and a constant number of records which are inexact.
Public method useNoCutoff Revert to not using a cutoff.
Public method usePercentOfTopCutoff Return search results whose scores are above a given percentage of the score of the first record.
Public method useSimpleGapCutoff Return search results until there is gap between adjacent records.
Public method useThesaurus Use the specified thesaurus in determining matching records.
Top

Protected Methods

  Name Description
Family method Finalize Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (inherited from Object)
Family method MemberwiseClone Creates a shallow copy of the current Object. (inherited from Object)
Top

See Also