com.prosyst.mprm.admin.devices.inventory.spi

Class FunctionalItemsNamingUtils

java.lang.Object

com.prosyst.mprm.admin.devices.inventory.spi.FunctionalItemsNamingUtils

public class FunctionalItemsNamingUtils
extends java.lang.Object

Contains constants used when generating functional items for control unit type.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEVICE_CLASS_INTERFACE The name of the device class which is generated for device control unit types.
static java.lang.String	DEVICE_CLASSES_PACKAGE The package which contains the device classes which are generated for device control unit types.

Constructor Summary

Constructors

Constructor and Description
FunctionalItemsNamingUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getCUDeviceClassName(java.lang.String controlUnitType) Returns the name of the device class generated for given device control unit type.
static java.lang.String	getCUPackage(java.lang.String controlUnitType) Converts control unit type to package name by replacing white spaces, '_' and '-' with the '.' symbol.
static java.lang.String	toIdentifier(java.lang.String name) Converts control unit action or state variable ID to a valid Java identifier.

Methods inherited from class java.lang.Object

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

Field Detail

DEVICE_CLASSES_PACKAGE

public static final java.lang.String DEVICE_CLASSES_PACKAGE

The package which contains the device classes which are generated for device control unit types.

See Also:

Constant Field Values

DEVICE_CLASS_INTERFACE

public static final java.lang.String DEVICE_CLASS_INTERFACE

The name of the device class which is generated for device control unit types.

See Also:

Constant Field Values

Constructor Detail

FunctionalItemsNamingUtils

public FunctionalItemsNamingUtils()

Method Detail

getCUDeviceClassName

public static java.lang.String getCUDeviceClassName(java.lang.String controlUnitType)

Returns the name of the device class generated for given device control unit type. The name is generated by the following algorithm: DEVICE_CLASSES_PACKAGE + "." + getCUPackage(controlUnitType) + "." + DEVICE_CLASS_INTERFACE

Parameters:

controlUnitType - device control unit type

Returns:

device class name

getCUPackage

public static java.lang.String getCUPackage(java.lang.String controlUnitType)

Converts control unit type to package name by replacing white spaces, '_' and '-' with the '.' symbol.

Parameters:

controlUnitType - control unit type

Returns:

valid package identifier

toIdentifier

public static java.lang.String toIdentifier(java.lang.String name)

Converts control unit action or state variable ID to a valid Java identifier. The conversion generates a camel-cased identifier by removing whitespace, '_', '-' and '.' characters and converting the character after them to upper case. Non alphanumeric characters are removed. The first character of the returned identifier is in lower case. For example the action id 'console.command' will become 'consoleCommand'.

Parameters:

name - action or state variable ID

Returns:

valid Java identifier