fiftyone.mobile.detection.entities

Class Profile

java.lang.Object

fiftyone.mobile.detection.entities.BaseEntity

fiftyone.mobile.detection.entities.Profile

All Implemented Interfaces:

Comparable<Profile>

Direct Known Subclasses:

Profile, Profile

public abstract class Profile
extends BaseEntity
implements Comparable<Profile>

Profile is a collection of values for a single Component gathered under a unique Id.

All profiles belong to one of the four components: hardware, software, crawler and browser and have a number of values associated with each profile. The contents of existing profiles should not change over time. Each value contains a getter method for the corresponding Property.

Profiles make up the unique Id of a device. Each device Id consists of

Each profile relates to one or more Signature.

New profiles are added with each data file update. Some profiles may be removed if we do not see any use of the profile for a long period of time. Premium and Enterprise data contain a lot more profiles and hence provide better detection results, especially for less common devices. Compare data options.

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.

Field Summary

Fields

Modifier and Type	Field and Description
int	profileId Unique Id of the profile.
protected int[]	signatureIndexes An array of the signature indexes associated with the profile.
protected int[]	valueIndexes A list of the indexes of the values associated with the profile.

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

dataSet, index

Constructor Summary

Constructors

Constructor and Description
Profile(Dataset dataSet, int offset, BinaryReader reader) Constructs a new instance of the Profile

Method Summary

Modifier and Type	Method and Description
int	compareTo(Profile other) Compares this profile to another using the numeric ProfileId field.
Component	getComponent() The component the profile belongs to.
Property[]	getProperties() Returns an array of properties the profile relates to.
abstract int[]	getSignatureIndexes() An array of the signature indexes associated with the profile.
Signature[]	getSignatures() Gets the signatures related to the profile.
abstract int[]	getValueIndexes() A array of the indexes of the values associated with the profile in order of value index in the data set values list.
Value[]	getValues() Gets the values associated with the profile.
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.
String	toString() A string representation of the profiles display values.

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

Field Detail

signatureIndexes

protected volatile int[] signatureIndexes

An array of the signature indexes associated with the profile.

profileId

public final int profileId

Unique Id of the profile. Does not change between different data sets.

valueIndexes

protected volatile int[] valueIndexes

A list of the indexes of the values associated with the profile.

Constructor Detail

Profile

public Profile(Dataset dataSet,
               int offset,
               BinaryReader reader)

Constructs a new instance of the Profile

Parameters:

dataSet - The data set the profile will be contained within.

offset - The offset of the profile in the source data structure.

reader - Reader connected to the input stream.

Method Detail

compareTo

public int compareTo(Profile other)

Compares this profile to another using the numeric ProfileId field.

Specified by:

compareTo in interface Comparable<Profile>

Parameters:

other - The component to be compared against.

Returns:

Indication of relative value based on ProfileId field.

getComponent

public Component getComponent()
                       throws IOException

The component the profile belongs to.

Returns:

The Component the profile belongs to.

Throws:

IOException - if there was a problem accessing data file.

getProperties

public Property[] getProperties()
                         throws IOException

Returns an array of properties the profile relates to.

Returns:

array of properties associated with this profile.

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 - string name of the Property 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(Property property)
                 throws IOException

Gets the values associated with the property.

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.

getSignatures

public Signature[] getSignatures()
                          throws IOException

Gets the signatures related to the profile.

Returns:

array of signatures associated with this profile.

Throws:

IOException - if there was a problem accessing data file.

getValues

public Value[] getValues()
                  throws IOException

Gets the values associated with the profile.

Returns:

array of values associated with this profile.

Throws:

IOException - if there was a problem accessing data file.

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.

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

Throws:

IOException - if there was a problem accessing data file.

toString

public String toString()

A string representation of the profiles display values.

Overrides:

toString in class Object

Returns:

the profile as a string.

getValueIndexes

public abstract int[] getValueIndexes()
                               throws IOException

A array of the indexes of the values associated with the profile in order of value index in the data set values list.

Returns:

array of the indexes of the values associated with the profile.

Throws:

IOException - if there was a problem accessing data file.

getSignatureIndexes

public abstract int[] getSignatureIndexes()
                                   throws IOException

An array of the signature indexes associated with the profile.

Returns:

An array of the signature indexes associated with the profile.

Throws:

IOException - if there was a problem accessing data file.