MatchResult (51Degrees :: Device Detection

java.lang.Object
- fiftyone.mobile.detection.MatchResult

Direct Known Subclasses:

MatchState
```
public class MatchResult
extends Object
```
Used to persist the results of a match for future use.

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`closestSignaturesCount`
`protected long`	`elapsed`
`protected int`	`lowestScore`
`protected MatchMethods`	`method`
`protected Node[]`	`nodes`
`protected int`	`nodesEvaluated`
`protected Profile[]`	`profiles`
`protected int`	`rootNodesEvaluated`
`protected Signature`	`signature`
`protected int`	`signaturesCompared`
`protected int`	`signaturesRead`
`protected int`	`stringsRead`
`protected String`	`targetUserAgent`

Constructor Summary

Constructors
Modifier Constructor and Description

protected MatchResult(Dataset dataset)
Creates a default instance of MatchState.

Constructors
Modifier	Constructor and Description
`protected`	`MatchResult(Dataset dataset)` Creates a default instance of MatchState.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getClosestSignaturesCount()`
`long`	`getElapsed()`
`int`	`getLowestScore()`
`MatchMethods`	`getMethod()`
`int`	`getNodesEvaluated()`
`Profile[]`	`getProfiles()`
`int`	`getRootNodesEvaluated()`
`Signature`	`getSignature()` The signature with the closest match to the target User-Agent provided.
`int`	`getSignaturesCompared()`
`int`	`getSignaturesRead()`
`int`	`getStringsRead()`
`String`	`getTargetUserAgent()`

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

- Field Detail
  - elapsed
```
protected long elapsed
```
  - method
```
protected MatchMethods method
```
  - nodesEvaluated
```
protected int nodesEvaluated
```
  - rootNodesEvaluated
```
protected int rootNodesEvaluated
```
  - signature
```
protected Signature signature
```
  - signaturesCompared
```
protected int signaturesCompared
```
  - signaturesRead
```
protected int signaturesRead
```
  - stringsRead
```
protected int stringsRead
```
  - closestSignaturesCount
```
protected int closestSignaturesCount
```
  - lowestScore
```
protected int lowestScore
```
  - targetUserAgent
```
protected String targetUserAgent
```
  - nodes
```
protected Node[] nodes
```
  - profiles
```
protected Profile[] profiles
```
- Constructor Detail
  - MatchResult
```
protected MatchResult(Dataset dataset)
```
    Creates a default instance of MatchState.
    
    Parameters:
    
    dataset - the match result is associated with.
- Method Detail
  - getElapsed
```
public long getElapsed()
```
    Returns:
    
    The elapsed time for the match.
  - getMethod
```
public MatchMethods getMethod()
```
    Returns:
    
    The method used to obtain the match. MatchMethods provides descriptions of the possible return values. When used with multi HTTP headers the worst method used for all the HTTP headers.
  - getNodesEvaluated
```
public int getNodesEvaluated()
```
    Returns:
    
    The number of nodes checked.
  - getRootNodesEvaluated
```
public int getRootNodesEvaluated()
```
    Returns:
    
    The number of root nodes checked against the target User-Agent.
  - getSignature
```
public Signature getSignature()
                       throws IOException
```
    The signature with the closest match to the target User-Agent provided.
    
    Returns:
    
    Signature for the current match.
    
    Throws:
    
    IOException
  - getSignaturesCompared
```
public int getSignaturesCompared()
```
    Returns:
    
    The number of signatures that were compared against the target User-Agent if the Closest match method was used.
  - getSignaturesRead
```
public int getSignaturesRead()
```
    Returns:
    
    The number of signatures read during the detection.
  - getStringsRead
```
public int getStringsRead()
```
    Returns:
    
    The number of strings that were read from the data structure for the match.
  - getClosestSignaturesCount
```
public int getClosestSignaturesCount()
```
    Returns:
    
    The number of closest signatures returned for evaluation.
  - getLowestScore
```
public int getLowestScore()
```
    Returns:
    
    The lowest score recorded for the signature that was found.
  - getTargetUserAgent
```
public String getTargetUserAgent()
```
    Returns:
    
    The target User-Agent string used for the detection where a single User-Agent was provided. If multiple HTTP headers were provided then this value will be null.
  - getProfiles
```
public Profile[] getProfiles()
                      throws IOException
```
    Returns:
    
    Array of profiles associated with the device that was found.
    
    Throws:
    
    IOException - if there was a problem accessing data file.

Class MatchResult

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

elapsed

method

nodesEvaluated

rootNodesEvaluated

signature

signaturesCompared

signaturesRead

stringsRead

closestSignaturesCount

lowestScore

targetUserAgent

nodes

profiles

Constructor Detail

MatchResult

Method Detail

getElapsed

getMethod

getNodesEvaluated

getRootNodesEvaluated

getSignature

getSignaturesCompared

getSignaturesRead

getStringsRead

getClosestSignaturesCount

getLowestScore

getTargetUserAgent

getProfiles