Package org.openremote.model.attribute

Class Attribute<T>

java.lang.Object

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

org.openremote.model.attribute.Attribute<T>

All Implemented Interfaces:

Serializable, MetaHolder, NameHolder, NameValueHolder<T>, ValueHolder<T>

public class Attribute<T>
extends AbstractNameValueHolder<T>
implements MetaHolder

Stores a named value with associated MetaItems.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Attribute.AttributeDeserializer	Custom deserializer that can use asset type info from deserialization context when it is passed in from the asset deserializer
static class	Attribute.AttributeSerializer	Custom serializer that can serialize valueStr (for attributes that haven't been fully hydrated)

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

NameHolder.NameHolderToStringConverter

Field Summary

Fields

Modifier and Type	Field	Description
protected @Valid MetaMap	meta
protected long	timestamp

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

name, type, value, valueStr

Constructor Summary

Constructors

Constructor	Description
Attribute(String name)
Attribute(String name, ValueDescriptor<?> valueDescriptor)
Attribute(String name, ValueDescriptor<T> valueDescriptor, T value)
Attribute(String name, ValueDescriptor<T> valueDescriptor, T value, long timestamp)
Attribute(AttributeDescriptor<T> attributeDescriptor)
Attribute(AttributeDescriptor<T> attributeDescriptor, T value)
Attribute(AttributeDescriptor<T> attributeDescriptor, T value, long timestamp)

Method Summary

Modifier and Type	Method	Description
Attribute<T>	addMeta(@NotNull Collection<MetaItem<?>> meta)
Attribute<T>	addMeta(@NotNull MetaItem<?>... meta)
Attribute<T>	addMeta(@NotNull MetaMap meta)
Attribute<T>	addOrReplaceMeta(@NotNull Collection<MetaItem<?>> meta)
Attribute<T>	addOrReplaceMeta(@NotNull MetaItem<?>... meta)
Attribute<T>	addOrReplaceMeta(@NotNull MetaMap meta)
boolean	deepEquals(Object o)
boolean	equals(Object obj)	Super fast equality checking using the name, type and timestamp; when an Attribute value is updated then the timestamp must be greater than the existing value timestamp; and also when merging an Asset any modified Attribute should have a newer timestamp; the backend should take care to update the Attribute timestamp when merging an Asset by using deepEquals(java.lang.Object).
boolean	equals(Object obj, Comparator<Attribute<?>> comparator)
static Stream<Attribute<?>>	getAddedOrModifiedAttributes(Collection<Attribute<?>> oldAttributes, Collection<Attribute<?>> newAttributes)
static Stream<Attribute<?>>	getAddedOrModifiedAttributes(Collection<Attribute<?>> oldAttributes, Collection<Attribute<?>> newAttributes, Predicate<String> ignoredAttributeNames)
static Stream<Attribute<?>>	getAddedOrModifiedAttributes(Collection<Attribute<?>> oldAttributes, Collection<Attribute<?>> newAttributes, Predicate<String> limitToAttributeNames, Predicate<String> ignoredAttributeNames)
MetaMap	getMeta()
Optional<Long>	getTimestamp()
Optional<T>	getValue()
<U> Optional<U>	getValue(Class<U> valueType)	Provides basic type casting/coercion useful for unknown values
boolean	hasExplicitTimestamp()
int	hashCode()
Attribute<T>	setMeta(MetaMap meta)
Attribute<T>	setTimestamp(long timestamp)
void	setTypeInternal(ValueDescriptor<T> type)
void	setValue(T value)
void	setValue(T value, long timestamp)
Attribute<T>	shallowClone()
String	toString()
String	toStringAll()

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

getName, getType, getTypeClass, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openremote.model.value.MetaHolder

getMetaItem, getMetaValue, hasMeta, hasMeta

Field Details

meta

@Valid
protected @Valid MetaMap meta

timestamp

protected long timestamp

Constructor Details

Attribute

public Attribute(AttributeDescriptor<T> attributeDescriptor)

Attribute

public Attribute(AttributeDescriptor<T> attributeDescriptor,
 T value)

Attribute

public Attribute(AttributeDescriptor<T> attributeDescriptor,
 T value,
 long timestamp)

Attribute

public Attribute(String name,
 ValueDescriptor<?> valueDescriptor)

Attribute

public Attribute(String name,
 ValueDescriptor<T> valueDescriptor,
 T value)

Attribute

public Attribute(String name,
 ValueDescriptor<T> valueDescriptor,
 T value,
 long timestamp)

Attribute

public Attribute(String name)

Method Details

getAddedOrModifiedAttributes

public static Stream<Attribute<?>> getAddedOrModifiedAttributes(Collection<Attribute<?>> oldAttributes,
 Collection<Attribute<?>> newAttributes)

Returns:

All attributes that exist only in the new list or are different than any attribute in the old list.

getAddedOrModifiedAttributes

public static Stream<Attribute<?>> getAddedOrModifiedAttributes(Collection<Attribute<?>> oldAttributes,
 Collection<Attribute<?>> newAttributes,
 Predicate<String> ignoredAttributeNames)

Returns:

All attributes that exist only in the new list or are different than any attribute in the old list.

getAddedOrModifiedAttributes

public static Stream<Attribute<?>> getAddedOrModifiedAttributes(Collection<Attribute<?>> oldAttributes,
 Collection<Attribute<?>> newAttributes,
 Predicate<String> limitToAttributeNames,
 Predicate<String> ignoredAttributeNames)

Returns:

All attributes that exist only in the new list or are different than any attribute in the old list

getMeta

public MetaMap getMeta()

Specified by:

getMeta in interface MetaHolder

setMeta

public Attribute<T> setMeta(MetaMap meta)

addMeta

public Attribute<T> addMeta(@NotNull
 @NotNull MetaMap meta)

addMeta

public Attribute<T> addMeta(@NotNull
 @NotNull MetaItem<?>... meta)

addMeta

public Attribute<T> addMeta(@NotNull
 @NotNull Collection<MetaItem<?>> meta)

addOrReplaceMeta

public Attribute<T> addOrReplaceMeta(@NotNull
 @NotNull MetaMap meta)

addOrReplaceMeta

public Attribute<T> addOrReplaceMeta(@NotNull
 @NotNull MetaItem<?>... meta)

addOrReplaceMeta

public Attribute<T> addOrReplaceMeta(@NotNull
 @NotNull Collection<MetaItem<?>> meta)

getValue

public Optional<T> getValue()

Specified by:

getValue in interface ValueHolder<T>

Overrides:

getValue in class AbstractNameValueHolder<T>

getValue

public <U> Optional<U> getValue(@Nonnull
 Class<U> valueType)

Description copied from interface: ValueHolder

Provides basic type casting/coercion useful for unknown values

Specified by:

getValue in interface ValueHolder<T>

Overrides:

getValue in class AbstractNameValueHolder<T>

setValue

public void setValue(T value)

Overrides:

setValue in class AbstractNameValueHolder<T>

setValue

public void setValue(T value,
 long timestamp)

getTimestamp

public Optional<Long> getTimestamp()

setTimestamp

public Attribute<T> setTimestamp(long timestamp)

hasExplicitTimestamp

public boolean hasExplicitTimestamp()

setTypeInternal

public void setTypeInternal(ValueDescriptor<T> type)

toString

public String toString()

Overrides:

toString in class Object

toStringAll

public String toStringAll()

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractNameValueHolder<T>

equals

public boolean equals(Object obj)

Super fast equality checking using the name, type and timestamp; when an Attribute value is updated then the timestamp must be greater than the existing value timestamp; and also when merging an Asset any modified Attribute should have a newer timestamp; the backend should take care to update the Attribute timestamp when merging an Asset by using deepEquals(java.lang.Object).

Overrides:

equals in class AbstractNameValueHolder<T>

deepEquals

public boolean deepEquals(Object o)

equals

public boolean equals(Object obj,
 Comparator<Attribute<?>> comparator)

shallowClone

public Attribute<T> shallowClone()