fiftyone.mobile.detection.entities

Class Property

java.lang.Object

fiftyone.mobile.detection.entities.BaseEntity

fiftyone.mobile.detection.entities.Property

All Implemented Interfaces:

Comparable<Property>

public class Property
extends BaseEntity
implements Comparable<Property>

Encapsulates all the information about a property including how it's values should be used and what they mean.

Some properties are not mandatory and may not always contain values. For example: information concerning features of a television may not be applicable to a mobile phone. The isMandatory data member should be checked before assuming a value will be returned.

Properties can return none, one or many values. The isList data member should be referred to to determine the number of values to expect. Properties where IsList is false will only return up to one value.

The property also provides metadata about the intended use of the property. The description can be used by UI developers to provide more information about the intended use of the property and it's values. The getCategory() method can be used to group together related properties in configuration UIs.

The Value results are returned as a set of Values that provide various utility methods.

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Property.PropertyValueType Enumeration of strongly typed property values which could be returned.

Field Summary

Fields

Modifier and Type	Field and Description
byte	displayOrder The order in which the property should appear in relation to others with a position value set when used to create a display string for the profile it is contained within.
boolean	isList True if the property might have more than one value.
boolean	isMandatory True if the property must contain values.
boolean	isObsolete True if the property is marked as obsolete and will be removed from a future version of the data set.
boolean	show True if the property is relevant to be shown in a configuration user interface where the property may appear in a list of options.
boolean	showValues True if the values the property returns are relevant to configuration user interfaces and are suitable to be selected from a list of table of options.
Property.PropertyValueType	valueType The strongly type data type the property returns.

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

dataSet, index

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	compareTo(Property other) Compares this property to another using the index field if they're in the same list, otherwise the name field.
String	getCategory() The category the property relates to within the data set.
Component	getComponent() The component the property relates to.
Value	getDefaultValue() The value the property returns if a strongly type value is not available.
String	getDescription() A description of the property suitable to be displayed to end users via a user interface.
String	getJavaScriptName() The name of the property to use when adding to Javascript as a property name.
int	getLastIndexValue()
String[]	getMaps()
String	getName() The name of the property.
URL	getUrl() A URL to more information about the property.
Values	getValues() An array of values the property has available.
void	init() Initialises the often used lists and references if storing of object references is enabled.
String	toString() A string representation of the property.

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

isList

public final boolean isList

True if the property might have more than one value.

isMandatory

public final boolean isMandatory

True if the property must contain values.

showValues

public final boolean showValues

True if the values the property returns are relevant to configuration user interfaces and are suitable to be selected from a list of table of options.

show

public final boolean show

True if the property is relevant to be shown in a configuration user interface where the property may appear in a list of options.

isObsolete

public final boolean isObsolete

True if the property is marked as obsolete and will be removed from a future version of the data set.

displayOrder

public final byte displayOrder

The order in which the property should appear in relation to others with a position value set when used to create a display string for the profile it is contained within.

valueType

public final Property.PropertyValueType valueType

The strongly type data type the property returns.

Constructor Detail

Property

public Property(Dataset dataSet,
                int index,
                BinaryReader reader)
         throws IOException

Constructs a new instance of Property

Parameters:

dataSet - Dataset to construct from.

index - property index.

reader - BinaryReader to be used.

Throws:

IOException - if there was a problem accessing data file.

Method Detail

getMaps

public String[] getMaps()
                 throws IOException

Returns:

an array of maps associated with the property.

Throws:

IOException - if there was a problem accessing data file.

getJavaScriptName

public String getJavaScriptName()
                         throws IOException

The name of the property to use when adding to Javascript as a property name. Unacceptable characters such as '/' are removed.

Returns:

the name of the property when used in Javascript.

Throws:

IOException - if there was a problem accessing data file.

getName

public String getName()
               throws IOException

The name of the property.

Returns:

name of the property.

Throws:

IOException - if there was a problem accessing data file.

getDefaultValue

public Value getDefaultValue()
                      throws IOException

The value the property returns if a strongly type value is not available.

Returns:

Value the property returns if a strongly type value is not available.

Throws:

IOException - if there was a problem accessing data file.

getComponent

public Component getComponent()
                       throws IOException

The component the property relates to.

Returns:

{A@link Component} the property relates to.

Throws:

IOException - if there was a problem accessing data file.

getValues

public Values getValues()
                 throws IOException

An array of values the property has available.

Returns:

array of values the property has available.

Throws:

IOException - if there was a problem accessing data file.

getDescription

public String getDescription()
                      throws IOException

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

Returns:

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

Throws:

IOException - if there was a problem accessing data file.

getCategory

public String getCategory()
                   throws IOException

The category the property relates to within the data set. A category is not the same as the component.

Returns:

name of category the property relates to within the data set.

Throws:

IOException - if there was a problem accessing data file.

getUrl

public URL getUrl()
           throws IOException

A URL to more information about the property.

Returns:

URL to more information about the property.

Throws:

IOException - if there was a problem accessing data file.

getLastIndexValue

public int getLastIndexValue()

Returns:

The index of the last value related to the property.

init

public void init()
          throws IOException

Initialises the often used lists and references if storing of object references is enabled.

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(Property other)

Compares this property to another using the index field if they're in the same list, otherwise the name field.

Specified by:

compareTo in interface Comparable<Property>

Parameters:

other - Property to be compared against.

Returns:

Indication of relative value.

toString

public String toString()

A string representation of the property.

Overrides:

toString in class Object

Returns:

the property name as a string.