Interface KeyDescriptor
- All Known Implementing Classes:
ItemKeyDescriptor
public interface KeyDescriptor
Descriptor of an
IntegrationObjectItemModel key. Each integration object item must have at least one (a simple key) or
several (composite key) attributes, which identify instances of the item type and therefore define its key.-
Method Summary
Modifier and TypeMethodDescriptioncalculateKey(Map<String, Object> item) Calculates key value for the specified data item.Finds all key attributes for the descriptor, including key attributes for the descriptor and all of its referenced key attributesbooleanisKeyAttribute(String attr) Queries whether the specified attribute name is a name of the key attribute.
-
Method Details
-
calculateKey
Calculates key value for the specified data item.- Parameters:
item- Map presentation of a data item, for which the key value needs to be calculated.- Returns:
- the calculated key value.
-
isKeyAttribute
Queries whether the specified attribute name is a name of the key attribute.- Parameters:
attr- name of the attribute to enquire about- Returns:
true, if the specified attribute is a key attribute in this key descriptor;falseotherwise.
-
getKeyAttributes
List<KeyAttribute> getKeyAttributes()Finds all key attributes for the descriptor, including key attributes for the descriptor and all of its referenced key attributes- Returns:
- a list of key attributes
-