TrackerHierarchyDisplayScheme (Bosch IoT Remote Manager 7.1 Generic Device Management Package API)

java.lang.Object
- com.prosyst.mprm.admin.cutracker.TrackerHierarchyDisplayScheme

```
public class TrackerHierarchyDisplayScheme
extends java.lang.Object
```
This is an utility class defining the display tree of the control unit tracker and can be used in benefit of gui applications. It structures hierarchically the tracked control unit types for visual representation. In more details, this utility class performs the following tasks:
filters the device types to have only device types of tracked components
orders the device types according the control unit types hierarchy
orders the component types under the respective device types
orders the component types according the control unit type hierarchy
for both (device and component types), replaces linear hierarchy, i.e. when there is a median abstract type that is alone at its hierarchy level, it is removed. For example, if typeA extends typeB extends typeC, and typeB is abstract, and there is no other tracked control unit type that extends typeC. Then structurally the utility class removes the level of typeB and returns typeA under typeC.

Constructor Summary

Constructors
Constructor and Description
`TrackerHierarchyDisplayScheme(DeviceManager dm, ControlUnitTracker tracker)` Constructs the utility class with given `DeviceManager` and `ControlUnitTracker` instances.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String[]`	`getComponentTypes(java.lang.String deviceType, java.lang.String superType, boolean directExtensions)` Returns the component types to display under given device type an super component type.
`java.lang.String[]`	`getDeviceTypes(java.lang.String superType, boolean directExtensions)` Returns device types to display under the given `superType`.

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

- Constructor Detail
  - TrackerHierarchyDisplayScheme
```
public TrackerHierarchyDisplayScheme(DeviceManager dm,
                                     ControlUnitTracker tracker)
```
    Constructs the utility class with given DeviceManager and ControlUnitTracker instances. The application must have references to the Device Manager and Control Unit Tracker services.
    
    Parameters:
    
    dm - reference to the DeviceManager service.
    
    tracker - reference to the ControlUnitTracker service.
- Method Detail
  - getDeviceTypes
```
public java.lang.String[] getDeviceTypes(java.lang.String superType,
                                         boolean directExtensions)
                                  throws ManagementException
```
    Returns device types to display under the given superType. Value of null should be passed for the root level.
    
    Parameters:
    
    superType - control unit type to expand, or null if on the root level.
    
    directExtensions - boolean flag determining if the application requires direct extensions only (value of true) or all extensions (value of false) of the given device type in the control unit types hierarchy.
    
    Returns:
    
    list of extending device types.
    
    Throws:
    
    ManagementException - if system error occurs.
  - getComponentTypes
```
public java.lang.String[] getComponentTypes(java.lang.String deviceType,
                                            java.lang.String superType,
                                            boolean directExtensions)
                                     throws ManagementException
```
    Returns the component types to display under given device type an super component type.
    
    Parameters:
    
    deviceType - the last expanded device type.
    
    superType - component control unit type to expand, or null if expanding the root components of the given device type.
    
    directExtensions - boolean flag determining if the application requires direct extensions only (value of true) or all extensions (value of false) of the given component type in the control unit types hierarchy.
    
    Returns:
    
    list if extending component types.
    
    Throws:
    
    ManagementException - if system error occurs.

Class TrackerHierarchyDisplayScheme

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TrackerHierarchyDisplayScheme

Method Detail

getDeviceTypes

getComponentTypes