fiftyone.mobile.detection.factories

Class StreamFactory

java.lang.Object

fiftyone.mobile.detection.factories.StreamFactory

public final class StreamFactory
extends Object

Factory class used to create a DetectorDataSet from a source data structure.

All the entities are held in the persistent store and only loads into memory when required. A cache mechanism is used to improve efficiency as many entities are frequently used in a high volume environment.

The data set will be initialised very quickly as only the header information is loaded. Entities are then created when requested by the detection process and stored in a cache to avoid being recreated if their requested again after a short period of time.

The very small data structures RootNodes, Properties and Components are always stored in memory as there is no benefit retrieving them every time they're needed.

A dataset can be created in several ways:

• Using a data file:

  Dataset ds = StreamFactory.create("path_to_file", false);

  Where the boolean flag indicates if the data file should or should not be deleted when close() is invoked.

• Using a byte array:

  Dataset ds = StreamFactory.create(dataFileAsByteArray);

  Where the byte array is the 51Degrees device data file read into a byte array.

Constructor Summary

Constructors

Constructor and Description
StreamFactory()

Method Summary

Modifier and Type	Method and Description
static Dataset	create(byte[] data) Constructor creates a new dataset from the supplied bytes array.
static Dataset	create(String filePath, boolean isTempFile) Creates a new DataSet from the file provided.
static Dataset	create(String filepath, Date lastModified, boolean isTempFile) Constructor creates a new dataset from the supplied data file.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamFactory

public StreamFactory()

Method Detail

create

public static Dataset create(byte[] data)
                      throws IOException

Constructor creates a new dataset from the supplied bytes array.

Parameters:

data - a byte array containing the data file.

Returns:

Stream Dataset object.

Throws:

IOException - if there was a problem accessing data file.

create

public static Dataset create(String filePath,
                             boolean isTempFile)
                      throws IOException

Creates a new DataSet from the file provided. The last modified date of the data set is the last write time of the data file provided.

Parameters:

filePath - Uncompressed file containing the data for the data set.

isTempFile - True if the file should be deleted when the source is disposed

Returns:

A DataSet configured to read entities from the file path when required.

Throws:

IOException - if there was a problem accessing data file.

create

public static Dataset create(String filepath,
                             Date lastModified,
                             boolean isTempFile)
                      throws IOException

Constructor creates a new dataset from the supplied data file.

Parameters:

filepath - name of the file (with path to file) to load data from.

lastModified - Date and time the source data was last modified.

isTempFile - True if the file should be deleted when the source is disposed.

Returns:

Stream Dataset object.

Throws:

IOException - if there was a problem accessing data file.