fiftyone.mobile.detection.entities

Class Value

java.lang.Object

fiftyone.mobile.detection.entities.BaseEntity

fiftyone.mobile.detection.entities.Value

All Implemented Interfaces:

Comparable<Value>

public class Value
extends BaseEntity
implements Comparable<Value>

A value associated with a property and component within the dataset.

Field Summary

Fields

Modifier and Type	Field and Description
private Boolean	asBool
private Double	asNumber
private String	description
private int	descriptionIndex
private String	name
private int	nameIndex
private Profile[]	profiles
private Property	property
(package private) int	propertyIndex
static int	RECORD_LENGTH The length in bytes of the value record in the data file.
private Signature[]	signatures
private URL	url
private int	urlIndex

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	compareTo(Value other) Compares this value to another using the index field if they're in the same list other wise the name value.
private Profile[]	doGetProfiles() Gets all the profiles associated with the value.
private Signature[]	doGetSignatures() Gets all the signatures associated with the value.
Component	getComponent()
String	getDescription()
boolean	getIsDefault() Returns true if the value is the null value for the property.
String	getName()
Profile[]	getProfiles()
Property	getProperty()
Signature[]	getSignatures()
URL	getUrl()
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.
boolean	toBool()
double	toDouble()
String	toString() Returns the value as a string.

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

binarySearch, getDataSet, getIndex, readIntegerArray

Methods inherited from class java.lang.Object

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

Field Detail

RECORD_LENGTH

public static final int RECORD_LENGTH

The length in bytes of the value record in the data file.

See Also:

Constant Field Values

name

private String name

nameIndex

private final int nameIndex

signatures

private Signature[] signatures

profiles

private Profile[] profiles

property

private Property property

propertyIndex

final int propertyIndex

description

private String description

descriptionIndex

private final int descriptionIndex

url

private URL url

urlIndex

private final int urlIndex

asNumber

private Double asNumber

asBool

private Boolean asBool

Constructor Detail

Value

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

Constructs a new instance of Value

Parameters:

dataSet - The data set the value is contained within

index - The index in the data structure to the value

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

Method Detail

getName

public String getName()
               throws IOException

Returns:

The name of the value.

Throws:

IOException

getSignatures

public Signature[] getSignatures()
                          throws IOException

Returns:

Array containing the signatures that the value is associated with.

Throws:

IOException

getProfiles

public Profile[] getProfiles()
                      throws IOException

Returns:

Array containing the profiles the value is associated with.

Throws:

IOException

getProperty

public Property getProperty()
                     throws IOException

Returns:

The property the value relates to.

Throws:

IOException

getComponent

public Component getComponent()
                       throws IOException

Returns:

The component the value relates to.

Throws:

IOException

getDescription

public String getDescription()
                      throws IOException

Returns:

A description of the value suitable to be displayed to end users via a user interface.

Throws:

IOException

getUrl

public URL getUrl()
           throws IOException

Returns:

A URL to more information about the value if present.

Throws:

IOException

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. The Profiles and Signatures are not initialised as they are very rarely used and take a long time to initialise.

Throws:

IOException

doGetProfiles

private Profile[] doGetProfiles()
                         throws IOException

Gets all the profiles associated with the value.

Returns:

Returns the profiles from the component that relate to this value

Throws:

IOException

doGetSignatures

private Signature[] doGetSignatures()
                             throws IOException

Gets all the signatures associated with the value.

Returns:

Returns the signatures associated with the value

Throws:

IOException

compareTo

public int compareTo(Value other)

Compares this value to another using the index field if they're in the same list other wise the name value.

Specified by:

compareTo in interface Comparable<Value>

Parameters:

other - The value to be compared against

Returns:

Indication of relative value based on index field

toString

public String toString()

Returns the value as a string.

Overrides:

toString in class Object

Returns:

the value name as a string

toDouble

public double toDouble()
                throws IOException

Returns:

Returns the value as a number.

Throws:

IOException

toBool

public boolean toBool()
               throws IOException

Returns:

Returns the value as a boolean.

Throws:

IOException

getIsDefault

public boolean getIsDefault()
                     throws IOException

Returns true if the value is the null value for the property. If the property has no null value false is always returned.

Returns:

Throws:

IOException