Package com.inductiveautomation.historian.common.model

Record Class Metadata

java.lang.Object

java.lang.Record

com.inductiveautomation.historian.common.model.Metadata

public record Metadata(QualifiedPath path, PropertySet data, Date timestamp)
extends Record

Metadata is the collection of attributes for a node at a given time. If null, it means the path is no longer in use.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Metadata.MetaBuilder

Constructor Summary

Constructors

Constructor	Description
Metadata(QualifiedPath path)
Metadata(QualifiedPath path, PropertySet data)
Metadata(QualifiedPath path, PropertySet data, Date timestamp)	Creates an instance of a Metadata record class.

Method Summary

Modifier and Type	Method	Description
PropertySet	data()	Returns the value of the data record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
PropertySet	getData()
QualifiedPath	getPath()
Date	getTimestamp()
final int	hashCode()	Returns a hash code value for this object.
static Metadata.MetaBuilder	metaBuilder(String path, Date timestamp)
QualifiedPath	path()	Returns the value of the path record component.
Date	timestamp()	Returns the value of the timestamp record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

Metadata

public Metadata(QualifiedPath path)

Metadata

public Metadata(QualifiedPath path,
 PropertySet data)

Metadata

public Metadata(QualifiedPath path,
 PropertySet data,
 Date timestamp)

Creates an instance of a Metadata record class.

Parameters:

path - the value for the path record component

data - the value for the data record component

timestamp - the value for the timestamp record component

Method Details

getPath

public QualifiedPath getPath()

getData

public PropertySet getData()

getTimestamp

public Date getTimestamp()

metaBuilder

public static Metadata.MetaBuilder metaBuilder(String path,
 Date timestamp)
                                        throws IOException

Throws:

IOException

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

path

public QualifiedPath path()

Returns the value of the path record component.

Returns:

the value of the path record component

data

public PropertySet data()

Returns the value of the data record component.

Returns:

the value of the data record component

timestamp

public Date timestamp()

Returns the value of the timestamp record component.

Returns:

the value of the timestamp record component