fiftyone.mobile.detection.entities

Class BaseEntity

java.lang.Object

fiftyone.mobile.detection.entities.BaseEntity

Direct Known Subclasses:

AsciiString, Component, Map, Node, NodeIndexBase, Profile, ProfileOffset, Property, Signature, Value

public class BaseEntity
extends Object

Base class for all entities in the DetectorDataSet. Contains common properties and methods for all data types contained in the data set.

All entities must belong to a data set and contain a unique integer key. Class provides this functionality along with many common methods used by multiple entities.

All entities in this package extend this class. Every entity contains a unique integer key.

Objects of this class should not be created directly as they are part of the internal logic.

For more information see: 51Degrees pattern data model.

Field Summary

Fields

Modifier and Type	Field and Description
Dataset	dataSet The data set the item relates to.
int	index The unique index of the item in the collection of items, or the unique offset to the item in the source data structure.

Method Summary

Modifier and Type	Method and Description
int	compareTo(BaseEntity other) Compares entities based on their Index properties.
int	compareTo(int offsetOrIndex) The unique index of the item in the collection of items, or the unique offset to the item in the source data structure.
protected Dataset	getDataSet()
int	getIndex()
static boolean	getIsNumeric(byte value) Determines if the value is an ASCII numeric value.
static int	getNumber(byte[] array, int start, int length) Returns an integer representation of the characters between start and end.
protected static int[]	readIntegerArray(BinaryReader reader, int count) Reads an integer array where the first integer is the number of following integers.
protected static List<Integer>	readIntegerList(BinaryReader reader, int count) Reads an integer list where the first integer is the number of following integers.

Methods inherited from class java.lang.Object

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

Field Detail

dataSet

public final Dataset dataSet

The data set the item relates to.

index

public final int index

The unique index of the item in the collection of items, or the unique offset to the item in the source data structure.

Method Detail

getIsNumeric

public static boolean getIsNumeric(byte value)

Determines if the value is an ASCII numeric value.

Parameters:

value - Byte value to be checked.

Returns:

True if the value is an ASCII numeric character.

compareTo

public int compareTo(int offsetOrIndex)

The unique index of the item in the collection of items, or the unique offset to the item in the source data structure.

Parameters:

offsetOrIndex - The index of the item within the dataset.

Returns:

integer difference between two offsets.

compareTo

public int compareTo(BaseEntity other)

Compares entities based on their Index properties.

Parameters:

other - The entity to be compared against.

Returns:

The position of one entity over the other.

readIntegerArray

protected static int[] readIntegerArray(BinaryReader reader,
                                        int count)

Reads an integer array where the first integer is the number of following integers.

Parameters:

reader - Reader set to the position at the start of the list

count - The number of integers to read to form the array

Returns:

An array of integers.

readIntegerList

protected static List<Integer> readIntegerList(BinaryReader reader,
                                               int count)

Reads an integer list where the first integer is the number of following integers.

Parameters:

reader - Reader set to the position at the start of the list

count - The number of integers to read to form the array

Returns:

A List of integers.

getNumber

public static int getNumber(byte[] array,
                            int start,
                            int length)

Returns an integer representation of the characters between start and end. Assumes that all the characters are numeric characters.

Parameters:

array - Array of characters with numeric characters present between start and end.

start - The first character to use to convert to a number.

length - The number of characters to use in the conversion.

Returns:

integer representation of the characters between start and end.

getDataSet

protected Dataset getDataSet()

Returns:

DataSet used to create this base entity.

getIndex

public int getIndex()

Returns:

Index of this base entity.