org.openbase.bco.registry.lib.util

Class DeviceConfigUtils

java.lang.Object

org.openbase.bco.registry.lib.util.DeviceConfigUtils

public class DeviceConfigUtils
extends Object

A collection of utils to manipulate or analyse unit device configs. UnitConfig

Constructor Summary

Constructors

Constructor and Description
DeviceConfigUtils()

Method Summary

Modifier and Type	Method and Description
static boolean	checkDuplicatedUnitType(rst.domotic.unit.UnitConfigType.UnitConfigOrBuilder deviceUnitConfig, rst.domotic.unit.device.DeviceClassType.DeviceClassOrBuilder deviceClass, org.openbase.jul.storage.registry.ProtoBufRegistry<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder> dalUnitRegistry) Check if the given device configuration contains one unit template type more than once.
static String	generateDefaultUnitLabel(rst.domotic.unit.UnitConfigType.UnitConfig.Builder unitConfig, rst.domotic.unit.UnitConfigType.UnitConfigOrBuilder deviceUnitConfig, rst.domotic.unit.device.DeviceClassType.DeviceClassOrBuilder deviceClass, boolean deviceConfigHasDuplicatedUnitType)
static boolean	setupUnitLabelByDeviceConfig(rst.domotic.unit.UnitConfigType.UnitConfig.Builder unitConfig, rst.domotic.unit.UnitConfigType.UnitConfigOrBuilder deviceUnitConfig, rst.domotic.unit.device.DeviceClassType.DeviceClassOrBuilder deviceClass, boolean deviceConfigHasDuplicatedUnitType) Method setups a non defined unit label field or setups the unit label with the device label if the unit is bound to the device.
static boolean	setupUnitLabelByDeviceConfig(rst.domotic.unit.UnitConfigType.UnitConfig.Builder unitConfig, rst.domotic.unit.UnitConfigType.UnitConfigOrBuilder deviceConfig, rst.domotic.unit.device.DeviceClassType.DeviceClassOrBuilder deviceClass, org.openbase.jul.storage.registry.ProtoBufRegistry<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder> dalUnitRegistry) Method setups a non defined unit label field or setups the unit label with the device label if the unit is bound to the device.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeviceConfigUtils

public DeviceConfigUtils()

Method Detail

checkDuplicatedUnitType

public static boolean checkDuplicatedUnitType(rst.domotic.unit.UnitConfigType.UnitConfigOrBuilder deviceUnitConfig,
                                              rst.domotic.unit.device.DeviceClassType.DeviceClassOrBuilder deviceClass,
                                              org.openbase.jul.storage.registry.ProtoBufRegistry<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder> dalUnitRegistry)
                                       throws org.openbase.jul.exception.CouldNotPerformException

Check if the given device configuration contains one unit template type more than once.

Parameters:

deviceUnitConfig -

Returns:

true if a duplicated unit type is detected.

Throws:

org.openbase.jul.exception.CouldNotPerformException

setupUnitLabelByDeviceConfig

public static boolean setupUnitLabelByDeviceConfig(rst.domotic.unit.UnitConfigType.UnitConfig.Builder unitConfig,
                                                   rst.domotic.unit.UnitConfigType.UnitConfigOrBuilder deviceConfig,
                                                   rst.domotic.unit.device.DeviceClassType.DeviceClassOrBuilder deviceClass,
                                                   org.openbase.jul.storage.registry.ProtoBufRegistry<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder> dalUnitRegistry)
                                            throws org.openbase.jul.exception.CouldNotPerformException

Method setups a non defined unit label field or setups the unit label with the device label if the unit is bound to the device.

Parameters:

unitConfig - the unit config to setup the label.

deviceConfig - the device config to lookup device label.

deviceClass - the device class to lookup the unit template.

Returns:

true if the unitConfig was modified otherwise false.

Throws:

org.openbase.jul.exception.CouldNotPerformException

setupUnitLabelByDeviceConfig

public static boolean setupUnitLabelByDeviceConfig(rst.domotic.unit.UnitConfigType.UnitConfig.Builder unitConfig,
                                                   rst.domotic.unit.UnitConfigType.UnitConfigOrBuilder deviceUnitConfig,
                                                   rst.domotic.unit.device.DeviceClassType.DeviceClassOrBuilder deviceClass,
                                                   boolean deviceConfigHasDuplicatedUnitType)
                                            throws org.openbase.jul.exception.CouldNotPerformException

Method setups a non defined unit label field or setups the unit label with the device label if the unit is bound to the device.

Parameters:

unitConfig - the unit config to setup the label.

deviceUnitConfig - the device config to lookup device label.

deviceClass - the device class to lookup the unit template.

deviceConfigHasDuplicatedUnitType - can be precomputed out of performance reasons.

Returns:

true if the unitConfig was modified otherwise false.

Throws:

org.openbase.jul.exception.CouldNotPerformException

generateDefaultUnitLabel

public static String generateDefaultUnitLabel(rst.domotic.unit.UnitConfigType.UnitConfig.Builder unitConfig,
                                              rst.domotic.unit.UnitConfigType.UnitConfigOrBuilder deviceUnitConfig,
                                              rst.domotic.unit.device.DeviceClassType.DeviceClassOrBuilder deviceClass,
                                              boolean deviceConfigHasDuplicatedUnitType)
                                       throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException