fiftyone.mobile.detection

Class Match

java.lang.Object

fiftyone.mobile.detection.Match

public class Match
extends Object

Contains detection results with all the information relevant to the matched device.

Access Property values using the getValues(java.lang.String) method for property names and getValues(fiftyone.mobile.detection.entities.Property) for property objects. For example: match.getValues("IsMobile");

All values are returned as strings unless you request a specific format: match.getValues("ScreenPixelsWidth").toDouble();

If you want a more general device information like the rank you should use getSignature() method which returns a Signature object this device relates to.

Match also provides various metrics properties: device Id, method used, difference and rank.

• Device id consists of four components where each component is the Id of the Profile matched by the detector. Access like: match.getDeviceId();
• Detection method refers to the algorithm used for this match. Use like: match.getMethod();

  For more information on the detection methods see: how Pattern device detection works.

• Difference indicates the level of confidence in the current detection results. Used in conjunction with the detection method and only makes sense if "Numeric", "Closest" or "Nearest" algorithm was used. The higher the number the lower the confidence.
• Rank provides information on the level of popularity of the User-Agent used to create this match. The lower the rank the more popular the User-Agent is. Popularity is determined by 51Degrees based on our internal usage statistics.

Keeping the data file up to date improves the overall quality of detection as the 51Degrees data team adds (on average) 200 new devices to our database each week. With Premium and Enterprise data files can benefit from the automatic data updates as well as a wider range of properties and more devices.

This object should not be created manually in the external code. Use one of the match methods in the Provider class to obtain a match object with data members initialised.

For more information see https://51degrees.com/Support/Documentation/Java

Field Summary

Fields

Modifier and Type	Field and Description
String	cookie A string that contains the cookie header for the request.

Method Summary

Modifier and Type	Method and Description
int	getClosestSignaturesCount()
Dataset	getDataSet()
String	getDeviceId() The unique id of the device represented by the match.
byte[]	getDeviceIdAsByteArray() Id of the device represented as an array of bytes.
int	getDifference() The numeric difference between the target User-Agent and the match.
long	getElapsed()
MatchMethods	getMethod() Returns the detection method used to obtain this object.
int	getNodesEvaluated()
int	getNodesFound()
Profile[]	getProfiles() Array of profiles associated with the device that was found.
Map<String,String[]>	getResults() Deprecated. use getValues methods
int	getRootNodesEvaluated()
Signature	getSignature() Returns a Signature that best fits the provided User-Agent string.
int	getSignaturesCompared()
int	getSignaturesRead()
int	getStringsRead()
String	getTargetUserAgent()
String	getUserAgent()
Values	getValues(Property property) Gets the Values associated with the property name using the profiles found by the match.
Values	getValues(String propertyName) Gets the Values associated with the property name using the profiles found by the match.
String	toString() A string representation of the nodes found from the target User-Agent.
void	updateProfile(int profileId) Override the profiles found by the match with the profileId provided.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

cookie

public String cookie

A string that contains the cookie header for the request.

Method Detail

getDataSet

public Dataset getDataSet()

Returns:

Dataset used to create the match.

getTargetUserAgent

public String getTargetUserAgent()

Returns:

target User-Agent string used for detection

getElapsed

public long getElapsed()

Returns:

the elapsed time for the match.

getSignature

public Signature getSignature()
                       throws IOException

Returns a Signature that best fits the provided User-Agent string. A signature can be used to retrieve profiles and rank.

Returns:

Signature with best match to the User-Agent provided.

Throws:

IOException

getMethod

public MatchMethods getMethod()

Returns the detection method used to obtain this object. Method used reflects the confidence of the detector in the accuracy of the current match.

• "Exact" means the detector is confident the results are accurate.
• "None" means the User-Agent provided is fake.
• "Numeric", "Closest" and "Nearest" will always return a result but the getDifference() should be used to assess the accuracy of the detection. The higher the number the less confident the detector is.

With Premium or Enterprise data files you will see more "Exact" detections as the number of device combinations available in these files is significantly larger than in the "Lite" data file. Compare data options

For more information on detection methods see: how Pattern device detection works

Returns:

MatchMethods used to obtain match.

getClosestSignaturesCount

public int getClosestSignaturesCount()

Returns:

number of closest signatures returned for evaluation.

getSignaturesCompared

public int getSignaturesCompared()

Returns:

integer representing number of signatures compared against the User-Agent if closest match method was used.

getSignaturesRead

public int getSignaturesRead()

Returns:

integer representing number of signatures read during detection

getRootNodesEvaluated

public int getRootNodesEvaluated()

Returns:

integer representing number of root node checked

getNodesEvaluated

public int getNodesEvaluated()

Returns:

integer representing the number of nodes checked

getNodesFound

public int getNodesFound()
                  throws IOException

Returns:

the number of nodes found by the match.

Throws:

IOException

getStringsRead

public int getStringsRead()

Returns:

integer representing number of strings read for the match

getProfiles

public Profile[] getProfiles()
                      throws IOException

Array of profiles associated with the device that was found. Profiles can then be used to retrieve properties and values.

Returns:

array of profiles associated with the device that was found.

Throws:

IOException - if there was a problem accessing data file.

getDifference

public int getDifference()

The numeric difference between the target User-Agent and the match. Numeric sub strings of the same length are compared based on the numeric value. Other character differences are compared based on the difference in ASCII values of the two characters at the same positions.

Returns:

numeric difference.

getDeviceId

public String getDeviceId()
                   throws IOException

The unique id of the device represented by the match. Id is composed of several profiles separated by hyphen symbol. One profile is chosen per each component.

Device Id can be stored for future use and the relevant properties and values restored using the Provider.matchForDeviceId(java.lang.String) method.

Returns:

string representing unique id of device

Throws:

IOException - if there was a problem accessing data file.

getDeviceIdAsByteArray

public byte[] getDeviceIdAsByteArray()
                              throws IOException

Id of the device represented as an array of bytes. Unlike the String Id this Id only contains integers and no hyphen separators.

To obtain the unique profile IDs wrap the byte array in a ByteBuffer and use getInt() repeatedly.

To obtain a Match with the corresponding properties and values use the Provider.matchForDeviceId(byte[]).

Returns:

Profile Id represented as byte array. Note that Id separators such as "-" are not part of the byte array, only the integer IDs are.

Throws:

IOException - if there was a problem accessing the data file.

getUserAgent

public String getUserAgent()
                    throws IOException

Returns:

User-Agent of the matching device with irrelevant characters removed.

Throws:

IOException

getResults

@Deprecated
public Map<String,String[]> getResults()
                                             throws IOException

Deprecated. use getValues methods

This method is not memory efficient and should be avoided as the Match class now exposes an getValues methods keyed on property name.

Returns:

the results of the match as a sorted list of property names and values.

Throws:

IOException - if there was a problem accessing data file.

getValues

public Values getValues(Property property)
                 throws IOException

Gets the Values associated with the property name using the profiles found by the match. If matched profiles don't contain a value then the default profiles for each of the components are also checked. If a value is provided via the property value override functionality then this will be returned in place of the static value from the dataset.

Parameters:

property - The property whose values are required.

Returns:

Array of the values associated with the property, or null if the property does not exist.

Throws:

IOException - if there was a problem accessing data file.

getValues

public Values getValues(String propertyName)
                 throws IOException

Gets the Values associated with the property name using the profiles found by the match. If matched profiles don't contain a value then the default profiles for each of the components are also checked.

Parameters:

propertyName - The property name whose values are required.

Returns:

Array of the values associated with the property, or null if the property does not exist.

Throws:

IOException - if there was a problem accessing data file.

updateProfile

public void updateProfile(int profileId)
                   throws IOException

Override the profiles found by the match with the profileId provided.

Parameters:

profileId - The ID of the profile to replace the existing component

Throws:

IOException - indicates an I/O exception occurred

toString

public String toString()

A string representation of the nodes found from the target User-Agent.

Overrides:

toString in class Object

Returns:

a string representation of the match.