fiftyone.mobile.detection.entities

Class Values

java.lang.Object

fiftyone.mobile.detection.entities.Values

public class Values
extends Object

Encapsulates a list of one or more values. Provides methods to return boolean, double and string representations of the values list. Also contains helper methods to make consuming the data set easier.

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.

Constructor Summary

Constructors

Constructor and Description
Values(Property property, Value[] values) Constructs a new instance of the values list.

Method Summary

Modifier and Type	Method and Description
boolean	contains(Value item) Checks if a value is present in this list.
void	copyTo(Value[] array, int arrayIndex) Makes a copy of the current array of values to the provided array.
int	count()
Value	get(int index) Gets the element at index.
Value	get(String valueName) Returns the value by name.
Value[]	getAll()
boolean	getIsDefault() Returns true if any of the values are the null values for the property.
boolean	toBool() The value represented as a boolean.
double	toDouble() The value represented as a double.
String	toString() The values represented as a string where multiple values are separated by colons.
String[]	toStringArray() Returns the values as a string array.

Methods inherited from class java.lang.Object

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

Constructor Detail

Values

public Values(Property property,
              Value[] values)

Constructs a new instance of the values list.

Parameters:

property - Property the values list relates to

values - IEnumerable of values to use to initialise the list

Method Detail

toBool

public boolean toBool()
               throws IOException

The value represented as a boolean. MobileException Thrown if the method is called for a property with multiple values.

Returns:

return a boolean representation of the only item in the list.

Throws:

IOException - if there was a problem accessing data file.

toDouble

public double toDouble()
                throws IOException

The value represented as a double. Unsupported operation exception is thrown if value is a list.

Returns:

A double representation of the only item in the list.

Throws:

IOException - if there was a problem accessing data file.

toStringArray

public String[] toStringArray()
                       throws IOException

Returns the values as a string array.

Returns:

a string array of Value objects.

Throws:

IOException - if there was a problem accessing data file.

toString

public String toString()

The values represented as a string where multiple values are separated by colons.

Overrides:

toString in class Object

Returns:

the Value object names separated by colons as a string.

getIsDefault

public boolean getIsDefault()
                     throws IOException

Returns true if any of the values are the null values for the property.

Returns:

true if any of the values are the null values for the property.

Throws:

IOException - if there was a problem accessing data file.

getAll

public Value[] getAll()

Returns:

entire array of Value objects.

get

public Value get(String valueName)
          throws IOException

Returns the value by name.

Parameters:

valueName - name of the Value required.

Returns:

the value associated with the name provided, null if one does not exist.

Throws:

IOException - if there was a problem accessing data file.

get

public Value get(int index)

Gets the element at index.

Parameters:

index - of the element in the array.

Returns:

Value at provided index, or null if out of bounds.

contains

public boolean contains(Value item)

Checks if a value is present in this list.

Parameters:

item - Value to check for.

Returns:

true if provided value exists, false otherwise.

copyTo

public void copyTo(Value[] array,
                   int arrayIndex)

Makes a copy of the current array of values to the provided array.

Parameters:

array - of Value objects.

arrayIndex - copy from.

count

public int count()

Returns:

number of items in the backing array of Value objects.