org.openbase.bco.registry.lib.util

Class LocationUtils

java.lang.Object

org.openbase.bco.registry.lib.util.LocationUtils

public class LocationUtils
extends Object

Author:

Divine Threepwood

Constructor Summary

Constructors

Constructor and Description
LocationUtils()

Method Summary

Modifier and Type	Method and Description
static rst.domotic.unit.UnitConfigType.UnitConfig	computeNewRootLocation(rst.domotic.unit.UnitConfigType.UnitConfig currentLocationConfig, org.openbase.jul.extension.protobuf.container.ProtoBufMessageMap<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder> entryMap)
static rst.domotic.unit.location.LocationConfigType.LocationConfig.LocationType	detectLocationType(rst.domotic.unit.UnitConfigType.UnitConfig locationUnit, org.openbase.jul.storage.registry.ProtoBufRegistry<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder> locationRegistry) Detect the type of a location.
static rst.domotic.unit.UnitConfigType.UnitConfig	detectRootLocation(rst.domotic.unit.UnitConfigType.UnitConfig currentLocationConfig, org.openbase.jul.extension.protobuf.container.ProtoBufMessageMap<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder> entryMap, org.openbase.jul.storage.registry.ConsistencyHandler consistencyHandler)
static rst.domotic.unit.UnitConfigType.UnitConfig	getRootLocation(List<rst.domotic.unit.UnitConfigType.UnitConfig> locationUnitConfigList)
static rst.domotic.unit.UnitConfigType.UnitConfig	getRootLocation(org.openbase.jul.extension.protobuf.container.ProtoBufMessageMap<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder> entryMap)
static void	validateRootLocation(rst.domotic.unit.UnitConfigType.UnitConfig newRootLocation, org.openbase.jul.extension.protobuf.container.ProtoBufMessageMap<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder> entryMap, org.openbase.jul.storage.registry.ConsistencyHandler consistencyHandler)

Methods inherited from class java.lang.Object

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

Constructor Detail

LocationUtils

public LocationUtils()

Method Detail

validateRootLocation

public static void validateRootLocation(rst.domotic.unit.UnitConfigType.UnitConfig newRootLocation,
                                        org.openbase.jul.extension.protobuf.container.ProtoBufMessageMap<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder> entryMap,
                                        org.openbase.jul.storage.registry.ConsistencyHandler consistencyHandler)
                                 throws org.openbase.jul.exception.CouldNotPerformException,
                                        org.openbase.jul.storage.registry.EntryModification

Throws:

org.openbase.jul.exception.CouldNotPerformException

org.openbase.jul.storage.registry.EntryModification

getRootLocation

public static rst.domotic.unit.UnitConfigType.UnitConfig getRootLocation(org.openbase.jul.extension.protobuf.container.ProtoBufMessageMap<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder> entryMap)
                                                                  throws org.openbase.jul.exception.NotAvailableException,
                                                                         org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.NotAvailableException

org.openbase.jul.exception.CouldNotPerformException

getRootLocation

public static rst.domotic.unit.UnitConfigType.UnitConfig getRootLocation(List<rst.domotic.unit.UnitConfigType.UnitConfig> locationUnitConfigList)
                                                                  throws org.openbase.jul.exception.NotAvailableException,
                                                                         org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.NotAvailableException

org.openbase.jul.exception.CouldNotPerformException

detectRootLocation

public static rst.domotic.unit.UnitConfigType.UnitConfig detectRootLocation(rst.domotic.unit.UnitConfigType.UnitConfig currentLocationConfig,
                                                                            org.openbase.jul.extension.protobuf.container.ProtoBufMessageMap<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder> entryMap,
                                                                            org.openbase.jul.storage.registry.ConsistencyHandler consistencyHandler)
                                                                     throws org.openbase.jul.exception.CouldNotPerformException,
                                                                            org.openbase.jul.storage.registry.EntryModification

Throws:

org.openbase.jul.exception.CouldNotPerformException

org.openbase.jul.storage.registry.EntryModification

computeNewRootLocation

public static rst.domotic.unit.UnitConfigType.UnitConfig computeNewRootLocation(rst.domotic.unit.UnitConfigType.UnitConfig currentLocationConfig,
                                                                                org.openbase.jul.extension.protobuf.container.ProtoBufMessageMap<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder> entryMap)
                                                                         throws org.openbase.jul.exception.CouldNotPerformException

Throws:

org.openbase.jul.exception.CouldNotPerformException

detectLocationType

public static rst.domotic.unit.location.LocationConfigType.LocationConfig.LocationType detectLocationType(rst.domotic.unit.UnitConfigType.UnitConfig locationUnit,
                                                                                                          org.openbase.jul.storage.registry.ProtoBufRegistry<String,rst.domotic.unit.UnitConfigType.UnitConfig,rst.domotic.unit.UnitConfigType.UnitConfig.Builder> locationRegistry)
                                                                                                   throws org.openbase.jul.exception.CouldNotPerformException

Detect the type of a location. Since a location, except the root location, always has a parent the only ambiguous case is when the parent is a zone but no children are defined. Than the location can either be a zone or a tile. In this case an exception is thrown.

Parameters:

locationUnit - the location of which the type is detected

locationRegistry - the location registry

Returns:

the type locationUnit should have

Throws:

org.openbase.jul.exception.CouldNotPerformException - if the type is ambiguous