Package net.solarnetwork.domain.datum

Interface MutableDatumMetadataOperations

All Superinterfaces:

DatumMetadataOperations, Differentiable<DatumMetadataOperations>

All Known Implementing Classes:

GeneralDatumMetadata

public interface MutableDatumMetadataOperations
extends DatumMetadataOperations

Extension of DatumSamplesOperations that adds mutate operations.

Since:

2.3

Version:

1.0

Author:

matt

Method Summary

Modifier and Type	Method	Description
default boolean	addTag(String tag)	Add a tag.
void	clear()	Remove all property values and tags.
void	merge(DatumMetadataOperations meta, boolean replace)	Merge the values from another datum metadata instance into this one.
void	putInfoValue(String key, Object value)	Put a value into or remove a value from the DatumMetadataOperations.getInfo() map, creating the map if it doesn't exist.
void	putInfoValue(String property, String key, Object value)	Put a value into or remove a value from the DatumMetadataOperations.getPropertyInfo(String) map, creating the map if it doesn't exist.
default boolean	removeTag(String... tags)	Remove one or more tags.
void	setInfo(String key, Map<String,Object> info)	Set the complete property info map for a given property key.
void	setInfo(Map<String,Object> info)	Set the complete info metadata map.
void	setTags(Set<String> tags)	Set the tags.

Methods inherited from interface net.solarnetwork.domain.datum.DatumMetadataOperations

differsFrom, getInfo, getInfo, getInfoBigDecimal, getInfoBigDecimal, getInfoBigInteger, getInfoBigInteger, getInfoDouble, getInfoDouble, getInfoFloat, getInfoFloat, getInfoInteger, getInfoInteger, getInfoKeys, getInfoLong, getInfoLong, getInfoNumber, getInfoNumber, getInfoShort, getInfoShort, getInfoString, getInfoString, getPropertyInfo, getPropertyInfoKeys, getTags, hasInfo, hasInfo, hasMetadataAtPath, hasPropertyInfo, hasTag, isEmpty, metadataAtPath, metadataAtPath

Method Details

clear

void clear()

Remove all property values and tags.

putInfoValue

void putInfoValue(String key,
 Object value)

Put a value into or remove a value from the DatumMetadataOperations.getInfo() map, creating the map if it doesn't exist.

Parameters:

key - the key to put

value - the value to put, or null to remove the key

setInfo

void setInfo(Map<String,Object> info)

Set the complete info metadata map.

Parameters:

info - the info to set, or null

putInfoValue

void putInfoValue(String property,
 String key,
 Object value)

Put a value into or remove a value from the DatumMetadataOperations.getPropertyInfo(String) map, creating the map if it doesn't exist.

Parameters:

property - the property name

key - the key to put

value - the value to put, or null to remove the key

setInfo

void setInfo(String key,
 Map<String,Object> info)

Set the complete property info map for a given property key.

Parameters:

key - the property key

info - the info metadata to set, or null

setTags

void setTags(Set<String> tags)

Set the tags.

Parameters:

tags - the tags to set

addTag

default boolean addTag(String tag)

Add a tag.

Parameters:

tag - the tag value to add

Returns:

true if the tag was not already present

removeTag

default boolean removeTag(String... tags)

Remove one or more tags.

Parameters:

tags - the tags to remove

Returns:

true if any of the given tags were removed

merge

void merge(DatumMetadataOperations meta,
 boolean replace)

Merge the values from another datum metadata instance into this one.

Parameters:

meta - the metadata to merge into this object

replace - if true then replace values in this object with equivalent ones in the provided object, otherwise keep the values from this object