fiftyone.mobile.detection.entities

Class Value

java.lang.Object

fiftyone.mobile.detection.entities.BaseEntity

fiftyone.mobile.detection.entities.Value

public class Value
extends BaseEntity

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

Every Property can return one of many values, or multiple values if it's a list property. For example: SupportedBearers returns a list of the bearers that the device can support.

Class contains metadata related to this value including the display name, description and URL to find out additional information. Metadata can be used by UI developers to provide users with more information about the meaning and intended use of this value. Access metadata like: value.getDescription(); and value.getUrl();.

Objects of this class should not be created directly as they are part of the internal logic. Use the relevant Dataset method to access these objects.

For more information see: 51Degrees pattern data model.

Field Summary

Fields

Modifier and Type	Field and Description
static int	RECORD_LENGTH The length in bytes of the value record in the data file.

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

dataSet, index

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(String value) Compares two values by name.
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.
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()
int	toInt() Returns the value as an integer.
String	toString() Returns the value as a string.

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

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

Constructor Detail

Value

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

Constructs a new instance of Value.

Parameters:

dataSet - the Dataset 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 as string.

Throws:

IOException - if there was a problem accessing data file.

getSignatures

public Signature[] getSignatures()
                          throws IOException

Returns:

array containing the signatures that the value is associated with.

Throws:

IOException - if there was a problem accessing data file.

getProfiles

public Profile[] getProfiles()
                      throws IOException

Returns:

Array containing the profiles this value is associated with.

Throws:

IOException - if there was a problem accessing data file.

getProperty

public Property getProperty()
                     throws IOException

Returns:

The Property the value relates to.

Throws:

IOException - if there was a problem accessing data file.

getComponent

public Component getComponent()
                       throws IOException

Returns:

The Component the value relates to.

Throws:

IOException - if there was a problem accessing data file.

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 - if there was a problem accessing data file.

getUrl

public URL getUrl()
           throws IOException

Returns:

A URL to more information about the value if present.

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

This method should not be called as it is part of the internal logic.

Throws:

IOException - if there was a problem accessing data file.

compareTo

public int compareTo(String value)

Compares two values by name.

Parameters:

value - name of value to compare the current value against.

Returns:

integer representing difference.

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.

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 - if there was a problem accessing data file.

toBool

public boolean toBool()
               throws IOException

Returns:

Returns the value as a boolean.

Throws:

IOException - if there was a problem accessing data file.

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:

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

Throws:

IOException - if there was a problem accessing data file.

toInt

public int toInt()
          throws IOException

Returns the value as an integer.

Returns:

If the value can not convert to an integer and the value is not equal to the null value then the null value for the property will be used. If no conversion is possible 0 is returned.

Throws:

IOException - if there was a problem accessing data file.