fiftyone.mobile.detection

Class TrieProvider

java.lang.Object

fiftyone.mobile.detection.TrieProvider

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

TrieProviderV3, TrieProviderV32

public abstract class TrieProvider
extends Object
implements Closeable

Decision trie data structure provider.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TrieProvider.OffsetType The type of integers used to represent the offset to the children.

Field Summary

Fields

Modifier and Type	Field and Description
protected ByteBuffer	_properties Byte array of the available properties.
protected Map<String,Integer>	_propertyIndex Dictionary of property names to indexes.
protected List<String>	_propertyNames List of the available property names.
String	copyright The copy right notice associated with the data file.
protected List<String[]>	propertyHttpHeaders List of HTTP headers for each property index.

Constructor Summary

Constructors

Constructor and Description
TrieProvider(String copyright, byte[] strings, byte[] properties, byte[] devices, short[] lookupList, long nodesLength, long nodesOffset, TriePool pool) Constructs a new instance of a tree provider.

Method Summary

Modifier and Type	Method and Description
void	close() Disposes of the pool assigned to the provider.
String	getDefaultPropertyValue(String propertyName) Returns the default property value for a null User-Agent.
String	getDeviceId(int deviceIndex) Returns the device id matching the device index.
int	getDeviceIndex(String userAgent) Returns the index of the device associated with the given user agent.
Map<String,Integer>	getDeviceIndexes(Map<String,String> headers) Returns a collection of device indexes for each of the relevant HTTP headers provided.
List<String>	getHttpHeaders() Returns a list of Http headers that the provider can use for device detection.
String	getPropertyValue(int deviceIndex, int propertyIndex) Returns the value of the property index provided for the device index provided.
String	getPropertyValue(int deviceIndex, String property) Returns the property value based on the useragent provided.
String	getPropertyValue(Map<String,Integer> deviceIndexes, int propertyIndex) Returns the value of the property index provided from the device indexes provided.
String	getPropertyValue(Map<String,Integer> deviceIndexes, String property) Returns the property value based on the device indexes provided.
String	getPropertyValue(String userAgent, String propertyname) Returns the value of the property for the user agent provided.
String	getPropertyValueWithMultiHeaders(Map<String,String> headers, String propertyName) Returns the value of the property for the user agent provided.
protected String	getStringValue(int offset) Returns the String at the offset provided.
String	getUserAgent(String userAgent) Returns the user agent matched against the one provided.
List<String>	propertyNames() List of all property names for the provider.
static int	sizeOfOffsets(TrieProvider.OffsetType offsetType) The number of bytes each offset takes.

Methods inherited from class java.lang.Object

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

Field Detail

copyright

public String copyright

The copy right notice associated with the data file.

_properties

protected ByteBuffer _properties

Byte array of the available properties.

_propertyIndex

protected final Map<String,Integer> _propertyIndex

Dictionary of property names to indexes.

_propertyNames

protected final List<String> _propertyNames

List of the available property names.

propertyHttpHeaders

protected final List<String[]> propertyHttpHeaders

List of HTTP headers for each property index.

Constructor Detail

TrieProvider

public TrieProvider(String copyright,
                    byte[] strings,
                    byte[] properties,
                    byte[] devices,
                    short[] lookupList,
                    long nodesLength,
                    long nodesOffset,
                    TriePool pool)
             throws FileNotFoundException

Constructs a new instance of a tree provider.

Parameters:

copyright - The copyright notice for the data file.

strings - Array containing all Strings in the output.

properties - Array of properties.

devices - Array of devices.

lookupList - Lookups data array.

nodesLength - The length of the node data.

nodesOffset - The position of the start of the nodes in the file provided.

pool - Pool connected to the data source.

Throws:

FileNotFoundException - indicates device data file was not found.

Method Detail

propertyNames

public List<String> propertyNames()

List of all property names for the provider.

Returns:

list of all property names for the provider

getHttpHeaders

public List<String> getHttpHeaders()

Returns a list of Http headers that the provider can use for device detection.

Returns:

a list of Http headers that the provider can use for device detection.

getUserAgent

public String getUserAgent(String userAgent)
                    throws Exception

Returns the user agent matched against the one provided.

Parameters:

userAgent - user agent to match

Returns:

user agent string that was matched against the user agent provided

Throws:

Exception - indicates an exception occurred

getDeviceIndex

public int getDeviceIndex(String userAgent)
                   throws Exception

Returns the index of the device associated with the given user agent. The index returned may vary across different versions of the source data file and should not be stored. The "Id" property will remain unique.

Parameters:

userAgent - user agent to get device index of.

Returns:

index of the device associated with the given user agent.

Throws:

Exception - indicates an exception occurred

getDeviceId

public String getDeviceId(int deviceIndex)

Returns the device id matching the device index.

Parameters:

deviceIndex - index of the device whose Id should be returned

Returns:

device id matching the device index

getDeviceIndexes

public Map<String,Integer> getDeviceIndexes(Map<String,String> headers)
                                     throws IOException,
                                            Exception

Returns a collection of device indexes for each of the relevant HTTP headers provided. Those headers which are unrelated to device detection are ignored.

Parameters:

headers - Collection of HTTP headers and values.

Returns:

Collection of headers and device indexes for each one.

Throws:

IOException - if there was a problem accessing data file.

Exception

getPropertyValue

public String getPropertyValue(int deviceIndex,
                               String property)

Returns the property value based on the useragent provided.

Parameters:

deviceIndex - The index of the device whose property should be returned.

property - the name of the property required.

Returns:

The value of the property for the given device index.

getPropertyValue

public String getPropertyValue(Map<String,Integer> deviceIndexes,
                               String property)

Returns the property value based on the device indexes provided.

Parameters:

deviceIndexes - Http headers and their device index.

property - The name of the property required.

Returns:

The value of the property for the given device index.

getDefaultPropertyValue

public String getDefaultPropertyValue(String propertyName)

Returns the default property value for a null User-Agent. Should be used when a property has been requested but the User-Agent or a collection of HTTP headers is null.

Parameters:

propertyName - String representing name of the property required.

Returns:

String with value associated with a specific property when the User-Agent Header is set to null.

getPropertyValue

public String getPropertyValue(Map<String,Integer> deviceIndexes,
                               int propertyIndex)

Returns the value of the property index provided from the device indexes provided. Matches the Http header to the property index.

Parameters:

deviceIndexes - Indexes for the device.

propertyIndex - Index of the property required.

Returns:

The value of the property for the given device indexes.

getPropertyValue

public String getPropertyValue(int deviceIndex,
                               int propertyIndex)

Returns the value of the property index provided for the device index provided.

Parameters:

deviceIndex - Index for the device.

propertyIndex - Index of the property required.

Returns:

The value of the property index for the given device index.

getPropertyValueWithMultiHeaders

public String getPropertyValueWithMultiHeaders(Map<String,String> headers,
                                               String propertyName)
                                        throws Exception

Returns the value of the property for the user agent provided.

Parameters:

headers - Collection of HTTP headers and values.

propertyName - Name of the property required.

Returns:

The value of the property for the given user agent.

Throws:

Exception - if there was a problem accessing data file.

getPropertyValue

public String getPropertyValue(String userAgent,
                               String propertyname)
                        throws Exception

Returns the value of the property for the user agent provided.

Parameters:

userAgent - User agent of the request.

propertyname - Name of the property required.

Returns:

The value of the property for the given user agent.

Throws:

Exception - if there was a problem accessing data file.

close

public void close()

Disposes of the pool assigned to the provider.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

getStringValue

protected String getStringValue(int offset)

Returns the String at the offset provided.

Parameters:

offset - integer offset.

Returns:

value as a string.

sizeOfOffsets

public static int sizeOfOffsets(TrieProvider.OffsetType offsetType)

The number of bytes each offset takes.

Parameters:

offsetType - offset type

Returns:

number of bytes each offset takes.