NetricsSearchResult

java.lang.Object
- com.netrics.likeit.NetricsRecord
- - com.netrics.likeit.NetricsMappedRecord
  - - com.netrics.likeit.NetricsSearchResult

All Implemented Interfaces:

java.io.Serializable
```
public class NetricsSearchResult
extends NetricsMappedRecord
implements java.io.Serializable
```
This class inherits from a NetricsMappedRecord and contains additional information relevant to a search result (match score, etc.).

See Also:
NetricsServerInterface.search(com.netrics.likeit.NetricsSearchCfg, com.netrics.likeit.NetricsSearchOpts), NetricsSearchResponse, Serialized Form

Method Summary

Methods
Modifier and Type	Method and Description
`int[]`	`getCharMatchStrengths(int fieldNo)` Returns the match strength information for a field in the record.
`int[]`	`getCharMatchStrengths(java.lang.String fieldName)` Returns the match strength information for a field in the record.
`double[]`	`getDblCharMatchStrengths(int fieldNo)` Returns the precomputed visualization strengths for this field.
`double[]`	`getDblCharMatchStrengths(java.lang.String fieldName)` Returns the precomputed visualization strengths for this field.
`java.lang.String`	`getHtml(int fieldNo)` Gets an HTML visualized field from the record.
`java.lang.String`	`getHtml(java.lang.String fieldName)` Gets an HTML visualized field from the record.
`double`	`getITMatchScore()` A score from 0 to 1.0 indicating the information theoretic score for this record.
`double[]`	`getITMatchScoreQlt()` The per-querylet IT match scores.
`int`	`getMatchRank()` The ordinal ranking of this record.
`double`	`getMatchScore()` The score that was used to sort the record.
`double[]`	`getMatchScoreQlt()` Querylet match scores.
`java.lang.String`	`getMatchType()` The type of search which retrieved this record.
`double`	`getMaxMatchScore()` A score from 0 to 1.0 indicating the maximum of the normal and reverse match strengths for this record.
`double`	`getMinMatchScore()` A score from 0 to 1.0 indicating the minimum of the normal and reverse match strengths for this record.
`double`	`getNormMatchScore()` A score from 0 to 1.0 indicating the normal match strength for this record.
`double[]`	`getNormMatchScoreQlt()` The per-querylet normal match scores.
`double`	`getRevMatchScore()` A score from 0 to 1.0 indicating the reverse match strength for this record.
`double[]`	`getRevMatchScoreQlt()` The per-querylet reverse match scores.
`double`	`getRlScore()` A score from 0 to 1.0 indicating the decision engine strength for this record.
`java.lang.String`	`getSrcDbInfo()` Deprecated. use `getSrcTblInfo()`
`java.lang.String`	`getSrcDbName()` Deprecated. use `getSrcTblName()`
`java.lang.String`	`getSrcTblInfo()` The table info field for the table from which the record came.
`java.lang.String`	`getSrcTblName()` The name of the table from which the record came.
`double`	`getSymMatchScore()` A score from 0 to 1.0 indicating the symmetric match strength for this record.
`double[]`	`getSymMatchScoreQlt()` The per-querylet symmetric match scores.

Methods inherited from class com.netrics.likeit.NetricsMappedRecord
getAttribute, getAttrNames, getField, getField, getFieldNames, toString

Methods inherited from class com.netrics.likeit.NetricsRecord
compare, getAttribute, getAttrNames, getAttrValues, getFields, getKey, numBytes

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - getCharMatchStrengths
```
public int[] getCharMatchStrengths(java.lang.String fieldName)
                            throws NetricsException
```
    Returns the match strength information for a field in the record.
    
    The core search algorithm creates match strengths for each character in a matching record. These strenghths are represented as an integer where 0 indicates no match and higher numbers represent a better match.
    
    Parameters:
    fieldName - The name of the field for which to return its match strength information.
    
    Returns:
    An integer array with one value in the array for each character in the given field.
    
    Throws:
    
    NetricsException
  - getCharMatchStrengths
```
public int[] getCharMatchStrengths(int fieldNo)
```
    Returns the match strength information for a field in the record.
    
    Parameters:
    fieldNo - The number of the field for which to return its match strength information.
    
    Returns:
    An integer array with one value in the array for each character in the given field.
  - getDblCharMatchStrengths
```
public double[] getDblCharMatchStrengths(java.lang.String fieldName)
                                  throws NetricsException
```
    Returns the precomputed visualization strengths for this field.
    
    These are per character match quality score values where 0.0 represents no match and 1.0 represents a perfect match. These scores account for more factors than the integer match scores and are the preferred character strength scores to use.
    
    Parameters:
    fieldName - The name of the field for which to return its match strength information.
    
    Returns:
    An double array with one value in the array for each character in the given field. Values are between 0.0 and 1.0.
    
    Throws:
    
    NetricsException
  - getDblCharMatchStrengths
```
public double[] getDblCharMatchStrengths(int fieldNo)
```
    Returns the precomputed visualization strengths for this field.
    
    These are per character match quality score values where 0.0 represents no match and 1.0 represents a perfect match. These scores account for more factors than the integer match scores and are the preferred character strength scores to use.
    
    Parameters:
    fieldNo - The number of the field for which to return its match strength information.
    
    Returns:
    An double array with one value in the array for each character in the given field. Values are between 0.0 and 1.0.
  - getHtml
```
public java.lang.String getHtml(java.lang.String fieldName)
                         throws NetricsException
```
    Gets an HTML visualized field from the record.
    
    Gets the content of a given field with matching characters visualized using HTML. Parameters for the visualization can be set in the NetricsSearchOpts object.
    
    Parameters:
    fieldName - The name of the field for which to get the HTML visualized string.
    
    Throws:
    
    NetricsException
    See Also:
    NetricsSearchOpts
  - getHtml
```
public java.lang.String getHtml(int fieldNo)
```
    Gets an HTML visualized field from the record.
    
    Gets the content of a given field with matching characters visualized using HTML. Parameters for the visualization can be set in the NetricsSearchOpts object.
    
    Parameters:
    fieldNo - The index of the field for which to get the HTML visualized string.
    See Also:
    NetricsSearchOpts
  - getMatchScore
```
public double getMatchScore()
```
    The score that was used to sort the record. This is the same as one of the explicit score types (default is NORMAL). See the scoreType method in NetricsQuery for a description of the possible score types.
    
    See Also:
    NetricsQuery.scoreType(int)
  - getNormMatchScore
```
public double getNormMatchScore()
```
    A score from 0 to 1.0 indicating the normal match strength for this record.
    
    See Also:
    NetricsQuery.scoreType(int)
  - getRevMatchScore
```
public double getRevMatchScore()
```
    A score from 0 to 1.0 indicating the reverse match strength for this record.
    
    See Also:
    NetricsQuery.scoreType(int)
  - getSymMatchScore
```
public double getSymMatchScore()
```
    A score from 0 to 1.0 indicating the symmetric match strength for this record.
    
    See Also:
    NetricsQuery.scoreType(int)
  - getMinMatchScore
```
public double getMinMatchScore()
```
    A score from 0 to 1.0 indicating the minimum of the normal and reverse match strengths for this record.
    
    See Also:
    NetricsQuery.scoreType(int)
  - getMaxMatchScore
```
public double getMaxMatchScore()
```
    A score from 0 to 1.0 indicating the maximum of the normal and reverse match strengths for this record.
    
    See Also:
    NetricsQuery.scoreType(int)
  - getRlScore
```
public double getRlScore()
```
    A score from 0 to 1.0 indicating the decision engine strength for this record.
  - getITMatchScore
```
public double getITMatchScore()
```
    A score from 0 to 1.0 indicating the information theoretic score for this record. Contact your Netrics representative if you're interested in learning how IT scores are computed.
  - getMatchScoreQlt
```
public double[] getMatchScoreQlt()
```
    Querylet match scores.
    
    If the top level query is a score combiner these are the match scores of the individual querylets of the score combiner. E.g. if you have a simple query for each field in the record combined with an AND these would be the scores of the simple queries, and thus the scores for the individual fields.
    
    Returns:
    An array of match scores for the querylets, null if the top level query is not a score combiner.
    See Also:
    NetricsQuery.scoreType(int)
  - getNormMatchScoreQlt
```
public double[] getNormMatchScoreQlt()
```
    The per-querylet normal match scores.
    
    See Also:
    NetricsQuery.scoreType(int)
  - getRevMatchScoreQlt
```
public double[] getRevMatchScoreQlt()
```
    The per-querylet reverse match scores.
    
    See Also:
    NetricsQuery.scoreType(int)
  - getSymMatchScoreQlt
```
public double[] getSymMatchScoreQlt()
```
    The per-querylet symmetric match scores.
    
    See Also:
    NetricsQuery.scoreType(int)
  - getITMatchScoreQlt
```
public double[] getITMatchScoreQlt()
```
    The per-querylet IT match scores.
    
    See Also:
    NetricsQuery.scoreType(int)
  - getSrcTblName
```
public java.lang.String getSrcTblName()
```
    The name of the table from which the record came. This is useful for multi-table searches.
  - getSrcDbName
```
public java.lang.String getSrcDbName()
```
    Deprecated. use getSrcTblName()
  - getSrcTblInfo
```
public java.lang.String getSrcTblInfo()
```
    The table info field for the table from which the record came. Will be null if tblinfo was not set at loadtime.
  - getSrcDbInfo
```
public java.lang.String getSrcDbInfo()
```
    Deprecated. use getSrcTblInfo()
  - getMatchType
```
public java.lang.String getMatchType()
```
    The type of search which retrieved this record.
    
    Returns:
    "date" if custom date search was used, "typographic" otherwise.
  - getMatchRank
```
public int getMatchRank()
```
    The ordinal ranking of this record.
    
    Returns:
    An integer ranking which will be between the requested start match and the start match plus the number requested.

Class NetricsSearchResult

Method Summary

Methods inherited from class com.netrics.likeit.NetricsMappedRecord

Methods inherited from class com.netrics.likeit.NetricsRecord

Methods inherited from class java.lang.Object

Method Detail

getCharMatchStrengths

getCharMatchStrengths

getDblCharMatchStrengths

getDblCharMatchStrengths

getHtml

getHtml

getMatchScore

getNormMatchScore

getRevMatchScore

getSymMatchScore

getMinMatchScore

getMaxMatchScore

getRlScore

getITMatchScore

getMatchScoreQlt

getNormMatchScoreQlt

getRevMatchScoreQlt

getSymMatchScoreQlt

getITMatchScoreQlt

getSrcTblName

getSrcDbName

getSrcTblInfo

getSrcDbInfo

getMatchType

getMatchRank