fiftyone.mobile.detection.entities.Component Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of 51Degrees.detection.core Show documentation
51Degrees core detection solution
The newest version!
package fiftyone.mobile.detection.entities;

import fiftyone.mobile.detection.Dataset;
import fiftyone.mobile.detection.readers.BinaryReader;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

/* *********************************************************************
 * This Source Code Form is copyright of 51Degrees Mobile Experts Limited. 
 * Copyright 2014 51Degrees Mobile Experts Limited, 5 Charlotte Close,
 * Caversham, Reading, Berkshire, United Kingdom RG4 7BY
 * 
 * This Source Code Form is the subject of the following patent 
 * applications, owned by 51Degrees Mobile Experts Limited of 5 Charlotte
 * Close, Caversham, Reading, Berkshire, United Kingdom RG4 7BY: 
 * European Patent Application No. 13192291.6; and 
 * United States Patent Application Nos. 14/085,223 and 14/085,301.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0.
 * 
 * If a copy of the MPL was not distributed with this file, You can obtain
 * one at http://mozilla.org/MPL/2.0/.
 * 
 * This Source Code Form is "Incompatible With Secondary Licenses", as
 * defined by the Mozilla Public License, v. 2.0.
 * ********************************************************************* */
/**
 * Every device can be split into the major components of hardware, operating
 * system and browser. The properties and values associated with these
 * components are accessed via this class. 
 * 
 * As there are a small number of components they are always held in memory.
 * 
 * For more information see:
 * http://51degrees.com/Support/Documentation/Java
 */
/**
 * Every device can be split into the major components of hardware, operating
 * system and browser. These the properties and values associated with these
 * components are represented via this class.
 */
public abstract class Component extends BaseEntity 
                                implements Comparable {
    /**
     * The default profile that should be returned for the component.
     */
    private Profile defaultProfile;
    /**
     * Offset for the default profile that should be returned for the component.
     */
    private final int defaultProfileOffset;
    /**
     * The unique name of the component.
     */
    private String name;
    /**
     * Offset for the unique name of the component.
     */
    private final int nameOffset;
    /**
     * An array of profiles associated with the component.
     */
    private Profile[] profiles;
    /**
     * The unique Id of the component. Does not change between different data
     * sets.
     */
    private final int componentId;
    /**
     * Array of properties associated with the component.
     */
    private Property[] properties;

    /**
     * Constructs a new instance of Component
     *
     * @param dataSet The data set whose components list the component is
     * contained within
     * @param index Index of the component within the list
     * @param reader the BinaryReader object to be used
     */
    public Component(Dataset dataSet, int index, BinaryReader reader) {
        super(dataSet, index);
        componentId = reader.readByte();
        nameOffset = reader.readInt32();
        defaultProfileOffset = reader.readInt32();
    }
    
    /**
     * Compares this component to another using the numeric ComponentId field.
     *
     * @param other The component to be compared against
     * @return Indication of relative value based on ComponentId field
     */
    @Override
    public int compareTo(Component other) {
        return getComponentId() - other.getComponentId();
    }
    
    /**
     * The default profile that should be returned for the component.
     * @return default profile that should be returned for the component
     * @throws java.io.IOException indicates an I/O exception occurred
     */
    public Profile getDefaultProfile() throws IOException {
        if (defaultProfile == null) {
            synchronized (this) {
                if (defaultProfile == null) {
                    defaultProfile = getDataSet().getProfiles().get(
                            defaultProfileOffset);
                }
            }
        }
        return defaultProfile;
    }
    
    /**
     * An array of the profiles.
     * @return an array of the profiles.
     * @throws java.io.IOException indicates an I/O exception occurred
     */
    public Profile[] getProfiles() throws IOException {
        if (profiles == null) {
            synchronized (this) {
                if (profiles == null) {
                    profiles = doGetProfiles();
                }
            }
        }
        return profiles;
    }
    
    /**
     * Array of properties the component relates to.
     *
     * @return array of properties the component relates to.
     * @throws IOException indicates an I/O exception occurred
     */
    public Property[] getProperties() throws IOException {
        if (properties == null) {
            synchronized (this) {
                if (properties == null) {
                    properties = doGetProperties();
                }
            }
        }
        return properties;
    }
    
    /**
     * Initialises the references to profiles.
     * @throws java.io.IOException indicates an I/O exception occurred
     */
    public void init() throws IOException {
        if (name == null)
            name = getName();
        if (defaultProfile == null)
            defaultProfile = getDataSet().getProfiles().get(defaultProfileOffset);
        if (profiles == null)
            profiles = doGetProfiles();
    }
    
    /**
     * The unique name of the component.
     * @return unique name of the component
     * @throws java.io.IOException indicates an I/O exception occurred 
     */
    public String getName() throws IOException {
        if (name == null) {
            synchronized (this) {
                if (name == null) {
                    name = getDataSet().strings.get(nameOffset).toString();
                }
            }
        }
        return name;
    }

    /**
     * Returns an array of all the profiles that relate to this component.
     * @return An array of profiles associated with the component.
     */
    private Profile[] doGetProfiles() throws IOException {
        List temp = new ArrayList();
        for (Profile profile : getDataSet().getProfiles()) {
            if (profile.getComponent().getComponentId() == componentId) {
                temp.add(profile);
            }
        }
        return temp.toArray(new Profile[temp.size()]);
    }
    
    /**
     * Returns an array of the properties associated with the component.
     * @return An array of the properties associated with the component.
     */
    private Property[] doGetProperties() throws IOException {
        List properties = new ArrayList();
        for (Property property : getDataSet().getProperties()) {
            if (property.getComponent().getComponentId() == componentId) {
                properties.add(property);
            }
        }
        return properties.toArray(new Property[properties.size()]);
    }

    /**
     * The unique Id of the component.
     * @return The unique Id of the component.
     */
    public int getComponentId() {
        return componentId;
    }

    /**
     * Returns the components name.
     * @return Returns the components name.
     */
    @Override
    public String toString() {
        try {
            return this.getName();
        } catch (IOException e) {
            return "Null";
        }
    }
    
    /**
     * 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.
     * @return 
     */
    public abstract String[] getHttpheaders();
}