fiftyone.mobile.detection.entities.SignatureV32 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.IDisposableIterator;
import fiftyone.mobile.detection.readers.BinaryReader;
import java.io.IOException;
import java.util.Iterator;
import java.util.logging.Level;
import java.util.logging.Logger;

/* *********************************************************************
 * 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.
 * ********************************************************************* */
/**
 * Signature of a user agent in version 3.2 data format.
 */
public class SignatureV32 extends Signature {
    /**
     * List of the node offsets the signature relates to ordered by 
     * offset of the node.
     */
    private int[] nodeOffsets;
    /**
     * The rank of the signature.
     */
    private final int rank;
    /**
     * The index in the "DataSet.SignatureNodeOffsets list of the first
     * node associated with this signature.
     */
    private final int firstNodeOffsetIndex;
    /**
     * Flags used to provide extra details about the signature.
     */
    private final byte flags;
    /**
     * The number of nodes associated with the signature.
     */
    private final byte nodeCount;
    
    /**
     * Constructs a new instance of SignatureV32.
     * @param dataSet The data set the signature is contained within.
     * @param index The index in the data structure to the signature.
     * @param reader Reader connected to the source data structure and 
     * positioned to start reading.
     */
    public SignatureV32(Dataset dataSet, int index, BinaryReader reader) {
        super(dataSet, index, reader);
        this.nodeCount = reader.readByte();
        this.firstNodeOffsetIndex = reader.readInt32();
        this.rank = reader.readInt32();
        this.flags = reader.readByte();
    }

    /**
     * Gets the rank, where a lower number means the signature is more popular, 
     * of the signature compared to other signatures.
     * @return Gets the rank, where a lower number means the signature is 
     * more popular, of the signature compared to other signatures.
     */
    @Override
    public int getRank() {
        return this.rank;
    }

    /**
     * Returns List of the node offsets the signature relates to ordered by 
     * offset of the node.
     * @return List of the node offsets the signature relates to ordered by 
     * offset of the node.
     * @throws java.io.IOException
     */
    @Override
    public int[] getNodeOffsets() {
        if (this.nodeOffsets == null) {
            synchronized(this) {
                if (this.nodeOffsets == null) {
                    int[] nodeOffsets = new int[nodeCount];
                    IDisposableIterator iterator = null;
                    try {
                        iterator = dataSet.signatureNodeOffsets.getRange(   
                                   firstNodeOffsetIndex, nodeCount);
                        for (int i = 0; i < nodeCount; i++) {
                            nodeOffsets[i] = iterator.next().value;
                        }
                    } catch (IOException ex) {
                        Logger.getLogger(SignatureV32.class.getName()).log(Level.SEVERE, null, ex);
                    }
                    finally {
                        if (iterator != null) {
                            iterator.dispose();
                        }
                    }
                    this.nodeOffsets = nodeOffsets;
                }
            }
        }
        return this.nodeOffsets;
    }

    /**
     * The number of characters in the signature.
     * @return The number of characters in the signature.
     */
    @Override
    protected int getSignatureLength() {
        try {
            Node lastNode = dataSet.nodes.get(dataSet.signatureNodeOffsets
                            .get(nodeCount + firstNodeOffsetIndex - 1).value);
            return lastNode.position + lastNode.getLength() + 1;
        } catch (IOException ex) {
            Logger.getLogger(SignatureV32.class.getName())
                                         .log(Level.SEVERE, null, ex);
        }
        return -1;
    }
    
}