Package org.openremote.agent.protocol

Class ProtocolAssetService.MergeOptions

java.lang.Object

org.openremote.agent.protocol.ProtocolAssetService.MergeOptions

Enclosing interface:

ProtocolAssetService

public static class ProtocolAssetService.MergeOptions
extends Object

Options when merging and storing assets from protocols.

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	assignToUserName
protected final Predicate<String>	attributeNamesToEvaluate
protected final Predicate<String>	ignoredAttributeKeys
protected final Predicate<String>	ignoredAttributeNames

Constructor Summary

Constructors

Constructor	Description
MergeOptions(String assignToUserName)
MergeOptions(String assignToUserName, Predicate<String> ignoredAttributeKeys)
MergeOptions(String assignToUserName, Predicate<String> attributeNamesToEvaluate, Predicate<String> ignoredAttributeNames, Predicate<String> ignoredAttributeKeys)
MergeOptions(Predicate<String> attributeNamesToEvaluate)
MergeOptions(Predicate<String> ignoredAttributeNames, Predicate<String> ignoredAttributeKeys)

Method Summary

Modifier and Type	Method	Description
String	getAssignToUserName()	Assigns the merged asset to the given user, can be null to not assign the asset to a user.
Predicate<String>	getAttributeNamesToEvaluate()	Compare existing and merged asset state before doing the actual storage merge.
Predicate<String>	getIgnoredAttributeKeys()	Compare existing and merged asset state before doing the actual storage merge.
Predicate<String>	getIgnoredAttributeNames()	Compare existing and merged asset state before doing the actual storage merge.

Methods inherited from class java.lang.Object

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

Field Details

assignToUserName

protected final String assignToUserName

attributeNamesToEvaluate

protected final Predicate<String> attributeNamesToEvaluate

ignoredAttributeNames

protected final Predicate<String> ignoredAttributeNames

ignoredAttributeKeys

protected final Predicate<String> ignoredAttributeKeys

Constructor Details

MergeOptions

public MergeOptions(String assignToUserName)

MergeOptions

public MergeOptions(Predicate<String> attributeNamesToEvaluate)

MergeOptions

public MergeOptions(Predicate<String> ignoredAttributeNames,
 Predicate<String> ignoredAttributeKeys)

MergeOptions

public MergeOptions(String assignToUserName,
 Predicate<String> ignoredAttributeKeys)

MergeOptions

public MergeOptions(String assignToUserName,
 Predicate<String> attributeNamesToEvaluate,
 Predicate<String> ignoredAttributeNames,
 Predicate<String> ignoredAttributeKeys)

Method Details

getAssignToUserName

public String getAssignToUserName()

Assigns the merged asset to the given user, can be null to not assign the asset to a user. The ProtocolAssetService.mergeAsset(T) call returns null if the user doesn't exist or the asset couldn't be assigned.

getAttributeNamesToEvaluate

public Predicate<String> getAttributeNamesToEvaluate()

Compare existing and merged asset state before doing the actual storage merge. If only the attributes in this predicate have change, then perform the merge on storage. Ignores what {#link getIgnoredAttributeNames} has stored if attributeNamesToEvaluate is not null.

getIgnoredAttributeNames

public Predicate<String> getIgnoredAttributeNames()

Compare existing and merged asset state before doing the actual storage merge. If only the ignored attributes have changed, don't perform the merge on storage.

getIgnoredAttributeKeys

public Predicate<String> getIgnoredAttributeKeys()

Compare existing and merged asset state before doing the actual storage merge. If only the ignored keys of any attributes have changed, don't perform the merge on storage. If {#link getAttributeNamesToEvaluate} is not null, then ignoredAttributeKeys is ignored.