Dataset (51Degrees :: Device Detection :: Core 3.2.2.20-beta API)

java.lang.Object
- fiftyone.mobile.detection.Dataset

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

Dataset
```
public class Dataset
extends Object
implements Closeable
```
Data set used for device detection and provide methods to work with device data.
Dataset should not be constructed directly, instead use either StreamFactory or MemoryFactory. Stream factory returns a Stream Dataset which extends the this class and contains data members and methods to access the data file on the "as needed" basis.
All information about the detector data set is exposed in this class including meta data and data used for device detection in the form of lists.
When you create a data set remember to close() it to release resources and file locks.
For more information see https://51degrees.com/Support/Documentation/Java

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`age` Age of the data in months when exported.
`MemoryFixedList<Component>`	`components` A list of all the components the data set contains.
`String`	`copyright` The copyright notice associated with the data set.
`int`	`copyrightOffset` The offset for the copyright notice associated with the data set.
`int`	`csvBufferLength` The number of bytes to allocate to a buffer returning CSV format data for a match.
`int`	`deviceCombinations` The number of unique device combinations available in the data set.
`Guid`	`export` A unique Tag for the exported data.
`String`	`format` The name of the property map used to create the dataset.
`int`	`formatOffset` The offset for the name of the property map used to create the dataset.
`byte`	`highestCharacter` The highest character the character trees can contain.
`int`	`jsonBufferLength` The number of bytes to allocate to a buffer returning JSON format data for a match.
`Calendar`	`lastModified` When the data was last modified.
`byte`	`lowestCharacter` The lowest character the character trees can contain.
`MemoryFixedList<Map>`	`maps` A list of all the maps the data set contains.
`int`	`maximumRank` The largest rank value that can be returned.
`int`	`maxSignatures` The maximum number of signatures that can be checked.
`int`	`maxSignaturesClosest` The maximum number of signatures that could possibly be returned during a closest match.
`short`	`maxUserAgentLength` The maximum length of a User-Agent string.
`short`	`maxValues` The maximum number of values that can be returned by a profile and a property supporting a list of values.
`int`	`minUserAgentCount` The minimum number of times a User-Agent should have been seen before it was included in the dataset.
`short`	`minUserAgentLength` The minimum length of a User-Agent string.
`Modes`	`mode` The mode of operation the data set is using.
`int`	`nameOffset` The offset for the common name of the data set.
`Date`	`nextUpdate` The date the data set is next expected to be updated by 51Degrees.
`IFixedList<IntegerEntity>`	`nodeRankedSignatureIndexes` List of integers that represent ranked signature indexes.
`IReadonlyList<Node>`	`nodes` List of nodes the data set contains.
`IReadonlyList<ProfileOffset>`	`profileOffsets` List of profile offsets the data set contains.
`IReadonlyList<Profile>`	`profiles` A list of all the possible profiles the data set contains.
`PropertiesList`	`properties` A list of all properties the data set contains.
`Date`	`published` The date the data set was published.
`IFixedList<IntegerEntity>`	`rankedSignatureIndexes` A list of signature indexes ordered in ascending order of rank.
`IReadonlyList<Node>`	`rootNodes` Nodes for each of the possible character positions in the User-Agent.
`IFixedList<IntegerEntity>`	`signatureNodeOffsets` List of integers that represent signature node offsets.
`int`	`signatureNodesCount` The number of nodes each signature can contain.
`int`	`signatureProfilesCount` The number of profiles each signature can contain.
`IReadonlyList<Signature>`	`signatures` A list of all the signatures the data set contains.
`IReadonlyList<AsciiString>`	`strings` A list of ASCII byte arrays for strings used by the dataset.
`Guid`	`tag` A unique Tag for the data set.
`IReadonlyList<Value>`	`values` A list of all property values the data set contains.
`Version`	`version` The version of the data set.
`DetectionConstants.FORMAT_VERSIONS`	`versionEnum` The version of the data set as an Enumeration.
`int`	`xmlBufferLength` The number of bytes to allocate to a buffer returning XML format data for a match.

Constructor Summary

Constructors
Constructor and Description

Dataset(Date lastModified, Modes mode)
Constructs a new data set ready to have lists of data assigned to it.

Constructors
Constructor and Description
`Dataset(Date lastModified, Modes mode)` Constructs a new data set ready to have lists of data assigned to it.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`close()` Disposes of the data set releasing any file locks.
`Profile`	`findProfile(int profileId)` Searches the list of profile IDs and returns the profile if the profile id is valid.
`Property`	`get(String propertyName)` Method searches for a property with the given name and returns one if found.
`long`	`getAge()` Returns time that has elapsed since the data in the data set was current.
`Component`	`getBrowsers()` Returns the browser `Component` that contains a set of `properties` and `profiles` related to browsers.
`Component`	`getComponent(String componentName)` Retrieves `Component` by name if a component with such name exists.
`IReadonlyList<Component>`	`getComponents()` Returns an iterable of all `Components` in the current data file.
`String`	`getCopyright()` The copyright notice associated with the data file.
`Component`	`getCrawlers()` Returns the crawler `Component` that contains a set of `properties` and `profiles` related to crawlers (such as: IsCrawler property).
`boolean`	`getDisposed()` Indicates if the data set has been disposed.
`String`	`getFormat()` Major version of the data file backing the this data set.
`Component`	`getHardware()` Returns the hardware `Component` that contains a set of `properties` and `profiles` related to hardware (such as: IsCrawler property).
`String[]`	`getHttpHeaders()` Creates a list of HTTP headers if one does not already exist.
`IReadonlyList<Map>`	`getMaps()` Returns an iterable list of maps contained within the data file.
`int`	`getMaximumRank()` The largest rank value that can be returned.
`short`	`getMinUserAgentLength()` The minimum length of a User-Agent string.
`String`	`getName()` The common name of the data set such as 'Lite', 'Premium' and 'Enterprise'.
`long`	`getNodeCacheSwitches()` Deprecated.
`IFixedList<IntegerEntity>`	`getNodeRankedSignatureIndexes()` Returns a list of integers that represent ranked signature indexes.
`IReadonlyList<Node>`	`getNodes()` List of nodes the data set contains.
`int`	`getNodesCount()` Returns the number of nodes each signature can contain.
`double`	`getPercentageNodeCacheMisses()` The percentage of requests for nodes which were not already contained in the cache.
`double`	`getPercentageProfilesCacheMisses()` The percentage of requests for profiles which were not already contained in the cache.
`double`	`getPercentageRankedSignatureCacheMisses()` Deprecated.
`double`	`getPercentageSignatureCacheMisses()` The percentage of requests for signatures which were not already contained in the cache.
`double`	`getPercentageStringsCacheMisses()` The percentage of requests for strings which were not already contained in the cache.
`double`	`getPercentageValuesCacheMisses()` The percentage of requests for values which were not already contained in the cache.
`IReadonlyList<Profile>`	`getProfiles()` A list of all the possible `profiles` contained in the current data set.
`long`	`getProfilesCacheSwitches()` Deprecated.
`int`	`getProfilesCount()` Returns the number of `profiles` each signature can contain.
`IReadonlyList<Property>`	`getProperties()` A list of all `properties` the data set contains.
`Property`	`getPropertyByName(String propertyName)` Deprecated.
`long`	`getRankedSignatureCacheSwitches()` Deprecated.
`IFixedList<IntegerEntity>`	`getRankedSignatureIndexes()` Returns a list of signature indexes ordered in ascending order of rank.
`long`	`getSignatureCacheSwitches()` Deprecated.
`IFixedList<IntegerEntity>`	`getSignatureNodeOffsets()` Returns a list of integers that represent signature node offsets.
`IReadonlyList<Signature>`	`getSignatures()` List of `signatures` the data set contains.
`Component`	`getSoftware()` Returns the software `Component` that contains a set of `properties` and `profiles` related to software.
`long`	`getStringsCacheSwitches()` Deprecated.
`IReadonlyList<Value>`	`getValues()` A list of all `values` the data set contains.
`long`	`getValuesCacheSwitches()` Deprecated.
`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.
`void`	`initComponents()` Preloads components to speed retrieval later at the expense of memory.
`void`	`initNodes()` Preloads nodes to speed retrieval later at the expense of memory.
`void`	`initProfiles()` Preloads profiles to speed retrieval later at the expense of memory.
`void`	`initProperties()` Preloads properties to speed retrieval later at the expense of memory.
`void`	`initSignatures()` Preloads signatures to speed retrieval later at the expense of memory.
`void`	`initValues()` Preloads values to speed retrieval later at the expense of memory.
`void`	`resetCache()` If there are cached lists being used the states are reset for them.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - age
```
public int age
```
    Age of the data in months when exported.
  - components
```
public MemoryFixedList<Component> components
```
    A list of all the components the data set contains.
  - copyright
```
public volatile String copyright
```
    The copyright notice associated with the data set.
  - copyrightOffset
```
public int copyrightOffset
```
    The offset for the copyright notice associated with the data set.
  - csvBufferLength
```
public int csvBufferLength
```
    The number of bytes to allocate to a buffer returning CSV format data for a match.
  - deviceCombinations
```
public int deviceCombinations
```
    The number of unique device combinations available in the data set.
  - export
```
public Guid export
```
    A unique Tag for the exported data.
  - format
```
public volatile String format
```
    The name of the property map used to create the dataset.
  - formatOffset
```
public int formatOffset
```
    The offset for the name of the property map used to create the dataset.
  - highestCharacter
```
public byte highestCharacter
```
    The highest character the character trees can contain.
  - jsonBufferLength
```
public int jsonBufferLength
```
    The number of bytes to allocate to a buffer returning JSON format data for a match.
  - lastModified
```
public Calendar lastModified
```
    When the data was last modified.
  - lowestCharacter
```
public byte lowestCharacter
```
    The lowest character the character trees can contain.
  - maps
```
public MemoryFixedList<Map> maps
```
    A list of all the maps the data set contains.
  - maxSignatures
```
public int maxSignatures
```
    The maximum number of signatures that can be checked. Needed to avoid bogus User-Agents which deliberately require so many signatures to be checked that performance is degraded.
  - maxSignaturesClosest
```
public int maxSignaturesClosest
```
    The maximum number of signatures that could possibly be returned during a closest match.
  - maxUserAgentLength
```
public short maxUserAgentLength
```
    The maximum length of a User-Agent string.
  - maxValues
```
public short maxValues
```
    The maximum number of values that can be returned by a profile and a property supporting a list of values.
  - maximumRank
```
public volatile int maximumRank
```
    The largest rank value that can be returned.
  - minUserAgentCount
```
public int minUserAgentCount
```
    The minimum number of times a User-Agent should have been seen before it was included in the dataset.
  - minUserAgentLength
```
public short minUserAgentLength
```
    The minimum length of a User-Agent string.
  - mode
```
public final Modes mode
```
    The mode of operation the data set is using.
  - nameOffset
```
public int nameOffset
```
    The offset for the common name of the data set.
  - nextUpdate
```
public Date nextUpdate
```
    The date the data set is next expected to be updated by 51Degrees.
  - nodes
```
public IReadonlyList<Node> nodes
```
    List of nodes the data set contains.
  - nodeRankedSignatureIndexes
```
public IFixedList<IntegerEntity> nodeRankedSignatureIndexes
```
    List of integers that represent ranked signature indexes.
  - profiles
```
public IReadonlyList<Profile> profiles
```
    A list of all the possible profiles the data set contains.
  - profileOffsets
```
public IReadonlyList<ProfileOffset> profileOffsets
```
    List of profile offsets the data set contains.
  - properties
```
public PropertiesList properties
```
    A list of all properties the data set contains.
  - published
```
public Date published
```
    The date the data set was published.
  - rankedSignatureIndexes
```
public IFixedList<IntegerEntity> rankedSignatureIndexes
```
    A list of signature indexes ordered in ascending order of rank. Used by the node ranked signature indexes lists to identify the corresponding signature.
  - rootNodes
```
public IReadonlyList<Node> rootNodes
```
    Nodes for each of the possible character positions in the User-Agent.
  - signatureNodesCount
```
public int signatureNodesCount
```
    The number of nodes each signature can contain.
  - signatureNodeOffsets
```
public IFixedList<IntegerEntity> signatureNodeOffsets
```
    List of integers that represent signature node offsets.
  - signatureProfilesCount
```
public int signatureProfilesCount
```
    The number of profiles each signature can contain.
  - signatures
```
public IReadonlyList<Signature> signatures
```
    A list of all the signatures the data set contains.
  - strings
```
public IReadonlyList<AsciiString> strings
```
    A list of ASCII byte arrays for strings used by the dataset.
  - tag
```
public Guid tag
```
    A unique Tag for the data set.
  - values
```
public IReadonlyList<Value> values
```
    A list of all property values the data set contains.
  - version
```
public Version version
```
    The version of the data set.
  - versionEnum
```
public DetectionConstants.FORMAT_VERSIONS versionEnum
```
    The version of the data set as an Enumeration.
  - xmlBufferLength
```
public int xmlBufferLength
```
    The number of bytes to allocate to a buffer returning XML format data for a match.
- Constructor Detail
  - Dataset
```
public Dataset(Date lastModified,
               Modes mode)
        throws IOException
```
    Constructs a new data set ready to have lists of data assigned to it.
    
    Parameters:
    
    lastModified - The date and time the source of the data was last modified.
    
    mode - The mode of operation the data set will be using.
    
    Throws:
    
    IOException - signals an I/O exception occurred
- Method Detail
  - getAge
```
public long getAge()
```
    Returns time that has elapsed since the data in the data set was current.
    
    Returns:
    
    time in seconds between now and when data file was published.
  - getPercentageSignatureCacheMisses
```
public double getPercentageSignatureCacheMisses()
```
    The percentage of requests for signatures which were not already contained in the cache. A value is only returned when operating in Stream mode.
    
    Returns:
    
    double representing percentage of requests for signatures not currently in cache, only for Stream Mode.
  - getPercentageNodeCacheMisses
```
public double getPercentageNodeCacheMisses()
```
    The percentage of requests for nodes which were not already contained in the cache. A value is only returned when operating in Stream mode.
    
    Returns:
    
    double representing percentage of requests for nodes not already in cache. Stream Mode only.
  - getPercentageStringsCacheMisses
```
public double getPercentageStringsCacheMisses()
```
    The percentage of requests for strings which were not already contained in the cache. A value is only returned when operating in Stream mode.
    
    Returns:
    
    double representing percentage of requests for strings that were not already in cache.
  - getPercentageProfilesCacheMisses
```
public double getPercentageProfilesCacheMisses()
```
    The percentage of requests for profiles which were not already contained in the cache. A value is only returned when operating in Stream mode.
    
    Returns:
    
    double representing percentage of requests for profiles that were not already in cache.
  - getPercentageValuesCacheMisses
```
public double getPercentageValuesCacheMisses()
```
    The percentage of requests for values which were not already contained in the cache. A value is only returned when operating in Stream mode.
    
    Returns:
    
    double representing percentage of requests for values that were not already in cache.
  - getMaximumRank
```
public int getMaximumRank()
```
    The largest rank value that can be returned. Maximum rank value can be useful when working with signature ranks to calculate the rank percentage and quickly sort.
    
    Returns:
    
    The largest rank value that can be returned.
  - getDisposed
```
public boolean getDisposed()
```
    Indicates if the data set has been disposed.
    
    Returns:
    
    True if dataset has been disposed, False otherwise.
  - getHardware
```
public Component getHardware()
                      throws IOException
```
    Returns the hardware Component that contains a set of properties and profiles related to hardware (such as: IsCrawler property).
    Note that for the 'Lite' data file this component returns only three properties: IsMobile, ScreenPixelsWidth and ScreenPixelsHeight.
    Premium and Enterprise data files contain considerably more data, meaning more accurate detections and access to properties like DeviceType, IsTablet, DeviceRAM, HardwareName, PriceBand, ScreenInchesWidth and more. Compare data options.
    For more information see: 51Degrees Pattern Data Model
    
    Returns:
    
    hardware component for the hardware platform
    
    Throws:
    
    IOException - signals an I/O exception occurred
  - getSoftware
```
public Component getSoftware()
                      throws IOException
```
    Returns the software Component that contains a set of properties and profiles related to software. Software component includes properties like: PlatformName and PlatformVersion.
    Premium and Enterprise data files contain considerably more data, meaning more accurate detections and access to properties like PlatformVendor, CLDC and CcppAccept. Compare data options.
    For more information see: 51Degrees Pattern Data Model
    
    Returns:
    
    software component for the software platform
    
    Throws:
    
    IOException - if there was a problem accessing data file.
  - getBrowsers
```
public Component getBrowsers()
                      throws IOException
```
    Returns the browser Component that contains a set of properties and profiles related to browsers.
    Premium and Enterprise data files contain considerably more data, meaning more accurate detections and access to properties like AjaxRequestType, IsWebApp, HtmlVersion and Javascript. Compare data options.
    For more information see: 51Degrees Pattern Data Model
    
    Returns:
    
    browser Component.
    
    Throws:
    
    IOException - if there was a problem accessing data file.
  - getCrawlers
```
public Component getCrawlers()
                      throws IOException
```
    Returns the crawler Component that contains a set of properties and profiles related to crawlers (such as: IsCrawler property).
    Note that for the 'Lite' data file this component will not return any properties. Some profiles will be returned but no properties associated with this component will be available.
    Premium and Enterprise data files contain considerably more data, meaning more accurate detections and access to the IsCrawler property. Compare data options.
    For more information see: 51Degrees Pattern Data Model
    
    Returns:
    
    crawler component
    
    Throws:
    
    IOException - signals an I/O exception has occurred
  - getCopyright
```
public String getCopyright()
                    throws IOException
```
    The copyright notice associated with the data file.
    
    Returns:
    
    copyright notice for the current data file as a string of text.
    
    Throws:
    
    IOException - if there was a problem accessing data file.
  - getName
```
public String getName()
               throws IOException
```
    The common name of the data set such as 'Lite', 'Premium' and 'Enterprise'.
    
    Returns:
    
    name of the data set as a string.
    
    Throws:
    
    IOException - if there was a problem accessing data file.
  - getFormat
```
public String getFormat()
                 throws IOException
```
    Major version of the data file backing the this data set.
    
    Returns:
    
    major version of the data file.
    
    Throws:
    
    IOException - if there was a problem accessing data file.
  - getComponents
```
public IReadonlyList<Component> getComponents()
```
    Returns an iterable of all Components in the current data file. For more information see: 51Degrees Pattern Data Model
    
    Returns:
    
    iterable of Component entities in the current data file.
  - getMaps
```
public IReadonlyList<Map> getMaps()
```
    Returns an iterable list of maps contained within the data file. May contain multiple maps with the same name.
    
    Returns:
    
    a read-only list of all maps contained in the data set.
  - getProperties
```
public IReadonlyList<Property> getProperties()
```
    A list of all properties the data set contains.
    
    Returns:
    
    a read-only list of all properties contained in the data set
  - getValues
```
public IReadonlyList<Value> getValues()
```
    A list of all values the data set contains. A value is the specific content of a Property for a specific Profile. For example: IsMobile can have value 'True' for profile A but have a value 'False' for profile B.
    
    Returns:
    
    a read-only list of values contained in the data set
  - getSignatures
```
public IReadonlyList<Signature> getSignatures()
```
    List of signatures the data set contains. Signatures contain one Profile per Component and rank values.
    For more information see: 51Degrees Pattern Data Model
    
    Returns:
    
    a read-only list of all signatures contained in the data set
  - getNodes
```
public IReadonlyList<Node> getNodes()
```
    List of nodes the data set contains.
    
    Returns:
    
    a read-only list of nodes contained in the data set
  - getProfiles
```
public IReadonlyList<Profile> getProfiles()
```
    A list of all the possible profiles contained in the current data set. Profiles contain multiple values. Each profile belongs to one Component and can be assigned to many signatures.
    For more information see: 51Degrees Pattern Data Model
    
    Returns:
    
    a read-only list of all profiles contained in the data set
  - getMinUserAgentLength
```
public short getMinUserAgentLength()
```
    The minimum length of a User-Agent string.
    
    Returns:
    
    The minimum length of a User-Agent string.
  - getSignatureNodeOffsets
```
public IFixedList<IntegerEntity> getSignatureNodeOffsets()
```
    Returns a list of integers that represent signature node offsets.
    
    Returns:
    
    list of integers that represent signature node offsets.
  - getNodeRankedSignatureIndexes
```
public IFixedList<IntegerEntity> getNodeRankedSignatureIndexes()
```
    Returns a list of integers that represent ranked signature indexes.
    
    Returns:
    
    a list of integers that represent ranked signature indexes.
  - getHttpHeaders
```
public String[] getHttpHeaders()
                        throws IOException
```
    Creates a list of HTTP headers if one does not already exist. Most devices can be identified by examining the HTTP User-Agent header alone while other devices and (or) browsers sometimes set an extra header that can be used to improve detection. This list represents the headers that are important to device detection process.
    
    Returns:
    
    list of HTTP headers as Strings.
    
    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.
    Do not use this method as it is part of the internal logic.
    
    Throws:
    
    IOException - signals an I/O exception occurred
  - initSignatures
```
public void initSignatures()
                    throws IOException
```
    Preloads signatures to speed retrieval later at the expense of memory. This method doesn't need to be used if init() has already been called.
    This method should not be called as it is part of the internal logic.
    
    Throws:
    
    IOException - if there was a problem accessing data file.
  - initNodes
```
public void initNodes()
               throws IOException
```
    Preloads nodes to speed retrieval later at the expense of memory. This method doesn't need to be used if init() has already been called.
    This method should not be called as it is part of the internal logic.
    
    Throws:
    
    IOException - if there was a problem accessing data file.
  - initProfiles
```
public void initProfiles()
                  throws IOException
```
    Preloads profiles to speed retrieval later at the expense of memory. This method doesn't need to be used if init() has already been called.
    This method should not be called as it is part of the internal logic.
    
    Throws:
    
    IOException - if there was a problem accessing data file.
  - initComponents
```
public void initComponents()
                    throws IOException
```
    Preloads components to speed retrieval later at the expense of memory. This method doesn't need to be used if init() has already been called.
    This method should not be called as it is part of the internal logic.
    
    Throws:
    
    IOException - if there was a problem accessing data file.
  - initProperties
```
public void initProperties()
                    throws IOException
```
    Preloads properties to speed retrieval later at the expense of memory. This method doesn't need to be used if init() has already been called.
    This method should not be called as it is part of the internal logic.
    
    Throws:
    
    IOException - if there was a problem accessing data file.
  - initValues
```
public void initValues()
                throws IOException
```
    Preloads values to speed retrieval later at the expense of memory. This method doesn't need to be used if init() has already been called.
    This method should not be called as it is part of the internal logic.
    
    Throws:
    
    IOException - if there was a problem accessing data file.
  - getComponent
```
public Component getComponent(String componentName)
                       throws IOException
```
    Retrieves Component by name if a component with such name exists. Method can return null if no component with required name was found; use a null check when invoking.
    Component contains a list of Profile and Property that are related to this component. For more information see: 51Degrees Pattern Data Model
    
    Parameters:
    
    componentName - name of the required Component as string.
    
    Returns:
    
    The Component matching the name, or null.
    
    Throws:
    
    IOException - if there was a problem accessing data file.
  - get
```
public Property get(String propertyName)
             throws IOException
```
    Method searches for a property with the given name and returns one if found. Method is capable of returning a null, so add a check for null when invoking.
    
    Parameters:
    
    propertyName - name of the property to find, should not be null.
    
    Returns:
    
    Property object or null if no property with requested name exists
    
    Throws:
    
    IOException - if there was a problem accessing data file.
  - getPropertyByName
```
@Deprecated
public Property getPropertyByName(String propertyName)
                                        throws IOException
```
    Deprecated.
    
    Method is deprecated and should not be used. Use get( StringpropertyName) instead. Method searches for a property with the given name and returns the Property if found. Returns null otherwise.
    
    Parameters:
    
    propertyName - name of the property to find as a string.
    
    Returns:
    
    Property object or null if no property with requested name exists
    
    Throws:
    
    IOException - if there was a problem accessing data file.
  - getProfilesCount
```
public int getProfilesCount()
```
    Returns the number of profiles each signature can contain. The number of profiles should be equal to the number of components, in other words: each signature has one profile per component.
    
    Returns:
    
    The number of profiles each signature can contain.
  - getNodesCount
```
public int getNodesCount()
```
    Returns the number of nodes each signature can contain.
    
    Returns:
    
    The number of nodes each signature can contain.
  - findProfile
```
public Profile findProfile(int profileId)
                    throws IOException
```
    Searches the list of profile IDs and returns the profile if the profile id is valid.
    
    Parameters:
    
    profileId - Id of the profile to be found, not negative.
    
    Returns:
    
    Profile related to the id, or null if none found.
    
    Throws:
    
    IOException - signals an I/O exception occurred
  - close
```
public void close()
           throws IOException
```
    Disposes of the data set releasing any file locks.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    IOException - if there was a problem accessing data file.
  - getPercentageRankedSignatureCacheMisses
```
@Deprecated
public double getPercentageRankedSignatureCacheMisses()
```
    Deprecated.
    
    The percentage of requests for ranked signatures which were not already contained in the cache.A value is only returned when operating in Stream mode.
    
    Returns:
    
    The percentage of requests for ranked signatures which were not already contained in the cache.
  - getSignatureCacheSwitches
```
@Deprecated
public long getSignatureCacheSwitches()
```
    Deprecated.
    
    Number of times the signature cache was switched. Note: The LRU does not require switching and this method has been deprecated. A value is only returned when operating in Stream mode.
    
    Returns:
    
    Number of times the signature cache was switched.
  - getNodeCacheSwitches
```
@Deprecated
public long getNodeCacheSwitches()
```
    Deprecated.
    
    Number of times the node cache was switched. Note: The LRU does not require switching and this method has been deprecated. A value is only returned when operating in Stream mode.
    
    Returns:
    
    Number of times the node cache was switched.
  - getStringsCacheSwitches
```
@Deprecated
public long getStringsCacheSwitches()
```
    Deprecated.
    
    Number of times the strings cache was switched. Note: The LRU does not require switching and this method has been deprecated. A value is only returned when operating in Stream mode.
    
    Returns:
    
    Number of times the strings cache was switched.
  - getProfilesCacheSwitches
```
@Deprecated
public long getProfilesCacheSwitches()
```
    Deprecated.
    
    Number of times the profiles cache was switched. Note: The LRU does not require switching and this method has been deprecated. A value is only returned when operating in Stream mode.
    
    Returns:
    
    Number of times the profiles cache was switched.
  - getValuesCacheSwitches
```
@Deprecated
public long getValuesCacheSwitches()
```
    Deprecated.
    
    Number of times the values cache was switched. Note: The LRU does not require switching and this method has been deprecated. A value is only returned when operating in Stream mode.
    
    Returns:
    
    Number of times the values cache was switched.
  - getRankedSignatureIndexes
```
public IFixedList<IntegerEntity> getRankedSignatureIndexes()
```
    Returns a list of signature indexes ordered in ascending order of rank.
    
    Returns:
    
    A list of signature indexes ordered in ascending order of rank.
  - getRankedSignatureCacheSwitches
```
@Deprecated
public long getRankedSignatureCacheSwitches()
```
    Deprecated.
    
    Number of times the ranked signature cache was switched. A value is only returned when operating in Stream mode.
    
    Returns:
    
    Number of times the ranked signature cache was switched.
  - resetCache
```
public void resetCache()
```
    If there are cached lists being used the states are reset for them.

Class Dataset

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

age

components

copyright

copyrightOffset

csvBufferLength

deviceCombinations

export

format

formatOffset

highestCharacter

jsonBufferLength

lastModified

lowestCharacter

maps

maxSignatures

maxSignaturesClosest

maxUserAgentLength

maxValues

maximumRank

minUserAgentCount

minUserAgentLength

mode

nameOffset

nextUpdate

nodes

nodeRankedSignatureIndexes

profiles

profileOffsets

properties

published

rankedSignatureIndexes

rootNodes

signatureNodesCount

signatureNodeOffsets

signatureProfilesCount

signatures

strings

tag

values

version

versionEnum

xmlBufferLength

Constructor Detail

Dataset

Method Detail

getAge

getPercentageSignatureCacheMisses

getPercentageNodeCacheMisses

getPercentageStringsCacheMisses

getPercentageProfilesCacheMisses

getPercentageValuesCacheMisses

getMaximumRank

getDisposed

getHardware

getSoftware

getBrowsers

getCrawlers

getCopyright

getName

getFormat

getComponents

getMaps

getProperties

getValues

getSignatures

getNodes

getProfiles

getMinUserAgentLength

getSignatureNodeOffsets

getNodeRankedSignatureIndexes

getHttpHeaders

init

initSignatures

initNodes