Provider (51Degrees :: Device Detection :: Core 3.2.2.20-beta API)

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

```
public class Provider
extends Object
```
Exposes several match methods to be used for device detection.
Provider requires a Dataset object connected to one of the 51Degrees device data files in order to perform device detection. Can be created like:
- For use with Stream factory:
  Provider p = new Provider(StreamFactory.create("path_to_file"));
- For use with Memory factory:
  Provider p = new Provider(MemoryFactory.create("path_to_file"));
For explanation on the difference between stream and memory see: how device detection works "Modes of operation" section.
Match methods return a Match object that contains detection results for a specific User-Agent string, collection of HTTP headers of a device Id. Use it to retrieve detection results like: match.getValues("IsMobile");
You can access the underlying data set like: provider.dataset.publised to retrieve various meta information like the published date and the next update date as well as the list of various entities like profiles and properties.
Remember to close the underlying data set when program finishes to release resources and remove file lock.

Field Summary

Fields
Modifier and Type Field and Description

Dataset dataSet
The data set associated with the provider.

Fields
Modifier and Type	Field and Description
`Dataset`	`dataSet` The data set associated with the provider.

Constructor Summary

Constructors
Constructor and Description
`Provider(Dataset dataSet)` Constructs a new Provider using the data set without a cache.
`Provider(Dataset dataSet, int cacheSize)` Constructs a new Provider using the data set, with a cache of the size provided.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Match`	`createMatch()` Creates a new match instance to be used for matching.
`long`	`getCacheMisses()`
`double`	`getCacheRequests()`
`long`	`getCacheSwitches()` Deprecated.
`long`	`getDetectionCount()` The total number of detections performed by the data set.
`double`	`getPercentageCacheMisses()`
`Match`	`match(Map<String,String> headers)` For a given collection of HTTP headers returns a match containing information about the capabilities of the device and it's components.
`Match`	`match(Map<String,String> headers, Match match)` For a given collection of HTTP headers returns a match containing information about the capabilities of the device and it's components.
`Match`	`match(String targetUserAgent)` For a given User-Agent returns a match containing information about the capabilities of the device and it's components.
`Match`	`match(String targetUserAgent, Match match)` For a given User-Agent returns a match containing information about the capabilities of the device and it's components.
`Match`	`matchForDeviceId(ArrayList<Integer> profileIds)` Returns the result of a match based on the device Id returned from a previous match operation.
`Match`	`matchForDeviceId(ArrayList<Integer> profileIds, Match match)` Returns the result of a match based on the device Id returned from a previous match operation.
`Match`	`matchForDeviceId(byte[] deviceIdArray)` Returns the result of a match based on the device Id returned from a previous match operation.
`Match`	`matchForDeviceId(byte[] deviceIdArray, Match match)` Returns the result of a match based on the device Id returned from a previous match operation.
`Match`	`matchForDeviceId(String deviceId)` Returns the result of a match based on the device Id returned from a previous match operation.
`Match`	`matchForDeviceId(String deviceId, Match match)` Returns the result of a match based on the device Id returned from a previous match operation.

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

- Field Detail
  - dataSet
```
public final Dataset dataSet
```
    The data set associated with the provider.
- Constructor Detail
  - Provider
```
public Provider(Dataset dataSet)
```
    Constructs a new Provider using the data set without a cache.
    
    Parameters:
    
    dataSet - to use for device detection
  - Provider
```
public Provider(Dataset dataSet,
                int cacheSize)
```
    Constructs a new Provider using the data set, with a cache of the size provided.
    
    Parameters:
    
    dataSet - to use for device detection
    
    cacheSize - to be used with the provider, 0 for no cache
- Method Detail
  - getDetectionCount
```
public long getDetectionCount()
```
    The total number of detections performed by the data set.
    
    Returns:
    
    total number of detections performed by this data set
  - getPercentageCacheMisses
```
public double getPercentageCacheMisses()
```
    Returns:
    
    the percentage of requests for User-Agents which were not already contained in the cache.
  - getCacheSwitches
```
@Deprecated
public long getCacheSwitches()
```
    Deprecated.
    
    Returns:
    
    the number of times the User-Agents cache was switched. Caching switching is no longer used.
  - getCacheRequests
```
public double getCacheRequests()
```
    Returns:
    
    number of requests to the cache.
  - getCacheMisses
```
public long getCacheMisses()
```
    Returns:
    
    number of cache misses.
  - createMatch
```
public Match createMatch()
```
    Creates a new match instance to be used for matching.
    
    Returns:
    
    a match instance ready to be used with the Match methods.
  - match
```
public Match match(Map<String,String> headers)
            throws IOException
```
    For a given collection of HTTP headers returns a match containing information about the capabilities of the device and it's components.
    
    Parameters:
    
    headers - List of HTTP headers to use for the detection.
    
    Returns:
    
    Match object with detection results.
    
    Throws:
    
    IOException - if there was a problem accessing data file.
  - match
```
public Match match(Map<String,String> headers,
                   Match match)
            throws IOException
```
    For a given collection of HTTP headers returns a match containing information about the capabilities of the device and it's components.
    
    Parameters:
    
    headers - List of HTTP headers to use for the detection.
    
    match - A match object created by a previous match, or via the createMatch() method, not null.
    
    Returns:
    
    Match object with detection results.
    
    Throws:
    
    IOException - if there was a problem accessing data file.
  - match
```
public Match match(String targetUserAgent)
            throws IOException
```
    For a given User-Agent returns a match containing information about the capabilities of the device and it's components.
    
    Parameters:
    
    targetUserAgent - User-Agent string to be identified.
    
    Returns:
    
    Match object with detection results.
    
    Throws:
    
    IOException - if there was a problem accessing data file.
  - match
```
public Match match(String targetUserAgent,
                   Match match)
            throws IOException
```
    For a given User-Agent returns a match containing information about the capabilities of the device and it's components.
    
    Parameters:
    
    targetUserAgent - User-Agent string to be identified.
    
    match - A match object created by a previous match, or via the CreateMatch method.
    
    Returns:
    
    Match object with detection results.
    
    Throws:
    
    IOException - if there was a problem accessing data file.
  - matchForDeviceId
```
public Match matchForDeviceId(byte[] deviceIdArray)
                       throws IOException
```
    Returns the result of a match based on the device Id returned from a previous match operation.
    
    Parameters:
    
    deviceIdArray - Byte array representation of the device Id, not null.
    
    Returns:
    
    Match object with detection results.
    
    Throws:
    
    IOException - if there was a problem accessing data file.
  - matchForDeviceId
```
public Match matchForDeviceId(String deviceId)
                       throws IOException
```
    Returns the result of a match based on the device Id returned from a previous match operation.
    
    Parameters:
    
    deviceId - String representation of the device Id, not null.
    
    Returns:
    
    Match object with detection results.
    
    Throws:
    
    IOException - if there was a problem accessing data file.
  - matchForDeviceId
```
public Match matchForDeviceId(ArrayList<Integer> profileIds)
                       throws IOException
```
    Returns the result of a match based on the device Id returned from a previous match operation.
    
    Parameters:
    
    profileIds - List of profile IDs as integers, not null.
    
    Returns:
    
    Match object with detection results.
    
    Throws:
    
    IOException - if there was a problem accessing data file.
  - matchForDeviceId
```
public Match matchForDeviceId(byte[] deviceIdArray,
                              Match match)
                       throws IOException
```
    Returns the result of a match based on the device Id returned from a previous match operation.
    
    Parameters:
    
    deviceIdArray - Byte array representation of the device Id.
    
    match - A match object created by a previous match, or via the createMatch() method, not null.
    
    Returns:
    
    Match object with detection results.
    
    Throws:
    
    IOException - if there was a problem accessing data file.
  - matchForDeviceId
```
public Match matchForDeviceId(String deviceId,
                              Match match)
                       throws IOException
```
    Returns the result of a match based on the device Id returned from a previous match operation.
    
    Parameters:
    
    deviceId - String representation of the device Id.
    
    match - A match object created by a previous match, or via the createMatch() method, not null.
    
    Returns:
    
    Match object with detection results.
    
    Throws:
    
    IOException - if there was a problem accessing data file.
  - matchForDeviceId
```
public Match matchForDeviceId(ArrayList<Integer> profileIds,
                              Match match)
                       throws IOException
```
    Returns the result of a match based on the device Id returned from a previous match operation.
    
    Parameters:
    
    profileIds - List of profile IDs as integers.
    
    match - A match object created by a previous match, or via the createMatch() method.
    
    Returns:
    
    Match object with detection results.
    
    Throws:
    
    IOException - if there was a problem accessing data file.

Class Provider

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

dataSet

Constructor Detail

Provider

Provider

Method Detail

getDetectionCount

getPercentageCacheMisses

getCacheSwitches

getCacheRequests

getCacheMisses

createMatch

match

match

match

match

matchForDeviceId

matchForDeviceId

matchForDeviceId

matchForDeviceId

matchForDeviceId

matchForDeviceId