fiftyone.mobile.detection.entities

Class Node

java.lang.Object

fiftyone.mobile.detection.entities.BaseEntity

fiftyone.mobile.detection.entities.Node

All Implemented Interfaces:

Comparable<Node>

Direct Known Subclasses:

Node, Node

public abstract class Node
extends BaseEntity
implements Comparable<Node>

A node in the tree of characters for each character position.

Every character position in the string contains a tree of nodes which are evaluated until either a complete node is found, or no nodes are found that match at the character position.

The list of Signature entities is in ascending order of the complete nodes which form the sub strings of the signature. Complete nodes are found at detection time for the target User-Agent and then used to search for a corresponding signature. If one does not exist then Signatures associated with the nodes that were found are evaluated to find one that is closest to the target User-Agent.

Root nodes are the first node at a character position. It's children are based on sequences of characters that if present lead to the next node. A complete node will represent a sub string within the User-Agent.

For more information see https://51degrees.com/Support/Documentation/Java

Field Summary

Fields

Modifier and Type	Field and Description
protected NodeIndex[]	children A list of all the child node indexes.
protected short	childrenCount Number of children associated with the node.
short	nextCharacterPosition The next character position to the left of this node or a negative number if this is not a complete node.
static int	NODE_INDEX_LENGTH The length of a node index.
static int	NODE_NUMERIC_INDEX_LENGTH The length of a numeric node index.
protected long	nodeStartStreamPosition The position in the stream of the first byte of the node.
protected short	numericChildrenCount Number of numeric children associated with the node.
short	position The position of the first character the node represents in the signature or target User-Agent.
protected int	rankedSignatureCount Number of ranked signature indexes associated with the node.

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

dataSet, index

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addCharacters(byte[] values) Adds the characters for this node to the values array.
int	compareTo(Node other) Compares one node to another for the purposes of determining the signature the node relates to.
byte[]	getCharacters() Gets an array containing all the characters of the node.
int	getChildrenLength()
Node	getCompleteNode(MatchState state) Returns a complete node for the match object provided.
Node	getCompleteNumericNode(MatchState state) Gets a complete node, or if one isn't available exactly the closest numeric one to the target User-Agent at the current position.
boolean	getIsOverlap(MatchState state) Returns true if any of the nodes in the match have overlapping characters with this one.
int	getLength() Returns the number of characters in the node tree.
abstract NodeNumericIndex[]	getNumericChildren()
int	getNumericChildrenLength()
abstract int[]	getRankedSignatureIndexes()
Node	getRoot() Returns the root node for this node.
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.
NodeNumericIndex[]	readNodeNumericIndexes(Dataset dataSet, BinaryReader reader, short count) Used by the constructor to read the variable length list of child indexes that contain numeric values.
String	toString() Returns a string of spaces with the characters relating to this node populated.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

NODE_INDEX_LENGTH

public static final int NODE_INDEX_LENGTH

The length of a node index.

See Also:

Constant Field Values

NODE_NUMERIC_INDEX_LENGTH

public static final int NODE_NUMERIC_INDEX_LENGTH

The length of a numeric node index.

See Also:

Constant Field Values

nodeStartStreamPosition

protected final long nodeStartStreamPosition

The position in the stream of the first byte of the node.

numericChildrenCount

protected final short numericChildrenCount

Number of numeric children associated with the node.

childrenCount

protected final short childrenCount

Number of children associated with the node.

children

protected NodeIndex[] children

A list of all the child node indexes.

nextCharacterPosition

public final short nextCharacterPosition

The next character position to the left of this node or a negative number if this is not a complete node.

position

public final short position

The position of the first character the node represents in the signature or target User-Agent.

rankedSignatureCount

protected int rankedSignatureCount

Number of ranked signature indexes associated with the node.

Constructor Detail

Node

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

Constructs a new instance of Node

Parameters:

dataSet - The data set the node is contained within.

offset - The offset in the data structure to the node.

reader - BinaryReader object to be used.

Method Detail

getRoot

public Node getRoot()
             throws IOException

Returns the root node for this node.

Returns:

root node for this node

Throws:

IOException - if there was a problem accessing data file.

compareTo

public int compareTo(Node other)

Compares one node to another for the purposes of determining the signature the node relates to.

Specified by:

compareTo in interface Comparable<Node>

Parameters:

other - node to be compared.

Returns:

-1 if this node is lower than the other, 1 if higher or 0 if equal.

getLength

public int getLength()
              throws IOException

Returns the number of characters in the node tree.

Returns:

number of characters in the node tree

Throws:

IOException - if there was a problem accessing data file.

getCharacters

public byte[] getCharacters()
                     throws IOException

Gets an array containing all the characters of the node.

Returns:

array containing all the characters of the node.

Throws:

IOException - if there was a problem accessing data file.

readNodeNumericIndexes

public NodeNumericIndex[] readNodeNumericIndexes(Dataset dataSet,
                                                 BinaryReader reader,
                                                 short count)

Used by the constructor to read the variable length list of child indexes that contain numeric values.

Parameters:

dataSet - The data set the node is contained within.

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

count - The number of node indexes that need to be read.

Returns:

variable length list of child indexes that contain numeric values.

getRankedSignatureIndexes

public abstract int[] getRankedSignatureIndexes()
                                         throws IOException

Returns:

An array of the ranked signature indexes for the node.

Throws:

IOException - if there was a problem accessing data file.

getChildrenLength

public int getChildrenLength()

Returns:

number of elements in the children array.

getNumericChildrenLength

public int getNumericChildrenLength()

Returns:

number of element in the numericChildren array.

getNumericChildren

public abstract NodeNumericIndex[] getNumericChildren()
                                               throws IOException

Returns:

an array of all the numeric children.

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.

getCompleteNumericNode

public Node getCompleteNumericNode(MatchState state)
                            throws IOException

Gets a complete node, or if one isn't available exactly the closest numeric one to the target User-Agent at the current position.

Parameters:

state - current working state of the matching process

Returns:

a complete node, or if one isn't available exactly the closest numeric one.

Throws:

IOException - if there was a problem accessing data file.

getCompleteNode

public Node getCompleteNode(MatchState state)
                     throws IOException

Returns a complete node for the match object provided.

Parameters:

state - current working state of the matching process.

Returns:

The next child node, or null if there isn't one.

Throws:

IOException - if there was a problem accessing data file.

getIsOverlap

public boolean getIsOverlap(MatchState state)
                     throws IOException

Returns true if any of the nodes in the match have overlapping characters with this one.

Parameters:

state - current working state of the matching process

Returns:

true if any of the nodes in the match have overlapping characters with this one.

Throws:

IOException - if there was a problem accessing data file.

addCharacters

public void addCharacters(byte[] values)
                   throws IOException

Adds the characters for this node to the values array.

Parameters:

values - array to add characters to.

Throws:

IOException - if there was a problem accessing data file.

toString

public String toString()

Returns a string of spaces with the characters relating to this node populated.

Overrides:

toString in class Object

Returns:

a string representation of the node