Package net.solarnetwork.domain.datum

Class GeneralDatumMetadata

java.lang.Object

net.solarnetwork.domain.datum.DatumSupport

net.solarnetwork.domain.datum.GeneralDatumMetadata

All Implemented Interfaces:

Serializable, DatumMetadataOperations, MutableDatumMetadataOperations, Differentiable<DatumMetadataOperations>

public class GeneralDatumMetadata
extends DatumSupport
implements DatumMetadataOperations, MutableDatumMetadataOperations, Serializable

Metadata about general node datum streams of data.

Version:

2.1

Author:

matt

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
GeneralDatumMetadata()	Default constructor.
GeneralDatumMetadata(Map<String,Object> info)	Construct with values.
GeneralDatumMetadata(Map<String,Object> info, Map<String,Map<String,Object>> propertyInfo)	Construct with values.
GeneralDatumMetadata(GeneralDatumMetadata other)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
void	clear()	Remove all data values.
boolean	equals(Object obj)
Map<String,Object>	getInfo()	Get a general information metadata map.
Map<String,Object>	getM()	Shortcut for getInfo().
Map<String,Map<String,Object>>	getPm()	Shortcut for getPropertyInfo().
Map<String,Map<String,Object>>	getPropertyInfo()	Get a map of property info maps.
Map<String,?>	getPropertyInfo(String key)	Get the property information metadata map for a given key.
Set<String>	getPropertyInfoKeys()	Get a set of all available property info keys.
int	hashCode()
void	merge(DatumMetadataOperations meta, boolean replace)	Merge the values from another datum metadata instance into this one.
Object	metadataAtPath(String path)	Get a metadata value at a given path.
<T> T	metadataAtPath(String path, Class<T> clazz)	Get a metadata value of a given type at a given path.
static Object	metadataAtPath(String path, GeneralDatumMetadata meta)	Get a metadata value at a given path.
static <T> T	metadataAtPath(String path, GeneralDatumMetadata meta, Class<T> clazz)	Get a metadata value of a given type at a given path.
void	populate(KeyValuePair[] data)	Populate metadata values based on a list of KeyValuePair instances.
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.
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	setM(Map<String,Object> map)	Shortcut for setInfo(Map).
void	setPm(Map<String,Map<String,Object>> map)	Shortcut for setPropertyInfo(Map).
void	setPropertyInfo(Map<String,Map<String,Object>> propertyInfo)	Set the property info.
String	toString()

Methods inherited from class net.solarnetwork.domain.datum.DatumSupport

addTag, getMapBigDecimal, getMapDouble, getMapFloat, getMapInteger, getMapLong, getMapString, getT, getTags, hasTag, removeTag, setT, setTags

Methods inherited from class java.lang.Object

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

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

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

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

addTag, removeTag, setTags

Constructor Details

GeneralDatumMetadata

public GeneralDatumMetadata()

Default constructor.

GeneralDatumMetadata

public GeneralDatumMetadata(GeneralDatumMetadata other)

Copy constructor.

This constructor will copy all the top-level collections into new collection instances, but preserving all value instances.

Parameters:

other - the metadata to copy

GeneralDatumMetadata

public GeneralDatumMetadata(Map<String,Object> info)

Construct with values.

Parameters:

info - the info data

GeneralDatumMetadata

public GeneralDatumMetadata(Map<String,Object> info,
 Map<String,Map<String,Object>> propertyInfo)

Construct with values.

Parameters:

info - the info data

propertyInfo - the property info data

Method Details

populate

public void populate(KeyValuePair[] data)

Populate metadata values based on a list of KeyValuePair instances.

Each pair's key will be used as a general metadata key, unless it starts with a / character in which case a path is assumed. Values that can be coerced to number types will be.

Parameters:

data - the data to populate

toString

public String toString()

Overrides:

toString in class Object

clear

public void clear()

Description copied from class: DatumSupport

Remove all data values.

Specified by:

clear in interface MutableDatumMetadataOperations

Overrides:

clear in class DatumSupport

getPropertyInfoKeys

public Set<String> getPropertyInfoKeys()

Description copied from interface: DatumMetadataOperations

Get a set of all available property info keys.

Specified by:

getPropertyInfoKeys in interface DatumMetadataOperations

Returns:

the set of property info keys, never null

getPropertyInfo

public Map<String,?> getPropertyInfo(String key)

Description copied from interface: DatumMetadataOperations

Get the property information metadata map for a given key.

Specified by:

getPropertyInfo in interface DatumMetadataOperations

Parameters:

key - the property key to get the metadata for

Returns:

the property metadata, or null

merge

public void merge(DatumMetadataOperations meta,
 boolean replace)

Description copied from interface: MutableDatumMetadataOperations

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

Specified by:

merge in interface MutableDatumMetadataOperations

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

putInfoValue

public void putInfoValue(String key,
 Object value)

Description copied from interface: MutableDatumMetadataOperations

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

Specified by:

putInfoValue in interface MutableDatumMetadataOperations

Parameters:

key - the key to put

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getInfo

public Map<String,Object> getInfo()

Description copied from interface: DatumMetadataOperations

Get a general information metadata map.

Specified by:

getInfo in interface DatumMetadataOperations

Returns:

the map of general information, or null

setInfo

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

Description copied from interface: MutableDatumMetadataOperations

Set the complete info metadata map.

Specified by:

setInfo in interface MutableDatumMetadataOperations

Parameters:

info - the info to set, or null

getM

public Map<String,Object> getM()

Shortcut for getInfo().

Returns:

map

setM

public void setM(Map<String,Object> map)

Shortcut for setInfo(Map).

Parameters:

map - the Map to set

getPropertyInfo

public Map<String,Map<String,Object>> getPropertyInfo()

Get a map of property info maps. Each top-level key represents a property name and the associated map the metadata for that property.

Returns:

map

setInfo

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

Description copied from interface: MutableDatumMetadataOperations

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

Specified by:

setInfo in interface MutableDatumMetadataOperations

Parameters:

key - the property key

info - the info metadata to set, or null

setPropertyInfo

public void setPropertyInfo(Map<String,Map<String,Object>> propertyInfo)

Set the property info.

Parameters:

propertyInfo - the property info to set

getPm

public Map<String,Map<String,Object>> getPm()

Shortcut for getPropertyInfo().

Returns:

the map

setPm

public void setPm(Map<String,Map<String,Object>> map)

Shortcut for setPropertyInfo(Map).

Parameters:

map - the map to set

putInfoValue

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

Description copied from interface: MutableDatumMetadataOperations

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

Specified by:

putInfoValue in interface MutableDatumMetadataOperations

Parameters:

property - the property name

key - the key to put

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

metadataAtPath

public Object metadataAtPath(String path)

Description copied from interface: DatumMetadataOperations

Get a metadata value at a given path.

Specified by:

metadataAtPath in interface DatumMetadataOperations

Parameters:

path - the path of the metadata object to get

Returns:

the metadata value, or null if none exists at the given path

See Also:

• DatumMetadataOperations.metadataAtPath(String, Class)

metadataAtPath

public <T> T metadataAtPath(String path,
 Class<T> clazz)

Description copied from interface: DatumMetadataOperations

Get a metadata value of a given type at a given path.

The path syntax is that of URL paths, using a / delimiter between nested metadata objects. The top-level path component must be one of /m for DatumMetadataOperations.getInfo() data, /pm for DatumMetadataOperations.getPropertyInfo(String) data, or /t for DatumMetadataOperations.getTags() data.

For example, the path /m/foo would return the value associated with the "foo" key in the Map returned from DatumMetadataOperations.getInfo(). The path /pm/foo/bar would return the "bar" key in the Map associated with the "foo" key in the Map returned from DatumMetadataOperations.getPropertyInfo(String).

For tags, using the /t path will return the complete Set of tags returned by DatumMetadataOperations.getTags(). If the path has another component, then the next component value will be returned if a tag matching that component value exists. For example the path /t/foo would return foo if DatumMetadataOperations.getTags() contains foo, otherwise null.

Specified by:

metadataAtPath in interface DatumMetadataOperations

Type Parameters:

T - the expected return type

Parameters:

path - the path of the metadata object to get

clazz - the expected class of the return type

Returns:

the metadata, or null if none exists at the given path or is not of type T

metadataAtPath

public static Object metadataAtPath(String path,
 GeneralDatumMetadata meta)

Get a metadata value at a given path.

The path syntax is that of URL paths, using a / delimiter between nested metadata objects. The top-level path component must be one of /m for getInfo() data, /pm for getPropertyInfo() data, or /t for DatumSupport.getTags() data.

For example, the path /m/foo would return the value associated with the "foo" key in the Map returned from getInfo(). The path /pm/foo/bar would return the "bar" key in the Map associated with the "foo" key in the Map returned from getPropertyInfo().

For tags, using the /t path will return the complete Set of tags returned by DatumSupport.getTags(). If the path has another component, then the next component value will be returned if a tag matching that component value exists. For example the path /t/foo would return foo if DatumSupport.getTags() contains foo, otherwise null.

Parameters:

path - the path of the metadata object to get

meta - the metadata to look in

Returns:

the metadata value, or null if none exists at the given path

Since:

1.3

metadataAtPath

public static <T> T metadataAtPath(String path,
 GeneralDatumMetadata meta,
 Class<T> clazz)

Get a metadata value of a given type at a given path.

Type Parameters:

T - the expected return type

Parameters:

path - the path of the metadata object to get

meta - the metadata to look in

clazz - the expected class of the return type

Returns:

the metadata, or null if none exists at the given path or is not of type T

Since:

1.3

See Also:

• metadataAtPath(String, GeneralDatumMetadata, Class)