fiftyone.mobile.detection.entities.Value Maven / Gradle / Ivy
Show all versions of 51Degrees.detection.core Show documentation
package fiftyone.mobile.detection.entities;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.List;
import java.lang.Integer;
import fiftyone.mobile.detection.Dataset;
import fiftyone.mobile.detection.readers.BinaryReader;
import java.util.logging.Level;
import java.util.logging.Logger;
/* *********************************************************************
* This Source Code Form is copyright of 51Degrees Mobile Experts Limited.
* Copyright 2014 51Degrees Mobile Experts Limited, 5 Charlotte Close,
* Caversham, Reading, Berkshire, United Kingdom RG4 7BY
*
* This Source Code Form is the subject of the following patent
* applications, owned by 51Degrees Mobile Experts Limited of 5 Charlotte
* Close, Caversham, Reading, Berkshire, United Kingdom RG4 7BY:
* European Patent Application No. 13192291.6; and
* United States Patent Application Nos. 14/085,223 and 14/085,301.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0.
*
* If a copy of the MPL was not distributed with this file, You can obtain
* one at http://mozilla.org/MPL/2.0/.
*
* This Source Code Form is "Incompatible With Secondary Licenses", as
* defined by the Mozilla Public License, v. 2.0.
* ********************************************************************* */
/**
* 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.
The value class contains all the information
* associated with the value including the display name, and also other
* information such as a description or URL to find out additional information.
* These other properties can be used by UI developers to provide users with
* more information about the meaning and intended use of a value.
For more
* information see http://51degrees.com/Support/Documentation/Java
*/
/**
* A value associated with a property and component within the dataset.
*/
public class Value extends BaseEntity implements Comparable {
/**
* The value as an integer. Integer instead of int because of the nullable
* requirement.
*/
private Integer asInt;
/**
* The length in bytes of the value record in the data file.
*/
public static final int RECORD_LENGTH = (4 * 3) + 2;
/**
* @return The name of the value.
* @throws IOException indicates an I/O exception occurred
*/
public String getName() throws IOException {
if (name == null) {
synchronized (this) {
if (name == null) {
name = getDataSet().strings.get(nameIndex).toString();
}
}
}
return name;
}
private String name;
private final int nameIndex;
/**
* @return Array containing the signatures that the value is associated with.
* @throws IOException indicates an I/O exception occurred
*/
public Signature[] getSignatures() throws IOException {
if (signatures == null) {
synchronized (this) {
if (signatures == null) {
signatures = doGetSignatures();
}
}
}
return signatures;
}
private Signature[] signatures;
/**
* @return Array containing the profiles the value is associated with.
* @throws IOException indicates an I/O exception occurred
*/
public Profile[] getProfiles() throws IOException {
if (profiles == null) {
synchronized (this) {
if (profiles == null) {
profiles = doGetProfiles();
}
}
}
return profiles;
}
private Profile[] profiles;
/**
* @return The property the value relates to.
* @throws IOException indicates an I/O exception occurred
*/
public Property getProperty() throws IOException {
if (property == null) {
synchronized (this) {
if (property == null) {
property = getDataSet().getProperties().get(propertyIndex);
}
}
}
return property;
}
private Property property;
final int propertyIndex;
/**
* @return The component the value relates to.
* @throws IOException indicates an I/O exception occurred
*/
public Component getComponent() throws IOException {
return getProperty().getComponent();
}
/**
* @return A description of the value suitable to be displayed to end users
* via a user interface.
* @throws IOException indicates an I/O exception occurred
*/
public String getDescription() throws IOException {
if (descriptionIndex >= 0 && description == null) {
synchronized (this) {
if (description == null) {
description = getDataSet().strings
.get(descriptionIndex).toString();
}
}
}
return description;
}
private String description;
private final int descriptionIndex;
/**
* @return A URL to more information about the value if present.
* @throws IOException indicates an I/O exception occurred
*/
public URL getUrl() throws IOException {
if (urlIndex >= 0 && url == null) {
synchronized (this) {
if (url == null) {
url = new URL(getDataSet().strings.get(urlIndex)
.toString());
}
}
}
return url;
}
private URL url;
private final int urlIndex;
/**
* Constructs a new instance of Value
*
* @param dataSet The data set the value is contained within
* @param index The index in the data structure to the value
* @param reader Reader connected to the source data structure and
* positioned to start reading
*/
public Value(Dataset dataSet, int index, BinaryReader reader) {
super(dataSet, index);
this.propertyIndex = reader.readInt16();
this.nameIndex = reader.readInt32();
this.descriptionIndex = reader.readInt32();
this.urlIndex = reader.readInt32();
}
/**
* 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 indicates an I/O exception occurred
*/
public void init() throws IOException {
name = getDataSet().strings.get(nameIndex).toString();
property = getDataSet().getProperties().get(propertyIndex);
if (descriptionIndex >= 0) {
description = getDataSet().strings.get(descriptionIndex)
.toString();
}
if (urlIndex >= 0) {
try {
url = new URL(getDataSet().strings.get(urlIndex)
.toString());
} catch (MalformedURLException e) {
url = null;
}
}
}
/**
* Gets all the profiles associated with the value.
*
* @return Returns the profiles from the component that relate to this value
* @throws IOException
*/
private Profile[] doGetProfiles() throws IOException {
List list = new ArrayList();
for (Profile profile : getComponent().getProfiles()) {
if (binarySearch(profile.getValues(), getIndex()) >= 0) {
list.add(profile);
}
}
return list.toArray(new Profile[list.size()]);
}
/**
* Gets all the signatures associated with the value.
*
* @return Returns the signatures associated with the value
* @throws IOException
*/
private Signature[] doGetSignatures() throws IOException {
// Get a distinct list of signature indexes.
List list = new ArrayList();
for (Profile profile : getProfiles()) {
for (Integer signatureIndex : profile.getSignatureIndexes()) {
int index = java.util.Collections.binarySearch(list, signatureIndex);
if (index < 0) {
list.add(~index, signatureIndex);
}
}
}
// Turn that list into an array of signatures.
Signature[] result = new Signature[list.size()];
for (int i = 0; i < result.length; i++) {
result[i] = getDataSet().getSignatures().get(list.get(i));
}
return result;
}
/**
* Compares this value to another using the index field if they're in the
* same list other wise the name value.
*
* @param other The value to be compared against
* @return Indication of relative value based on index field
*/
@Override
public int compareTo(Value other) {
if (getDataSet() == other.getDataSet()) {
return getIndex() - other.getIndex();
}
try {
return getName().compareTo(other.getName());
} catch (IOException e) {
return 0;
}
}
/**
* Returns the value as a string.
*
* @return the value name as a string
*/
@Override
public String toString() {
try {
return getName();
} catch (IOException e) {
return super.toString();
}
}
/**
* @return Returns the value as a number.
* @throws IOException indicates an I/O exception occurred
*/
public double toDouble() throws IOException {
if (asNumber == null) {
synchronized (this) {
if (asNumber == null) {
try {
asNumber = Double.parseDouble(getName());
} catch (NumberFormatException e) {
if (this != getProperty().getDefaultValue()) {
asNumber = getProperty().getDefaultValue().toDouble();
} else {
asNumber = (double) 0;
}
}
}
}
}
return (double) asNumber;
}
private Double asNumber;
/**
* @return Returns the value as a boolean.
* @throws IOException indicates an I/O exception occurred
*/
public boolean toBool() throws IOException {
if (asBool == null) {
synchronized (this) {
if (asBool == null) {
asBool = Boolean.parseBoolean(getName());
}
}
}
return (boolean) asBool;
}
private Boolean asBool;
/**
* Returns true if the value is the null value for the property. If the
* property has no null value false is always returned.
*
* @return true if the value is the null value for the property. If the
* property has no null value false is always returned.
* @throws IOException indicates an I/O exception occurred
*/
public boolean getIsDefault() throws IOException {
Value defaultValue = property.getDefaultValue();
if (defaultValue != null) {
return this.getName().equals(defaultValue.getName());
}
return false;
}
/**
* Returns the value as an integer.
* @return 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.
*/
public int toInt() {
if (asInt == null) {
synchronized (asInt) {
if (asInt == null) {
Double d;
try {
d = toDouble();
asInt = d.intValue();
} catch (IOException ex) {
Logger.getLogger(Value.class.getName()).log(Level.SEVERE, null, ex);
}
}
}
}
return asInt;
}
}