fiftyone.mobile.detection.entities

Class Component

java.lang.Object

fiftyone.mobile.detection.entities.BaseEntity

fiftyone.mobile.detection.entities.Component

All Implemented Interfaces:

Comparable<Component>

Direct Known Subclasses:

ComponentV31, ComponentV32

public abstract class Component
extends BaseEntity
implements Comparable<Component>

Every device can be split into the major components of hardware, operating system, crawler and browser. Each component has a number of properties and profiles assigned to it.

Components are always held in memory as there is only a small number of them.

Full list of components in the data set can be retrieved like: dataSet.getComponents();. Data set also provides a way to retrieve a specific component:

• Hardware component: dataSet.getHardware();
• Software component: dataSet.getSoftware();
• Browser component: dataSet.getBrowsers();
• Crawler component: dataSet.getCrawlers();

Component can be used to retrieve profiles and properties.

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 inherited from class fiftyone.mobile.detection.entities.BaseEntity

dataSet, index

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	compareTo(Component other) Compares this component to another using the numeric ComponentId field.
boolean	equals(Component other) Compares this instance to another using the component Id.
int	getComponentId() The unique Id of the component.
Profile	getDefaultProfile() The default profile that should be returned for the component.
abstract String[]	getHttpheaders() List of HTTP headers that should be checked in order to perform a detection where more headers than User-Agent are available.
String	getName() The unique name of the component as a string.
Profile[]	getProfiles() An array of profiles associated with the component.
Property[]	getProperties() Array of properties the component relates to.
void	init() Initialises the references to profiles.
String	toString() Returns the components name.

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

Component

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

Constructs a new instance of Component

Parameters:

dataSet - The data set whose components list the component is contained within.

index - Index of the component within the list.

reader - the BinaryReader object to be used.

Method Detail

compareTo

public int compareTo(Component other)

Compares this component to another using the numeric ComponentId field.

Specified by:

compareTo in interface Comparable<Component>

Parameters:

other - The component to be compared against.

Returns:

Indication of relative value based on ComponentId field.

getDefaultProfile

public Profile getDefaultProfile()
                          throws IOException

The default profile that should be returned for the component.

Returns:

default profile that should be returned for the component.

Throws:

IOException - If there was a problem accessing data file.

getProfiles

public Profile[] getProfiles()
                      throws IOException

An array of profiles associated with the component.

Returns:

an array of the profiles.

Throws:

IOException - if there was a problem accessing data file.

getProperties

public Property[] getProperties()
                         throws IOException

Array of properties the component relates to.

Returns:

array of properties the component relates to.

Throws:

IOException - if there was a problem accessing data file.

init

public void init()
          throws IOException

Initialises the references to profiles. This method should not be called as it is part of the internal logic.

Throws:

IOException - if there was a problem accessing data file.

getName

public String getName()
               throws IOException

The unique name of the component as a string.

Returns:

unique name of the component as a string.

Throws:

IOException - if there was a problem accessing data file.

getComponentId

public int getComponentId()

The unique Id of the component. Does not change between different data sets. Consists of four Profile IDs.

Returns:

The unique Id of the component.

toString

public String toString()

Returns the components name.

Overrides:

toString in class Object

Returns:

Returns the components name.

getHttpheaders

public abstract String[] getHttpheaders()
                                 throws IOException

List of HTTP headers that should be checked in order to perform a detection where more headers than User-Agent are available. This data is used by methods that can HTTP Header collections.

Returns:

List of HTTP headers that should be checked in order to perform detection.

Throws:

IOException - if there was a problem accessing data file.

equals

public boolean equals(Component other)

Compares this instance to another using the component Id.

Parameters:

other - The component to be compared against.

Returns:

True if componentId of this component is equal to the ComponentId of the other component.