Package org.openremote.model.value

Class MetaItemDescriptor<T>

java.lang.Object

org.openremote.model.value.AbstractNameValueDescriptorHolder<T>

org.openremote.model.value.MetaItemDescriptor<T>

All Implemented Interfaces:

NameHolder, ValueDescriptorHolder<T>

public class MetaItemDescriptor<T>
extends AbstractNameValueDescriptorHolder<T>

Describes a MetaItem that can be added to an Attribute; the AbstractNameValueDescriptorHolder.getName() must match the AbstractNameValueHolder.getName(), it also indicates what the ValueDescriptor is for the MetaItem. The MetaItemDescriptor applies to the Asset type it is associated with and all subtypes of this type (i.e. a MetaItemDescriptor associated with the base Asset type will be available to all Asset types (e.g. MetaItemType.READ_ONLY can be applied to any Asset's Attribute).

AbstractNameValueDescriptorHolder.getName() must be globally unique within the context of the manager it is registered with.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetaItemDescriptor.StringMetaItemDescriptorConverter	This class handles deserialising meta item descriptor names to MetaItemDescriptors; to reuse instances

Nested classes/interfaces inherited from interface org.openremote.model.value.NameHolder

NameHolder.NameHolderToStringConverter

Field Summary

Fields inherited from class org.openremote.model.value.AbstractNameValueDescriptorHolder

constraints, format, name, type, units

Constructor Summary

Constructors

Constructor	Description
MetaItemDescriptor(String name, ValueDescriptor<T> valueDescriptor, ValueConstraint... constraints)
MetaItemDescriptor(String name, ValueDescriptor<T> type, ValueConstraint[] constraints, ValueFormat format, String[] units)

Method Summary

Modifier and Type	Method	Description
MetaItemDescriptor<T>	setConstraints(ValueConstraint... constraints)
MetaItemDescriptor<T>	setFormat(ValueFormat format)
MetaItemDescriptor<T>	setUnits(String... units)
String	toString()

Methods inherited from class org.openremote.model.value.AbstractNameValueDescriptorHolder

equals, getConstraints, getFormat, getName, getType, getUnits, hashCode, setName, setType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

MetaItemDescriptor

public MetaItemDescriptor(String name,
 ValueDescriptor<T> valueDescriptor,
 ValueConstraint... constraints)

MetaItemDescriptor

public MetaItemDescriptor(String name,
 ValueDescriptor<T> type,
 ValueConstraint[] constraints,
 ValueFormat format,
 String[] units)

Method Details

setFormat

public MetaItemDescriptor<T> setFormat(ValueFormat format)

setConstraints

public MetaItemDescriptor<T> setConstraints(ValueConstraint... constraints)

setUnits

public MetaItemDescriptor<T> setUnits(String... units)

toString

public String toString()

Overrides:

toString in class AbstractNameValueDescriptorHolder<T>