fiftyone.mobile.detection.entities

Class Signature

java.lang.Object

fiftyone.mobile.detection.entities.BaseEntity

fiftyone.mobile.detection.entities.Signature

All Implemented Interfaces:

Comparable<Signature>

Direct Known Subclasses:

SignatureV31, SignatureV32

public abstract class Signature
extends BaseEntity
implements Comparable<Signature>

Signature of a User-Agent - the relevant characters from a User-Agent structured in a manner to enable rapid comparison with a target User-Agent.

A signature contains those characters of a User-Agent which are relevant for the purposes of device detection. For example: most User-Agents will start with "Mozilla" and therefore these characters are of very little use when detecting devices. Other characters such as those that represent the model of the hardware are very relevant.

A signature contains both an array of relevant characters from User-Agents identified when the data was created and the unique complete node identifies of relevant sub strings contained in multiple signatures and User-Agents. Together this information is used at detection time to rapidly identify the signature matching a target User-Agent.

Signatures relate to device properties via profiles. Each signature relates to one profile for each Component type.

Unlike other entities the signature may have a varying number of nodes and profiles associated with it depending on the data set. All signatures within a data set will have the same number of profiles and nodes associated with them all. As these can change across data sets they can't be included in the source code.

Objects of this class should not be created directly as they are part of the internal logic. Use the relevant Dataset method to access these objects.

For more information see: 51Degrees pattern data model.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Signature.ValueIterator Provides a way to iterate over the values of a provided signature.

Field Summary

Fields inherited from class fiftyone.mobile.detection.entities.BaseEntity

dataSet, index

Constructor Summary

Constructors

Constructor and Description
Signature(Dataset dataSet, int index, BinaryReader reader) Constructs a new instance of Signature.

Method Summary

Modifier and Type	Method and Description
int	compareTo(List<Node> nodes) Compares this signature to a list of node offsets.
int	compareTo(Signature other) Compares this signature to another based on the node offsets.
protected Node[]	doGetNodes()
String	getDeviceId() The unique Device Id for the signature.
int	getLength() The length in bytes of the signature.
abstract List<Integer>	getNodeOffsets() Array of node offsets associated with the signature.
Node[]	getNodes() An array of nodes associated with the signature.
Profile[]	getProfiles() List of the profiles the signature relates to.
SortedList<String,List<String>>	getPropertyValuesAsStrings() Gets a string list of the properties and names.
abstract int	getRank() Gets the rank, where a lower number means the signature is more popular, of the signature compared to other signatures.
protected abstract int	getSignatureLength() The number of characters in the signature.
Iterator<Value>	getValues()
Values	getValues(Property property) Gets the values associated with the property.
Values	getValues(String propertyName) Gets the values associated with the property name.
void	init() Called after the entire data set has been loaded to ensure any further initialisation steps that require other items in the data set can be completed.
protected static List<Integer>	readPositiveAndZeroIntegers(BinaryReader reader, int count) Populates the list provided with the positive values upto the number of items defined by count.
String	toString() String representation of the signature where irrelevant characters are removed.

Methods inherited from class fiftyone.mobile.detection.entities.BaseEntity

compareTo, compareTo, getDataSet, getIndex, getIsNumeric, getNumber, readIntegerArray, readIntegerList

Methods inherited from class java.lang.Object

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

Constructor Detail

Signature

public Signature(Dataset dataSet,
                 int index,
                 BinaryReader reader)

Constructs a new instance of Signature.

Parameters:

dataSet - the Dataset the signature is contained within.

index - the index in the data structure to the signature.

reader - BinaryReader connected to the source data structure and positioned to start reading.

Method Detail

getProfiles

public Profile[] getProfiles()
                      throws IOException

List of the profiles the signature relates to.

Returns:

List of the profiles the signature relates to.

Throws:

IOException - if there was a problem accessing data file.

getDeviceId

public String getDeviceId()
                   throws IOException

The unique Device Id for the signature. Is is composed of the four Profile IDs, one per each Component.

Returns:

unique Device Id for the signature.

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.

Parameters:

property - the Property whose values are required

Returns:

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.

Parameters:

propertyName - name of the Property whose values are required.

Returns:

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 Iterator<Value> getValues()
                          throws IOException

Returns:

an Iterator for the values associated with this signature.

Throws:

IOException - if there was a problem accessing data file.

getLength

public int getLength()
              throws IOException

The length in bytes of the signature.

Returns:

length in bytes of the signature.

Throws:

IOException - if there was a problem accessing data file.

doGetNodes

protected Node[] doGetNodes()
                     throws IOException

Returns:

an array of nodes associated with the signature.

Throws:

IOException - if there was a problem accessing data file.

getNodes

public Node[] getNodes()
                throws IOException

An array of nodes associated with the signature.

Returns:

An array of nodes associated with the signature.

Throws:

IOException - if there was a problem accessing data file.

readPositiveAndZeroIntegers

protected static List<Integer> readPositiveAndZeroIntegers(BinaryReader reader,
                                                           int count)

Populates the list provided with the positive values upto the number of items defined by count. The list returned is a reference to the binary reader's list to improve memory usage. The caller should use this to avoid creating lists with capacity larger than needed to improve memory usage.

Parameters:

reader - Reader connected to the source data structure and positioned to start reading

count - The number of offsets to read in

Returns:

a reference to the binary reader's list

init

public void init()
          throws IOException

Called after the entire data set has been loaded to ensure any further initialisation steps that require other items in the data set can be completed.

Do not reference this method directly as it is part of the internal logic.

Throws:

IOException - if there was a problem accessing data file.

getPropertyValuesAsStrings

public SortedList<String,List<String>> getPropertyValuesAsStrings()
                                                           throws IOException

Gets a string list of the properties and names.

Returns:

dictionary of properties and values for the signature.

Throws:

IOException - if there was a problem accessing data file.

compareTo

public int compareTo(List<Node> nodes)
              throws IOException

Compares this signature to a list of node offsets.

Parameters:

nodes - list of nodes to compare to.

Returns:

Indication of relative value based on the node offsets.

Throws:

IOException - if there was a problem accessing data file.

compareTo

public int compareTo(Signature other)

Compares this signature to another based on the node offsets. The node offsets in both signatures must be in ascending order.

Specified by:

compareTo in interface Comparable<Signature>

Parameters:

other - The signature to be compared against.

Returns:

Indication of relative value based based on node offsets.

toString

public String toString()

String representation of the signature where irrelevant characters are removed.

This method should not be called as it is part of the internal logic.

Overrides:

toString in class Object

Returns:

The signature as a string.

getNodeOffsets

public abstract List<Integer> getNodeOffsets()
                                      throws IOException

Array of node offsets associated with the signature.

Returns:

Array of node offsets associated with the signature.

Throws:

IOException - if there was a problem accessing data file.

getSignatureLength

protected abstract int getSignatureLength()
                                   throws IOException

The number of characters in the signature.

Returns:

The number of characters in the signature.

Throws:

IOException - if there was a problem accessing data file.

getRank

public abstract int getRank()
                     throws IOException

Gets the rank, where a lower number means the signature is more popular, of the signature compared to other signatures.

Returns:

Rank of the signature.

Throws:

IOException - if there was a problem accessing data file.